xl.pod.1: add a description of console options
authorStefano Stabellini <stefano.stabellini@eu.citrix.com>
Thu, 1 Dec 2011 16:26:30 +0000 (16:26 +0000)
committerStefano Stabellini <stefano.stabellini@eu.citrix.com>
Thu, 1 Dec 2011 16:26:30 +0000 (16:26 +0000)
Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com>
Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
docs/man/xl.pod.1

index 92593a68afccc873986123bb213ece66fe4235df..426b8e8a67357d0fb6124645e45f538d1f4fcd89 100644 (file)
@@ -105,7 +105,7 @@ soon as it is run.
 
 =back
 
-=item B<console> I<domain-id>
+=item B<console> [I<OPTIONS>] I<domain-id>
 
 Attach to domain I<domain-id>'s console.  If you've set up your domains to
 have a traditional log in console this will look much like a normal
@@ -113,6 +113,23 @@ text log in screen.
 
 Use the key combination Ctrl+] to detach the domain console.
 
+B<OPTIONS>
+
+=over 4
+
+=item I<-t [pv|serial]>
+
+Connect to a PV console or connect to an emulated serial console.
+PV consoles are the only consoles available for PV domains while HVM
+domains can have both. If this option is not specified it defaults to
+emulated serial for HVM guests and PV console for PV guests.
+
+=item I<-n NUM>
+
+Connect to console number I<NUM>. Console numbers start from 0.
+
+=back
+
 =item B<vncviewer> [I<OPTIONS>] I<domain-id>
 
 Attach to domain's VNC server, forking a vncviewer process.