man pages: Add a standard EXIT STATUS section to most pages.

[libguestfs.git] / cat / virt-filesystems.pod

diff --git a/cat/virt-filesystems.pod b/cat/virt-filesystems.pod
index 12f0b63..ad28b02 100755 (executable)
--- a/cat/virt-filesystems.pod
+++ b/cat/virt-filesystems.pod
@@ -142,7 +142,8 @@ read L</NOTE ABOUT CSV FORMAT> below.
 
 =item B<--domain> guest
 
 
 =item B<--domain> guest
 

-Add all the disks from the named libvirt guest.
+Add all the disks from the named libvirt guest.  Domain UUIDs can be
+used instead of names.

 
 =item B<--echo-keys>
 
 
 =item B<--echo-keys>
 


@@ -153,7 +154,7 @@ you can specify this flag to see what you are typing.
 
 =item B<--extra>
 
 
 =item B<--extra>
 

-This causes filesystems that are not normally, mountable filesystems
+This causes filesystems that are not ordinary, mountable filesystems

 to be displayed.  This category includes swapspace, and filesystems
 that are empty or contain unknown data.
 
 to be displayed.  This category includes swapspace, and filesystems
 that are empty or contain unknown data.
 


@@ -188,8 +189,7 @@ auto-detection for C<another.img>.
 
 If you have untrusted raw-format guest disk images, you should use
 this option to specify the disk format.  This avoids a possible
 
 If you have untrusted raw-format guest disk images, you should use
 this option to specify the disk format.  This avoids a possible

-security problem with malicious guests (CVE-2010-3851).  See also
-L</add-drive-opts>.
+security problem with malicious guests (CVE-2010-3851).

 
 =item B<-h>
 
 
 =item B<-h>
 


@@ -284,6 +284,60 @@ Enable tracing of libguestfs API calls.
 
 =back
 
 
 =back
 

+=head1 COLUMNS
+
+Note that columns in the output are subject to reordering and change
+in future versions of this tool.
+
+=over 4
+
+=item B<Name>
+
+The filesystem, partition, block device or LVM name.
+
+For device and partition names these are displayed as canonical
+libguestfs names, so that for example C</dev/sda2> is the second
+partition on the first device.
+
+If the I<--long> option is B<not> specified, then only the name column
+is shown in the output.
+
+=item B<Type>
+
+The object type, for example C<filesystem>, C<lv>, C<device> etc.
+
+=item B<VFS>
+
+If there is a filesystem, then this column displays the filesystem
+type if one could be detected, eg. C<ext4>.
+
+=item B<Label>
+
+If the object has a label (used for identifying and mounting
+filesystems) then this column contains the label.
+
+=item B<Size>
+
+The size of the object in bytes.  If the I<--human> option is used
+then the size is displayed in a human-readable form.
+
+=item B<Parent>
+
+The parent column records the parent relationship between objects.
+For example, if the object is a partition, then this column contains
+the name of the containing device.  If the object is a logical volume,
+then this column is the name of the volume group.
+
+=item B<UUID>
+
+If the object has a UUID (used for identifying and mounting
+filesystems and block devices) then this column contains the UUID as a
+string.
+
+The UUID is only displayed if the I<--uuid> option is given.
+
+=back
+

 =head1 NOTE ABOUT CSV FORMAT
 
 Comma-separated values (CSV) is a deceptive format.  It I<seems> like
 =head1 NOTE ABOUT CSV FORMAT
 
 Comma-separated values (CSV) is a deceptive format.  It I<seems> like


@@ -315,6 +369,11 @@ have meaning to the shell such as C<#> and space.  You may need to
 quote or escape these characters on the command line.  See the shell
 manual page L<sh(1)> for details.
 
 quote or escape these characters on the command line.  See the shell
 manual page L<sh(1)> for details.
 

+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+

 =head1 SEE ALSO
 
 L<guestfs(3)>,
 =head1 SEE ALSO
 
 L<guestfs(3)>,