From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:35437) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YdHSn-0003yu-FK for qemu-devel@nongnu.org; Wed, 01 Apr 2015 08:09:44 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YdHSh-0000v5-Kb for qemu-devel@nongnu.org; Wed, 01 Apr 2015 08:09:41 -0400 Received: from mx1.redhat.com ([209.132.183.28]:50339) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YdHSh-0000uZ-GS for qemu-devel@nongnu.org; Wed, 01 Apr 2015 08:09:35 -0400 Received: from int-mx11.intmail.prod.int.phx2.redhat.com (int-mx11.intmail.prod.int.phx2.redhat.com [10.5.11.24]) by mx1.redhat.com (Postfix) with ESMTPS id 43F968E3C7 for ; Wed, 1 Apr 2015 12:09:35 +0000 (UTC) From: Max Reitz Date: Wed, 1 Apr 2015 14:09:17 +0200 Message-Id: <1427890157-18639-6-git-send-email-mreitz@redhat.com> In-Reply-To: <1427890157-18639-1-git-send-email-mreitz@redhat.com> References: <1427890157-18639-1-git-send-email-mreitz@redhat.com> Subject: [Qemu-devel] [PATCH for-2.4 5/5] Documentation: Document IRC char driver List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: Kevin Wolf , Paolo Bonzini , Markus Armbruster , Max Reitz With the IRC char driver being fully functional, it now needs to be exposed to the broad audience. Adding documentation has been proven a valuable step in this process. Regarding the next steps, mouth-to-mouth propaganda will probably suffice, considering that IRC is objectively the single best character device qemu has to offer. Signed-off-by: Max Reitz --- qemu-options.hx | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/qemu-options.hx b/qemu-options.hx index 319d971..e6e0cb2 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -2799,6 +2799,34 @@ or fake device. @item msmouse Three button serial mouse. Configure the guest to use Microsoft protocol. + +@item irc[,host=@var{hostname}[,port=@var{port}]][,sockfd=@var{socket_fd}],nick=@var{nick},channel=@var{channel}[,ssl=@var{ssl}][,encryption=@var{cipher}] +Connects to the specified @var{hostname} on the given @var{port} (defaults to +6667), using the given @var{nick}. Alternatively, a socket file descriptor may +be specified as @var{socket_fd}. Once connected, the channel @var{channel} is +joined. A nick may be specify instead of a channel, in which case all +communication is done through a query. + +TLS is enabled or disabled through the @var{ssl} option. It is disabled by +default. + +All messages are encrypted and decrypted with the selected @var{cipher}. Valid +options are: +@table @option +@item none +No encryption +@item weak +ROT13 +@item strong +Triple ROT13 +@end table + +Messages to QEMU must be prefixed with @var{nick} if communicating through a +channel; when queried, no prefix must be used. This prefix has to be encrypted +if encryption is used. + +All output is emitted to @var{channel}. There is no limitation for input +sources, so anyone may query the QEMU instance and submit data. @end table ETEXI -- 2.3.4