From 06b518ff4c3e74d9025a5a7b19c90527e5697a0e Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Thu, 1 Jan 1970 00:00:00 +0000 Subject: [PATCH] Updated man pages --- virt-mem.1 | 23 ++++++++++++++++------- virt-mem.pod | 20 +++++++++++++++++--- virt-mem.txt | 19 ++++++++++++++++--- 3 files changed, 49 insertions(+), 13 deletions(-) diff --git a/virt-mem.1 b/virt-mem.1 index 6ae22bd..eb35098 100644 --- 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" +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 @@ -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" -\&\fIuname\fR\|(1),\fIdmesg\fR\|(1), +\&\fIuname\fR\|(1), +\&\fIdmesg\fR\|(1), \&\fIvirsh\fR\|(1), \&\fIxm\fR\|(1), , @@ -296,9 +309,7 @@ have fixed it. .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. @@ -306,9 +317,7 @@ submit with your bug report. .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 and enter a new bug. diff --git a/virt-mem.pod b/virt-mem.pod index 1c81e29..eeb027b 100644 --- a/virt-mem.pod +++ b/virt-mem.pod @@ -20,6 +20,19 @@ variety of different virtualization systems. =head1 COMMON OPTIONS +Each command obeys a common set of options. The general form is: + +virt-I [-options] [domains...] + +where I is a list of guest names to act on. If no domains +are specified then we act on all active domains by default. + +A I may be specified either by its name or by its ID. Use +I to get a list of active domain names and IDs. + +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. + =over 4 =item B<-c uri>, B<--connect uri> @@ -134,7 +147,8 @@ example guests which set up malicious kernel memory. =head1 SEE ALSO -L,L, +L, +L, L, L, L, @@ -184,7 +198,7 @@ have fixed it. Run - virt-[program] --debug > virt-mem.log 2>&1 +virt-I --debug > virt-mem.log 2>&1 and keep I. It contains error messages which you should submit with your bug report. @@ -193,7 +207,7 @@ submit with your bug report. Run - virt-[program] --version +virt-I --version =item 4. Submit a bug report. diff --git a/virt-mem.txt b/virt-mem.txt index 119ede4..bac5e16 100644 --- a/virt-mem.txt +++ b/virt-mem.txt @@ -16,6 +16,19 @@ DESCRIPTION variety of different virtualization systems. COMMON OPTIONS + Each command obeys a common set of options. The general form is: + + virt-*program* [-options] [domains...] + + where *domains* is a list of guest names to act on. If no domains are + specified then we act on all active domains by default. + + A *domain* may be specified either by its name or by its ID. Use *virsh + list* to get a list of active domain names and IDs. + + 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. + -c uri, --connect uri Connect to libvirt URI. The default is to connect to the default libvirt URI, normally Xen. @@ -113,7 +126,7 @@ SECURITY example guests which set up malicious kernel memory. SEE ALSO - uname(1),dmesg(1), virsh(1), xm(1), , + uname(1), dmesg(1), virsh(1), xm(1), , , , @@ -151,7 +164,7 @@ REPORTING BUGS 2. Capture debug and error messages Run - virt-[program] --debug > virt-mem.log 2>&1 + virt-*program* --debug > virt-mem.log 2>&1 and keep *virt-mem.log*. It contains error messages which you should submit with your bug report. @@ -159,7 +172,7 @@ REPORTING BUGS 3. Get version of virt-mem and version of libvirt. Run - virt-[program] --version + virt-*program* --version 4. Submit a bug report. Go to and enter a new bug. Please -- 1.8.3.1