[Qemu-devel] [PATCH for-2.4 5/5] Documentation: Document IRC char driver

[Max Reitz <mreitz@redhat.com>]

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 <mreitz@redhat.com>
---
 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