From f0f3e1621180724e0a907a30ff5dea9695ddead0 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Sat, 27 Aug 2011 17:47:10 +0100 Subject: [PATCH] man pages: Add a standard EXIT STATUS section to most pages. --- cat/virt-cat.pod | 5 +++++ cat/virt-filesystems.pod | 5 +++++ cat/virt-ls.pod | 5 +++++ df/virt-df.pod | 5 +++++ edit/virt-edit.pod | 5 +++++ fish/guestfish.pod | 2 +- fuse/guestmount.pod | 5 +++++ inspector/virt-inspector.pod | 5 +++++ resize/virt-resize.pod | 5 +++++ test-tool/libguestfs-test-tool.pod | 2 +- 10 files changed, 42 insertions(+), 2 deletions(-) diff --git a/cat/virt-cat.pod b/cat/virt-cat.pod index af8b8f4..4002188 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 for details. +=head1 EXIT STATUS + +This program returns 0 if successful, or non-zero if there was an +error. + =head1 SEE ALSO L, diff --git a/cat/virt-filesystems.pod b/cat/virt-filesystems.pod index 3ba925f..ad28b02 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 for details. +=head1 EXIT STATUS + +This program returns 0 if successful, or non-zero if there was an +error. + =head1 SEE ALSO L, diff --git a/cat/virt-ls.pod b/cat/virt-ls.pod index e63f009..645a9c0 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 for details. +=head1 EXIT STATUS + +This program returns 0 if successful, or non-zero if there was an +error. + =head1 SEE ALSO L, diff --git a/df/virt-df.pod b/df/virt-df.pod index 9d05ac9..49c5e0a 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 for details. +=head1 EXIT STATUS + +This program returns 0 if successful, or non-zero if there was an +error. + =head1 SEE ALSO L, diff --git a/edit/virt-edit.pod b/edit/virt-edit.pod index ce7ed1d..99dd3f3 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 for details. +=head1 EXIT STATUS + +This program returns 0 if successful, or non-zero if there was an +error. + =head1 SEE ALSO L, diff --git a/fish/guestfish.pod b/fish/guestfish.pod index 5b641ea..254daad 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 fe759fb..fef84d9 100644 --- a/fuse/guestmount.pod +++ b/fuse/guestmount.pod @@ -300,6 +300,11 @@ See L. =back +=head1 EXIT STATUS + +This program returns 0 if successful, or non-zero if there was an +error. + =head1 SEE ALSO L, diff --git a/inspector/virt-inspector.pod b/inspector/virt-inspector.pod index 4d916a1..5496827 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, diff --git a/resize/virt-resize.pod b/resize/virt-resize.pod index d03906c..17a5953 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 for details. +=head1 EXIT STATUS + +This program returns 0 if successful, or non-zero if there was an +error. + =head1 SEE ALSO L, diff --git a/test-tool/libguestfs-test-tool.pod b/test-tool/libguestfs-test-tool.pod index 77bd817..9d8ab4b 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 in L). 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. -- 1.8.3.1