Re: [libvirt] [PATCH] virsh: document options in man page

2010-10-13 Thread Daniel Veillard
On Tue, Oct 12, 2010 at 02:50:56PM -0600, Eric Blake wrote:
 * tools/virsh.pod: Document top-level options.
 ---
 
  And I'm posting a followup patch that documents virsh's options, like -c.
 
 Can't believe we didn't have this in the man page!
 
  tools/virsh.pod |   45 -
  1 files changed, 44 insertions(+), 1 deletions(-)
 
 diff --git a/tools/virsh.pod b/tools/virsh.pod
 index 209aa54..f65f6d4 100644
 --- a/tools/virsh.pod
 +++ b/tools/virsh.pod
 @@ -24,7 +24,7 @@ KVM, LXC, OpenVZ, VirtualBox, OpenNebula, and VMware ESX.
 
  The basic structure of most virsh usage is:
 
 -  virsh command domain-id [ARG]...
 +  virsh [OPTION]... command domain-id [ARG]...

  Argh ! ACK :-)

Daniel

-- 
Daniel Veillard  | libxml Gnome XML XSLT toolkit  http://xmlsoft.org/
dan...@veillard.com  | Rpmfind RPM search engine http://rpmfind.net/
http://veillard.com/ | virtualization library  http://libvirt.org/

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list


[libvirt] [PATCH] virsh: document options in man page

2010-10-12 Thread Eric Blake
* tools/virsh.pod: Document top-level options.
---

 And I'm posting a followup patch that documents virsh's options, like -c.

Can't believe we didn't have this in the man page!

 tools/virsh.pod |   45 -
 1 files changed, 44 insertions(+), 1 deletions(-)

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 209aa54..f65f6d4 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -24,7 +24,7 @@ KVM, LXC, OpenVZ, VirtualBox, OpenNebula, and VMware ESX.

 The basic structure of most virsh usage is:

-  virsh command domain-id [ARG]...
+  virsh [OPTION]... command domain-id [ARG]...

 Where Icommand is one of the commands listed below, Idomain-id
 is the numeric domain id, or the domain name (which will be internally
@@ -45,6 +45,49 @@ If no command is given in the command line, Bvirsh will 
then start a minimal
 interpreter waiting for your commands, and the Bquit command will then exit
 the program.

+The Bvirsh program understands the following IOPTIONS.
+
+=over 4
+
+=item B-h, B--help
+
+Ignore all other arguments, and behave as if the Bhelp command were
+given instead.
+
+=item B-v, B--version
+
+Ignore all other arguments, and behave as if the Bversion command were
+given instead.
+
+=item B-c, B--connect IURI
+
+Connect to the specified IURI, as if by the Bconnect command,
+instead of the default connection.
+
+=item B-d, B--debug ILEVEL
+
+Enable debug messages at integer ILEVEL and above.  ILEVEL can
+range from 0 (default) to 5.
+
+=item B-l, B--log IFILE
+
+Output logging details to IFILE.
+
+=item B-q, B--quiet
+
+Avoid extra informational messages.
+
+=item B-r, B--readonly
+
+Make the initial connection read-only, as if by the I--readonly
+option of the Bconnect command.
+
+=item B-t, B--timing
+
+Output elapsed time information for each command.
+
+=back
+
 =head1 NOTES

 Most Bvirsh operations rely upon the libvirt library being able to
-- 
1.7.2.3

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list