Update generated man pages.
[virt-top.git] / virt-top / virt-top.txt
index 052b51a..da737b8 100644 (file)
@@ -31,6 +31,14 @@ OPTIONS
         Connect to URI given. The default is to connect to the Xen
         hypervisor.
 
+        To connect to QEMU/KVM you would normally do *-c qemu:///system*
+
+        To connect to libvirtd on a remote machine you would normally do *-c
+        xen://host/*
+
+        Full details on connection URIs is available at
+        <http://libvirt.org/uri.html>
+
     -d delay
         Set the delay between screen updates in seconds. The default is 3.0
         seconds. You can change this while virt-top is running by pressing
@@ -42,7 +50,7 @@ OPTIONS
 
     -o sort
         Set the sort order to one of: cpu (sort by %CPU used), mem (sort by
-        memory used), time (sort by total time), id (sort by domain ID),
+        total memory), time (sort by total time), id (sort by domain ID),
         name (sort by domain name), netrx (sort by network received bytes),
         nettx (sort by network transmitted bytes), blockrdrq (sort by block
         device [disk] read requests), blockwrrq (sort by block device [disk]
@@ -116,33 +124,36 @@ OPTIONS
 
         The time may be given in one of the following formats:
 
-    *YYYY-MM-DD HH:MM:SS*
-        End time is the date and time given.
+        *YYYY-MM-DD HH:MM:SS*
+            End time is the date and time given.
 
-    *HH:MM:SS*
-        End time is the time given, today.
+        *HH:MM:SS*
+            End time is the time given, today.
 
-    *+HH:MM:SS*
-        End time is HH hours, MM minutes, SS seconds in the future (counted
-        from the moment that program starts).
+        *+HH:MM:SS*
+            End time is HH hours, MM minutes, SS seconds in the future
+            (counted from the moment that program starts).
 
-    *+secs*
-        End time is *secs* seconds in the future.
+        *+secs*
+            End time is *secs* seconds in the future.
 
-    For example to run the program for 3 minutes you could do:
+        For example to run the program for 3 minutes you could do:
 
-     virt-top --end-time +00:03:00
+         virt-top --end-time +00:03:00
 
-    or:
+        or:
 
-     virt-top --end-time +180
+         virt-top --end-time +180
 
-    Not every version of virt-top supports this option - it depends how the
-    program was compiled (see *README* file in the source distribution for
-    details).
+        Not every version of virt-top supports this option - it depends how
+        the program was compiled (see *README* file in the source
+        distribution for details).
 
     --help
-    Display usage summary.
+        Display usage summary.
+
+    --version
+        Display version number and exit.
 
 KEYS
     Note that keys are case sensitive. For example use upper-case *P* (shift
@@ -174,7 +185,8 @@ KEYS
 
     *P* Sort by %CPU.
 
-    *M* Sort by memory.
+    *M* Sort by total memory. Note that this shows the total memory
+        allocated to the guest, not the memory being used.
 
     *T* Sort by total time.
 
@@ -258,14 +270,16 @@ INIT FILE
     this behaviour may change in the future.
 
 SEE ALSO
-    top(1), virsh(1), xm(1), xentop(1), <http://www.libvirt.org/>,
-    <http://et.redhat.com/~rjones/>, <http://caml.inria.fr/>
+    top(1), virsh(1), <http://www.libvirt.org/ocaml/>,
+    <http://www.libvirt.org/>, <http://people.redhat.com/~rjones/>,
+    <http://caml.inria.fr/>
 
 AUTHORS
     Richard W.M. Jones <rjones @ redhat . com>
 
 COPYRIGHT
-    (C) Copyright 2007 Red Hat Inc., Richard W.M. Jones http://libvirt.org/
+    (C) Copyright 2007-2011 Red Hat Inc., Richard W.M. Jones
+    http://libvirt.org/
 
     This program is free software; you can redistribute it and/or modify it
     under the terms of the GNU General Public License as published by the
@@ -301,9 +315,12 @@ REPORTING BUGS
         submit with your bug report.
 
     3. Get version of virt-top and version of libvirt.
-        In virt-top, press the *h* (help) key, and write down the version of
-        virt-top and the version of libvirt. They are shown in the first
-        line.
+        Use:
+
+         virt-top --version
+
+        If you can get the precise version of libvirt you are using then
+        that too is helpful.
 
     4. Submit a bug report.
         Go to <https://bugzilla.redhat.com/> and enter a new bug. Please