implement failure-dependent exit statuses, ask to proceed if a failure is encountered during the process

7 files changed, 131 insertions, 1 deletions

diff --git a/man1/sboclean.1 b/man1/sboclean.1
index a16ca92..6e9e38e 100644
--- a/man1/sboclean.1
+++ b/man1/sboclean.1
@@ -33,6 +33,17 @@ Clean working directories, located under /tmp/SBo.
 -i|--interactive
 .RS
 Be interactive; sboclean will ask for confirmation for each item which it thinks should be removed.
+.SH EXIT CODES
+.P
+sboclean can exit with the following codes:
+.RS
+
+0: all operations completed successfully.
+.RE
+.RS
+1: a usage error occurred, such as running sboclean with nothing to clean.
+.RE
+
 .SH BUGS
 .P
 None known, but there may be some. Please report any found to j@dawnrazor.net or xocel@iquidus.org; patches are always welcome.
diff --git a/man1/sboconfig.1 b/man1/sboconfig.1
index 5bca292..3c5792b 100644
--- a/man1/sboconfig.1
+++ b/man1/sboconfig.1
@@ -29,7 +29,6 @@ List out current configuration options, including unmodified default configurati
 .RS
 NOCLEAN: If TRUE, then DO NOT clean working directories after building the slackbuild. These are the directories where the source is unpacked and compiled, and where the package is put together in, which are under /tmp/SBo. By default, these directories are removed after building an slackbuild. Setting this option to TRUE causes the working directories to not be cleaned by default. This can be overridden when running sboupgrade(1)/sboinstall(1).
 .RE
-
 .P
 -d|--distclean (FALSE|TRUE)
 .RS
@@ -50,6 +49,19 @@ PKG_DIR: If set to a path, packages will be stored at the given location after b
 .RS
 SBO_HOME: If set to a path, this is where the slackbuilds.org tree will live; by default, /usr/sbo will be used. If the tree should live elsewhere, this option can be set to the path where the tree should live. Note that if you set this option after fetching the tree to a different location (such as the default), you will need to fetch the tree again.
 .RE
+.SH EXIT CODES
+.P
+sboconfig can exit with the following codes:
+.RS
+
+0: all operations were succesful.
+.RE
+.RS
+1: a usage error occurred, such as trying to specify invalid options.
+.RE
+.RS
+6: sboconfig was unable to obtain a required file handle.
+.RE
 .SH BUGS
 .P
 None known, but there may be some. Please report any found to j@dawnrazor.net or xocel@iquidus.org; patches are always welcome.
diff --git a/man1/sbofind.1 b/man1/sbofind.1
index 60148c8..0ad3e25 100644
--- a/man1/sbofind.1
+++ b/man1/sbofind.1
@@ -29,6 +29,19 @@ Show the contents of the .info file for each slackbuild found.
 .RS
 Show the contents of the README file for each slackbuild found.
 .RE
+.SH EXIT CODES
+.P
+sbofind can exit with the following exit codes:
+.RS
+
+0: all operations were succesful.
+.RE
+.RS
+1: a usage error occured, ie sbofind was ran with nothing to find.
+.RE
+.RS
+6: sbofind was unable to obtain a required file handle.
+.RE
 .SH BUGS
 .P
 None known, but there may be some. Please report any found to j@dawnrazor.net or xocel@iquidus.org; patches are always welcome.
diff --git a/man1/sboinstall.1 b/man1/sboinstall.1
index 819f9bc..e4969d0 100644
--- a/man1/sboinstall.1
+++ b/man1/sboinstall.1
@@ -54,6 +54,43 @@ Skip viewing of the README and the yes or no question which accompanies it. Anyt
 .RS
 This option causes sboinstall to skip requirement handling, but still show the README and prompt the user to proceed.
 .RE
+.SH EXIT CODES
+.P
+sboinstall can exit with the following exit codes:
+.RS
+
+0: all operations were succesful.
+.RE
+.RS
+1: a usage error occured, such as specifying invalid options.
+.RE
+.RS
+3: a .SlackBuild exited non-zero.
+.RE
+.RS
+4: unable to md5sum verify an SBo's source file(s).
+.RE
+.RS
+5: unable to download an SBo's source file(s).
+.RE
+.RS
+6: unable to obtain a required file handle.
+.RE
+.RS
+7: unable to get required info from the SBo's .info file.
+.RE
+.RS
+8: unable to unset the exec-on-close bit on a temporary file.
+.RE
+.RS
+9: multilib hasn't been setup (where required).
+.RE
+.RS
+10: convertpkg-compat32 exited non-zero.
+.RE
+.RS
+11: the convertpkg-compat32 script can't be found (where required).
+.RE
 .SH BUGS
 .P
 None known, but there may be some. Please report any found to j@dawnrazor.net or xocel@iquidus.org; patches are always welcome.
diff --git a/man1/sboremove.1 b/man1/sboremove.1
index 9b5779a..4dc81b9 100644
--- a/man1/sboremove.1
+++ b/man1/sboremove.1
@@ -24,6 +24,16 @@ Show version information.
 .RS
 Always ask to remove requirements, even those required by other packages currently installed (ignored by default)
 .RE
+.SH EXIT CODES
+.P
+sboremove can exit with the following codes:
+.RS
+
+0: all operations completed successfully.
+.RE
+.RS
+1: a usage error occurred, such as running sboremove with nothing to remove.
+.RE
 .SH BUGS
 .P
 None known, but there may be some. Please report any found to xocel@iquidus.org or j@dawnrazor.net; patches are always welcome.
diff --git a/man1/sbosnap.1 b/man1/sbosnap.1
index 0f6fef9..5ddc698 100644
--- a/man1/sbosnap.1
+++ b/man1/sbosnap.1
@@ -30,6 +30,16 @@ update
 .RS
 Update a previously fetch'd copy of the slackbuilds.org tree.
 .RE
+.SH EXIT CODES
+.P
+sbosnap can exit with the following codes:
+.RS
+
+0: all operations completed successfully.
+.RE
+.RS
+1: a usage error occurred, such as running sbosnap with no command.
+.RE
 .SH BUGS
 .P
 None known, but there may be some. Please report any found to j@dawnrazor.net or xocel@iquidus.org; patches are always welcome.
diff --git a/man1/sboupgrade.1 b/man1/sboupgrade.1
index 4dfeeb0..7a6f4cc 100644
--- a/man1/sboupgrade.1
+++ b/man1/sboupgrade.1
@@ -54,6 +54,43 @@ Skip viewing of the README and the yes or no question which accompanies it. Anyt
 .RS
 When used in combination with the -f option, to force an update even if it would not constitute an update, this will cause sboupgrade to also rebuild all of that slackbuild's requirements. Normally with -f, only the slackbuild(s) specified, and any requirements not already installed, will be rebuilt. This allows for recursive upgrades, among other things.
 .RE
+.SH EXIT CODES
+.P
+sboinstall can exit with the following exit codes:
+.RS
+
+0: all operations were succesful.
+.RE
+.RS
+1: a usage error occured, such as specifying invalid options.
+.RE
+.RS
+3: a .SlackBuild exited non-zero.
+.RE
+.RS
+4: unable to md5sum verify an SBo's source file(s).
+.RE
+.RS
+5: unable to download an SBo's source file(s).
+.RE
+.RS
+6: unable to obtain a required file handle.
+.RE
+.RS
+7: unable to get required info from the SBo's .info file.
+.RE
+.RS
+8: unable to unset the exec-on-close bit on a temporary file.
+.RE
+.RS
+9: multilib hasn't been setup (where required).
+.RE
+.RS
+10: convertpkg-compat32 exited non-zero.
+.RE
+.RS
+11: the convertpkg-compat32 script can't be found (where required).
+.RE
 .SH BUGS
 .P
 None known, but there may be some. Please report any found to j@dawnrazor.net or xocel@iquidus.org; patches are always welcome.