telnet protocol and more consistent syntax (Jason Wessel)

git-svn-id: svn://svn.savannah.nongnu.org/qemu/trunk@2030 c046a42c-6fe2-441c-8c8c-71466251a162

1 files changed, 41 insertions, 24 deletions

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 02bfc21..ed58501 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -525,43 +525,60 @@ Write output to filename. No character can be read.
 name pipe @var{filename}
 @item COMn
 [Windows only] Use host serial port @var{n}
-@item udp:remote_port
-UDP Net Console sent to locahost at remote_port
-@item udp:remote_host:remote_port
-UDP Net Console sent to remote_host at remote_port
-@item udp:src_port:remote_host:remote_port
-UDP Net Console sent from src_port to remote_host at the remote_port.
-
-The udp:* sub options are primary intended for netconsole.  If you
-just want a simple readonly console you can use @code{netcat} or
-@code{nc}, by starting qemu with: @code{-serial udp:4555} and nc as:
-@code{nc -u -l -p 4555}. Any time qemu writes something to that port
-it will appear in the netconsole session.
+@item udp:[remote_host]:remote_port[@@[src_ip]:src_port]
+This implements UDP Net Console.  When @var{remote_host} or @var{src_ip} are not specified they default to @code{0.0.0.0}.  When not using a specifed @var{src_port} a random port is automatically chosen.
+
+If you just want a simple readonly console you can use @code{netcat} or
+@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
+@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
+will appear in the netconsole session.
 
 If you plan to send characters back via netconsole or you want to stop
 and start qemu a lot of times, you should have qemu use the same
 source port each time by using something like @code{-serial
-udp:4556:localhost:4555} to qemu. Another approach is to use a patched
+udp::4555@@:4556} to qemu. Another approach is to use a patched
 version of netcat which can listen to a TCP port and send and receive
 characters via udp.  If you have a patched version of netcat which
 activates telnet remote echo and single char transfer, then you can
 use the following options to step up a netcat redirector to allow
 telnet on port 5555 to access the qemu port.
 @table @code
-@item Qemu Options
--serial udp:4556:localhost:4555
-@item netcat options
--u -P 4555 -L localhost:4556  -t -p 5555 -I -T
+@item Qemu Options:
+-serial udp::4555@@:4556
+@item netcat options:
+-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
+@item telnet options:
+localhost 5555
+@end table
+
+
+@item tcp:[host]:port[,server][,nowait]
+The TCP Net Console has two modes of operation.  It can send the serial
+I/O to a location or wait for a connection from a location.  By default
+the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
+the @var{,server} option QEMU will wait for a client socket application
+to connect to the port before continuing, unless the @code{,nowait}
+option was specified. If @var{host} is omitted, 0.0.0.0 is assumed. Only
+one TCP connection at a time is accepted. You can use @code{telnet} to
+connect to the corresponding character device.
+@table @code
+@item Example to send tcp console to 192.168.0.2 port 4444
+-serial tcp:192.168.0.2:4444
+@item Example to listen and wait on port 4444 for connection
+-serial tcp::4444,server
+@item Example to not wait and listen on ip 192.168.0.100 port 4444
+-serial tcp:192.168.0.100:4444,server,nowait
 @end table
 
+@item telnet:host:port[,server][,nowait]
+The telnet protocol is used instead of raw tcp sockets.  The options
+work the same as if you had specified @code{-serial tcp}.  The
+difference is that the port acts like a telnet server or client using
+telnet option negotiation.  This will also allow you to send the
+MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
+sequence.  Typically in unix telnet you do it with Control-] and then
+type "send break" followed by pressing the enter key.
 
-@item tcp:remote_host:remote_port
-TCP Net Console sent to remote_host at the remote_port
-@item tcpl:host:port
-TCP Net Console: wait for connection on @var{host} on the local port
-@var{port}. If host is omitted, 0.0.0.0 is assumed. Only one TCP
-connection at a time is accepted. You can use @code{telnet} to connect
-to the corresponding character device.
 @end table
 
 @item -parallel dev