Updated man pages
[virt-mem.git] / virt-mem.pod
index 1c81e29..eeb027b 100644 (file)
@@ -20,6 +20,19 @@ variety of different virtualization systems.
 
 =head1 COMMON OPTIONS
 
 
 =head1 COMMON OPTIONS
 
+Each command obeys a common set of options.  The general form is:
+
+virt-I<program> [-options] [domains...]
+
+where I<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 I<domain> may be specified either by its name or by its ID.  Use
+I<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.
+
 =over 4
 
 =item B<-c uri>, B<--connect uri>
 =over 4
 
 =item B<-c uri>, B<--connect uri>
@@ -134,7 +147,8 @@ example guests which set up malicious kernel memory.
 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 
-L<uname(1)>,L<dmesg(1)>,
+L<uname(1)>,
+L<dmesg(1)>,
 L<virsh(1)>,
 L<xm(1)>,
 L<http://www.libvirt.org/ocaml/>,
 L<virsh(1)>,
 L<xm(1)>,
 L<http://www.libvirt.org/ocaml/>,
@@ -184,7 +198,7 @@ have fixed it.
 
 Run
 
 
 Run
 
- virt-[program] --debug > virt-mem.log 2>&1
+virt-I<program> --debug > virt-mem.log 2>&1
 
 and keep I<virt-mem.log>.  It contains error messages which you should
 submit with your bug report.
 
 and keep I<virt-mem.log>.  It contains error messages which you should
 submit with your bug report.
@@ -193,7 +207,7 @@ submit with your bug report.
 
 Run
 
 
 Run
 
- virt-[program] --version
+virt-I<program> --version
 
 =item 4. Submit a bug report.
 
 
 =item 4. Submit a bug report.