Updated man pages

[virt-mem.git] / virt-mem.1

diff --git a/virt-mem.1 b/virt-mem.1
index 6ae22bd..eb35098 100644 (file)
--- a/virt-mem.1
+++ b/virt-mem.1
@@ -148,6 +148,18 @@ The tools all use libvirt so are capable of showing stats across a
 variety of different virtualization systems.
 .SH "COMMON OPTIONS"
 .IX Header "COMMON OPTIONS"
 variety of different virtualization systems.
 .SH "COMMON OPTIONS"
 .IX Header "COMMON OPTIONS"

+Each command obeys a common set of options.  The general form is:
+.PP
+virt\-\fIprogram\fR [\-options] [domains...]
+.PP
+where \fIdomains\fR is a list of guest names to act on.  If no domains
+are specified then we act on all active domains by default.
+.PP
+A \fIdomain\fR may be specified either by its name or by its \s-1ID\s0.  Use
+\&\fIvirsh list\fR to get a list of active domain names and IDs.
+.PP
+The virt-mem tools do not work on domains which are not active
+(running or paused).  eg. They do not work on shut down domains.

 .IP "\fB\-c uri\fR, \fB\-\-connect uri\fR" 4
 .IX Item "-c uri, --connect uri"
 Connect to libvirt \s-1URI\s0.  The default is to connect to the default
 .IP "\fB\-c uri\fR, \fB\-\-connect uri\fR" 4
 .IX Item "-c uri, --connect uri"
 Connect to libvirt \s-1URI\s0.  The default is to connect to the default


@@ -253,7 +265,8 @@ The current code tries hard to be secure against malicious guests, for
 example guests which set up malicious kernel memory.
 .SH "SEE ALSO"
 .IX Header "SEE ALSO"
 example guests which set up malicious kernel memory.
 .SH "SEE ALSO"
 .IX Header "SEE ALSO"

-\&\fIuname\fR\|(1),\fIdmesg\fR\|(1),
+\&\fIuname\fR\|(1),
+\&\fIdmesg\fR\|(1),

 \&\fIvirsh\fR\|(1),
 \&\fIxm\fR\|(1),
 <http://www.libvirt.org/ocaml/>,
 \&\fIvirsh\fR\|(1),
 \&\fIxm\fR\|(1),
 <http://www.libvirt.org/ocaml/>,


@@ -296,9 +309,7 @@ have fixed it.
 .IX Item "2. Capture debug and error messages"
 Run
 .Sp
 .IX Item "2. Capture debug and error messages"
 Run
 .Sp

-.Vb 1
-\& virt-[program] --debug > virt-mem.log 2>&1
-.Ve
+virt\-\fIprogram\fR \-\-debug > virt\-mem.log 2>&1

 .Sp
 and keep \fIvirt\-mem.log\fR.  It contains error messages which you should
 submit with your bug report.
 .Sp
 and keep \fIvirt\-mem.log\fR.  It contains error messages which you should
 submit with your bug report.


@@ -306,9 +317,7 @@ submit with your bug report.
 .IX Item "3. Get version of virt-mem and version of libvirt."
 Run
 .Sp
 .IX Item "3. Get version of virt-mem and version of libvirt."
 Run
 .Sp

-.Vb 1
-\& virt-[program] --version
-.Ve
+virt\-\fIprogram\fR \-\-version

 .IP "4. Submit a bug report." 4
 .IX Item "4. Submit a bug report."
 Go to <https://bugzilla.redhat.com/> and enter a new bug.
 .IP "4. Submit a bug report." 4
 .IX Item "4. Submit a bug report."
 Go to <https://bugzilla.redhat.com/> and enter a new bug.