summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2011-08-27 17:47:10 +0100
committerRichard W.M. Jones <rjones@redhat.com>2011-08-27 17:47:10 +0100
commitf0f3e1621180724e0a907a30ff5dea9695ddead0 (patch)
tree30bd3324d92f56abf286e501347ed8f4261c2aed
parent69abc787dddbf7855c2871f7f1432563a6af92a1 (diff)
downloadlibguestfs-f0f3e1621180724e0a907a30ff5dea9695ddead0.tar.gz
libguestfs-f0f3e1621180724e0a907a30ff5dea9695ddead0.tar.xz
libguestfs-f0f3e1621180724e0a907a30ff5dea9695ddead0.zip
man pages: Add a standard EXIT STATUS section to most pages.
-rwxr-xr-xcat/virt-cat.pod5
-rwxr-xr-xcat/virt-filesystems.pod5
-rwxr-xr-xcat/virt-ls.pod5
-rwxr-xr-xdf/virt-df.pod5
-rw-r--r--edit/virt-edit.pod5
-rw-r--r--fish/guestfish.pod2
-rw-r--r--fuse/guestmount.pod5
-rwxr-xr-xinspector/virt-inspector.pod5
-rw-r--r--resize/virt-resize.pod5
-rw-r--r--test-tool/libguestfs-test-tool.pod2
10 files changed, 42 insertions, 2 deletions
diff --git a/cat/virt-cat.pod b/cat/virt-cat.pod
index af8b8f48..40021880 100755
--- a/cat/virt-cat.pod
+++ b/cat/virt-cat.pod
@@ -196,6 +196,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.
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
=head1 SEE ALSO
L<guestfs(3)>,
diff --git a/cat/virt-filesystems.pod b/cat/virt-filesystems.pod
index 3ba925f7..ad28b02d 100755
--- a/cat/virt-filesystems.pod
+++ b/cat/virt-filesystems.pod
@@ -369,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.
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
=head1 SEE ALSO
L<guestfs(3)>,
diff --git a/cat/virt-ls.pod b/cat/virt-ls.pod
index e63f009d..645a9c06 100755
--- a/cat/virt-ls.pod
+++ b/cat/virt-ls.pod
@@ -487,6 +487,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.
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
=head1 SEE ALSO
L<guestfs(3)>,
diff --git a/df/virt-df.pod b/df/virt-df.pod
index 9d05ac97..49c5e0a9 100755
--- a/df/virt-df.pod
+++ b/df/virt-df.pod
@@ -219,6 +219,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.
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
=head1 SEE ALSO
L<df(1)>,
diff --git a/edit/virt-edit.pod b/edit/virt-edit.pod
index ce7ed1df..99dd3f37 100644
--- a/edit/virt-edit.pod
+++ b/edit/virt-edit.pod
@@ -346,6 +346,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.
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
=head1 SEE ALSO
L<guestfs(3)>,
diff --git a/fish/guestfish.pod b/fish/guestfish.pod
index 5b641ead..254daad6 100644
--- a/fish/guestfish.pod
+++ b/fish/guestfish.pod
@@ -1078,7 +1078,7 @@ This exits guestfish. You can also use C<^D> key.
@ACTIONS@
-=head1 EXIT CODE
+=head1 EXIT STATUS
guestfish returns 0 if the commands completed without error, or
1 if there was an error.
diff --git a/fuse/guestmount.pod b/fuse/guestmount.pod
index fe759fb6..fef84d96 100644
--- a/fuse/guestmount.pod
+++ b/fuse/guestmount.pod
@@ -300,6 +300,11 @@ See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
=back
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
=head1 SEE ALSO
L<guestfish(1)>,
diff --git a/inspector/virt-inspector.pod b/inspector/virt-inspector.pod
index 4d916a1b..54968279 100755
--- a/inspector/virt-inspector.pod
+++ b/inspector/virt-inspector.pod
@@ -369,6 +369,11 @@ versions of virt-inspector with different names:
virt-inspector Old Perl version.
virt-inspector2 New C version.
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
=head1 SEE ALSO
L<guestfs(3)>,
diff --git a/resize/virt-resize.pod b/resize/virt-resize.pod
index d03906c5..17a5953d 100644
--- a/resize/virt-resize.pod
+++ b/resize/virt-resize.pod
@@ -605,6 +605,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.
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
=head1 SEE ALSO
L<virt-filesystems(1)>,
diff --git a/test-tool/libguestfs-test-tool.pod b/test-tool/libguestfs-test-tool.pod
index 77bd817a..9d8ab4b7 100644
--- a/test-tool/libguestfs-test-tool.pod
+++ b/test-tool/libguestfs-test-tool.pod
@@ -74,7 +74,7 @@ to write a qemu wrapper script (see section I<QEMU WRAPPERS> in
L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper
script when you use either of the I<--qemudir> or I<--qemu> options.
-=head1 EXIT CODE
+=head1 EXIT STATUS
libguestfs-test-tool returns I<0> if the tests completed without
error, or I<1> if there was an error.