many fixes, cleanups, and consistency corrections in the man pages

7 files changed, 90 insertions, 80 deletions

diff --git a/man1/sbocheck.1 b/man1/sbocheck.1
index 7a66264..1467096 100644
--- a/man1/sbocheck.1
+++ b/man1/sbocheck.1
@@ -4,19 +4,24 @@
 sbocheck - update a local slackbuilds.org tree and check for updates.
 .SH SYNAPSES
 .P
-sbocheck [-v]
+sbocheck [-h|-v]
 .SH DESCRIPTION
 .P
 sbocheck first updates a previously fetched copy of the slackbuilds.org tree (see sbosnap(1)) and then checks to see if any packages installed from slackbuilds.org have updates, and reports what it finds.
 .SH OPTIONS
 .P
--v
+-h|--help
 .RS
-Show sbotools version information.
+Show help information.
+.RE
+.P
+-v|--version
+.RS
+Show version information.
 .RE
 .SH BUGS
 .P
-None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome. In the future sbotools may exist in a public git repository and this section may change to reflect that.
+None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome.
 .SH SEE ALSO
 .P
 sboclean(1), sboconfig(1), sbofind(1), sboinstall(1), sboupgrade(1), sbosnap(1), sbotools.conf(5)
diff --git a/man1/sboclean.1 b/man1/sboclean.1
index 4cc8299..bcbdc9c 100644
--- a/man1/sboclean.1
+++ b/man1/sboclean.1
@@ -4,38 +4,38 @@
 sboclean - clean files left around by sbotools.
 .SH SYNAPSES
 .P
-sboclean [-hvdwi]
+sboclean [-h|-v] [-dwi]
 .SH DESCRIPTION
 .P
 sboclean is used to clean files left around by sbotools, such as downloaded source files ("distfiles"), or work directories under /tmp/SBo. Note that if not run with the -i flag, sboclean will remove anything in the distfiles or /tmp/SBo folders with extreme prejudice. One of either -d or -w must be specified for this script to do anything.
 .SH OPTIONS
 .P
--h
+-h|--help
 .RS
 Show help information.
 .RE
 .P
--v
+-v|--version
 .RS
-Show sbotools version information.
+Show version information.
 .RE
 .P
--d
+-d|--clean-dist
 .RS
 Clean distfiles, by default located at /usr/sbo/distfiles.
 .RE
 .P
--w
+-w|--clean-work
 .RS
 Clean working directories, located under /tmp/SBo.
 .RE
 .P
--i
+-i|--interactive
 .RS
-Be interactive; sboclean will ask for confirmation for each item which it think should be removed.
+Be interactive; sboclean will ask for confirmation for each item which it thinks should be removed.
 .SH BUGS
 .P
-None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome. In the future sbotools may exist in a public git repository and this section may change to reflect that.
+None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome.
 .SH SEE ALSO
 .P
 sbocheck(1), sboconfig(1), sbofind(1), sboinstall(1), sboupgrade(1), sbosnap(1), sbotools.conf(5)
diff --git a/man1/sboconfig.1 b/man1/sboconfig.1
index 2089b49..6dc032a 100644
--- a/man1/sboconfig.1
+++ b/man1/sboconfig.1
@@ -4,54 +4,54 @@
 sboconfig - set sbotools configuration options.
 .SH SYNAPSES
 .P
-sboconfig [-h] [-l] [-d TRUE|FALSE] [-j #|FALSE] [-c TRUE|FALSE] [-p /path|FALSE] [-s /path|/usr/sbo] [-v]
+sboconfig [-h|-v] [-l] [-c TRUE|FALSE] [-d TRUE|FALSE] [-j #|FALSE] [-p /path|FALSE] [-s /path|/usr/sbo]
 .SH DESCRIPTION
 .P
-sboconfig is a front-end for managing sbotools configuration options. The sbotools.conf(5) file can also be manually edited; any fields not relevant to sbotools configuration will be ignored. Note that more options may be added in the future, so you should not add garbage to the sbotools.conf(5) file.
+sboconfig is a front-end for managing sbotools configuration options. The sbotools.conf(5) file can also be manually edited; any fields not relevant to sbotools configuration will be ignored.
 .SH OPTIONS
 .P
--h
+-h|--help
 .RS
 Show help information.
 .RE
 .P
--l
+-v|--version
 .RS
-List out current configuration options, including unmodified default configuration options (meaning that if a given option is not set in the sbotools.conf(5) file, the default will be shown for that option).
+Show version information.
 .RE
 .P
--d (TRUE|FALSE)
+-l|--list
 .RS
-DISTCLEAN: If TRUE, then DO remove the source code after building the slackbuild. By default, the source code is not removed, and lives under $SBO_HOME/distfiles, which, by default, is /usr/sbo/distfiles. Setting this option to TRUE causes the source code to be removed by default. This can be overridden when running sboupgrade(1)/sboinstall(1).
+List out current configuration options, including unmodified default configuration options (meaning that if a given option is not set in the sbotools.conf(5) file, the default will be shown for that option). Also shows the flag to sboconfig used to set each option.
 .RE
 .P
--j (#|FALSE)
+-c|--noclean (FALSE|TRUE)
 .RS
-JOBS: If numeric (2,5,10, etc), then that number will be fed to the "-j" argument to make when a slackbuild which invokes "make" is run. This only makes sense on multicore systems, where one might set the JOBS to the number of available cores, or half that number, etc.
+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
--c (TRUE|FALSE)
+-d|--distclean (FALSE|TRUE)
 .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).
+DISTCLEAN: If TRUE, then DO remove the source code after building the slackbuild. By default, the source code is not removed, and lives under $SBO_HOME/distfiles, which, by default, is /usr/sbo/distfiles. Setting this option to TRUE causes the source code to be removed by default. This can be overridden when running sboupgrade(1)/sboinstall(1).
 .RE
 .P
--p (/path|FALSE)
+-j|--jobs (FALSE|#)
 .RS
-PKG_DIR: If set to a path, packages will be stored at the given location after building and installing. By default, packages are left where they are deposited by slackbuilds, which is typically (probably always) /tmp. If PKG_DIR is FALSE and DISTCLEAN is TRUE (either in sbotools.conf(5) or at sboupgrade/sboinstall runtime), the package will be deleted. If this option is set to a path in the filesystem, the package will be stored in that directory, regardless of any DISTCLEAN option.
+JOBS: If numeric (2,5,10, etc), then that number will be fed to the "-j" argument to make when a slackbuild which invokes "make" is run. This only makes sense on multicore systems, where one might set the JOBS to the number of available cores, or half that number, etc.
 .RE
 .P
--s (/path|/usr/sbo)
+-p|--pkg-dir (FALSE|/path)
 .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.
+PKG_DIR: If set to a path, packages will be stored at the given location after building and installing. By default, packages are left where they are deposited by slackbuilds, which is typically (probably always) /tmp. If PKG_DIR is FALSE and DISTCLEAN is TRUE (either in sbotools.conf(5) or at sboupgrade/sboinstall runtime), the package will be deleted. If this option is set to a path in the filesystem, the package will be stored in that directory, regardless of any DISTCLEAN option.
 .RE
 .P
--v
+-s|--sbo-home (/usr/sbo|/path)
 .RS
-Show sbotools version information.
+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 BUGS
 .P
-None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome. In the future sbotools may exist in a public git repository and this section may change to reflect that.
+None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome.
 .SH SEE ALSO
 .P
 sbocheck(1), sboclean(1), sbofind(1), sboinstall(1), sboupgrade(1), sbosnap(1), sbotools.conf(5)
diff --git a/man1/sbofind.1 b/man1/sbofind.1
index d217924..56f26b9 100644
--- a/man1/sbofind.1
+++ b/man1/sbofind.1
@@ -4,34 +4,34 @@
 sbofind - search slackbuilds.org tree for a given name
 .SH SYNAPSES
 .P
-sbofind [-hvir] search_term
+sbofind [-h|-v] [-ir] search_term
 .SH DESCRIPTION
 .P
 sbofind searches the names of all slackbuilds for a given term. It reports back any slackbuilds found along with the path for each. This is equivalent to running "cd /usr/ports; make search name=$search_term display=name,path" on a FreeBSD system. For a more general search, the slackbuilds.org site should be consulted, where tags also exist and are included in the searched fields.
 .SH OPTIONS
 .P
--h
+-h|--help
 .RS
 Show help information.
 .RE
 .P
--v
+-v|--version
 .RS
-Show sbotools version information.
+Show version information.
 .RE
 .P
--i
+-i|--info
 .RS
-Show the contents of a the .info file for each slackbuild found.
+Show the contents of the .info file for each slackbuild found.
 .RE
 .P
--r
+-r|--readme
 .RS
 Show the contents of the README file for each slackbuild found.
 .RE
 .SH BUGS
 .P
-None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome. In the future sbotools may exist in a public git repository and this section may change to reflect that.
+None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome.
 .SH SEE ALSO
 .P
 sbocheck(1), sboclean(1), sboconfig(1), sboinstall(1), sboupgrade(1), sbosnap(1), sbotools.conf(5)
diff --git a/man1/sboinstall.1 b/man1/sboinstall.1
index 38dd531..2bb057b 100644
--- a/man1/sboinstall.1
+++ b/man1/sboinstall.1
@@ -4,61 +4,62 @@
 sboinstall - install slackbuilds
 .SH SYNAPSES
 .P
-sboinstall [-h] [-v] [-d TRUE|FALSE] [-j #|FALSE] [-c TRUE|FALSE] [-N] [-r] [-R] [-i] [-p] sbo_name (sbo_name)
+sboinstall [-h|-v] [-d TRUE|FALSE] [-j #|FALSE] [-c TRUE|FALSE] [-NrRip] sbo_name (sbo_name)
 .SH DESCRIPTION
 .P
-sboinstall is equivalent to sboupgrade -N, but is faster since it only installs new slackbuidls, so is preferred for installs. If the -i flag is NOT specified, sboinstall will pull the list of requirements from the .info file for any specified SlackBuild. If such a list exists, sboinstall will look to see whether or not those requirements are already installed, and if not, it will ask whether or not it should attempt to install them first. sboinstall will also note groupadd and useradd commands in README files and offer to run those first. If the README documents options of the KEY=value form, sboinstall will offer the opportunity to set options.
+sboinstall is equivalent to sboupgrade -N, but is faster since it only installs new slackbuidls, so is preferred for installs. If the -r flag is NOT specified, sboinstall will pull the list of requirements from the .info file for any specified slackbuild. If such a list exists, sboinstall will look to see whether or not those requirements are already installed, and if not, it will ask whether or not it should attempt to install them first. This is recursive, so that ordering happens correctly. sboinstall will refuse to handle circular requirements. sboinstall will also note groupadd and useradd commands in README files and offer to run those first. If the README documents options of the KEY=value form, sboinstall will offer the opportunity to set options.
 .SH OPTIONS
 .P
--h
+-h|--help
 .RS
 Show help information.
 .RE
 .P
--v
+-v|--version
 .RS
-Show sbotools version information.
+Show version information.
 .RE
 .P
--c (TRUE|FALSE)
+-c|--noclean (TRUE|FALSE)
 .RS
 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. This option leaves those directories in place. This can be set as default via the sboconfig(1) command. Also see sbotools.conf(5). This option overrides the default.
 .RE
 .P
--d (TRUE|FALSE)
+-d|--distclean (TRUE|FALSE)
 .RS
 If TRUE, then DO remove the source code after building the slackbuild. By default, the source code is not removed, and lives under $SBO_HOME/distfiles, which, by default, is /usr/sbo/distfiles; this option can be set as default via the sboconfig(1) command. See also sbotools.conf(5). This option overrides the default.
 .RE
 .P
--i
+-i|--noinstall
 .RS
 Do not actually install the package created at the end of the build process. So, the slackbuild will be run, and the package will be left in /tmp, or in $PKG_DIR if so defined (see sboconfig(1) and sbotools.conf(5)).
 .RE
 .P
--j (#|FALSE)
+-j|--jobs (FALSE|#)
 .RS
 If numeric (2,5,10, etc), then that number will be fed to the "-j" argument to make when a slackbuild which invokes "make" is run. This only makes sense on multicore systems, where one might set the JOBS to the number of available cores, or half that number, etc.
 .RE
 .P
--p
+-p|--compat32
 .RS
 Create a -compat32 package instead of a normal x86_64 package on multilib x86_64 systems. This requires /usr/sbin/convertpkg-compat32; this can at least be obtained from AlienBob's compat32-tools package - see http://alien.slackbook.org/blog/. Note that this may or may not be foolproof, and is not supported by anyone; not me, not AlienBob, not Slackware, etc. I recommend using this with the -i option so that the created package can be inspected prior to installation. If you find that a particular slackbuild needs additional help to be created as -compat32 package, contact me at j@dawnrazor.net.
 .RE
 .P
--i
+-r|--nointeractive
 .RS
-Skip viewing of the README and the yes or no question which accompanies it. Anytime sboupgrade or sboinstall is run, the first thing the command will attempt to do is show you the README for a given slackbuild and ask whether or not you wish to proceed; this option skips the README and bypasses the question. If multiple slackbuilds are specified, this option bypasses them all.
+Skip viewing of the README and the yes or no question which accompanies it. Anytime sboinstall is run, the first thing the command will attempt to do is show you the README for a given slackbuild and ask whether or not you wish to proceed; this option skips the README and bypasses the question. If multiple slackbuilds are specified, this option bypasses them all.
 .RE
--R
+.P
+-R|--norequirements
 .RS
-This option causes sboupgrade to ignore the requirement list.
+This option causes sboinstall to skip requirement handling, but still show the README and prompt the user to proceed.
 .RE
 .SH BUGS
 .P
-Requirement parsing is not foolproof; there are very likely corner cases where it does not function as expected. If any such cases are found, please report this to j@dawnrazor.net; patches are always welcome as well.
+None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome.
 .SH SEE ALSO
 .P
-sbocheck(1), sboclean(1), sboconfig(1), sbofind(1), sbosnap(1), sbotools.conf(5)
+sbocheck(1), sboclean(1), sboconfig(1), sbofind(1), sbosnap(1), sboupgrade(1), sbotools.conf(5)
 .SH AUTHOR
 .P
 Jacob Pipkin <j@dawnrazor.net>
diff --git a/man1/sbosnap.1 b/man1/sbosnap.1
index 1637788..de8b84c 100644
--- a/man1/sbosnap.1
+++ b/man1/sbosnap.1
@@ -4,12 +4,23 @@
 sbosnap - slackbuilds.org tree fetch and update command.
 .SH SYNAPSES
 .P
-sbosnap [-v] (fetch|update)
+sbosnap [-h|-v] (fetch|update)
 .SH DESCRIPTION
 .P
 sbosnap is used to download and update a local copy of the slackbuilds.org tree, minus the .tar.gz{,.asc} files. Note that sbocheck(1) will also update the tree, and will then also check for updated slackbuilds. rsync is used for both operations.
 .SH OPTIONS
 .P
+-h|--help
+.RS
+Show help information.
+.RE
+.P
+-v|--version
+.RS
+Show version information.
+.RE
+.SH COMMANDS
+.P
 fetch
 .RS
 Download a local copy of the slackbuilds.org tree. The copy will be downloaded to the SBO_HOME setting (see sboconfig(1) and sbotools.conf(5)), which, by default, is /usr/sbo
@@ -19,15 +30,9 @@ update
 .RS
 Update an previously fetch'd copy of the slackbuilds.org tree.
 .RE
-.P
--v
-.RS
-Show sbotools version information.
-.RE
-
 .SH BUGS
 .P
-None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome. In the future sbotools may exist in a public git repository and this section may change to reflect that.
+None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome.
 .SH SEE ALSO
 .P
 sbocheck(1), sboclean(1), sboconfig(1), sbofind(1), sboinstall(1), sboupgrade(1), sbotools.conf(5)
diff --git a/man1/sboupgrade.1 b/man1/sboupgrade.1
index 37db705..580b527 100644
--- a/man1/sboupgrade.1
+++ b/man1/sboupgrade.1
@@ -4,73 +4,72 @@
 sboupgrade - install or upgrade slackbuilds
 .SH SYNAPSES
 .P
-sboupgrade [-h] [-v] [-d TRUE|FALSE] [-j #|FALSE] [-c TRUE|FALSE] [-f] [-N] [-r] [-R] [-i] sbo_name (sbo_name)
+sboupgrade [-h|-v] [-d TRUE|FALSE] [-j #|FALSE] [-c TRUE|FALSE] [-fNrRiz] sbo_name (sbo_name)
 .SH DESCRIPTION
 .P
-sboupgrade is used to upgrade packages installed from slackbuilds. If the -i flag is NOT specified, sboupgrade will pull a list of requirements for any specified SlackBuild. If such a list exists, sboupgrade will look to see whether or not those requirements are already installed, and if not, it will ask whether or not it should attempt to install them first. sboupgrade will also note groupadd and useradd commands in README files and offer to run those first. If the README documents options of the KEY=value form, sboupgrade will offer the opportunity to set options.
-
+sboupgrade is used to upgrade packages installed from slackbuilds. If the -r flag is NOT specified, sboupgrade will pull the list of requirements from the .info file for any specified slackbuild. If such a list exists, sboupgrade will look to see whether or not those requirements are already installed, and if not, it will ask whether or not it should attempt to install them first. This is recursive, so that ordering happens correctly. sboupgrade will refuse to handle circular requirements. sboupgrade will also note groupadd and useradd commands in README files and offer to run those first. If the README documents options of the KEY=value form, sboupgrade will offer the opportunity to set options.
 .SH OPTIONS
 .P
--h
+-h|--help
 .RS
 Show help information.
 .RE
 .P
--v
+-v|--version
 .RS
 Show sbotools version information.
 .RE
 .P
--c (TRUE|FALSE)
+-c|--noclean (FALSE|TRUE)
 .RS
 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. This option leaves those directories in place. This can be set as default via the sboconfig(1) command. Also see sbotools.conf(5). This option overrides the default.
 .RE
 .P
--d (TRUE|FALSE)
+-d|--distclean (FALSE|TRUE)
 .RS
 If TRUE, then DO remove the source code after building the slackbuild. By default, the source code is not removed, and lives under $SBO_HOME/distfiles, which, by default, is /usr/sbo/distfiles; this option can be set as default via the sboconfig(1) command. See also sbotools.conf(5). This option overrides the default.
 .RE
 .P
--f
+-f|--force
 .RS
 Force an upgrade, even if the installed version is equal to or less than the slackbuilds.org version.
 .RE
 .P
--n
+-i|--noinstall
 .RS
 Do not actually install the package created at the end of the build process. So, the slackbuild will be run, and the package will be left in /tmp, or in $PKG_DIR if so defined (see sboconfig(1) and sbotools.conf(5)).
 .RE
 .P
--j (#|FALSE)
+-j|--jobs (FALSE|#)
 .RS
 If numeric (2,5,10, etc), then that number will be fed to the "-j" argument to make when a slackbuild which invokes "make" is run. This only makes sense on multicore systems, where one might set the JOBS to the number of available cores, or half that number, etc.
 .RE
 .P
--N
+-N|--installnew
 .RS
 Install any new slackbuilds specified. So, if you want to upgrade some things and install new things with the same command, then you would use the -N flag. Note that upgrades are handled prior to new installs.
 .RE
 .P
--i
+-r|--nointeractive
 .RS
 Skip viewing of the README and the yes or no question which accompanies it. Anytime sboupgrade is run, the first thing the command will attempt to do is show you the README for a given slackbuild and ask whether or not you wish to proceed; this option skips the README and bypasses the question. If multiple slackbuilds are specified, this option bypasses them all.
 .RE
 .P
--R
+-R|--norequirements
 .RS
-This option causes sboupgrade to skip requirement parsing, but still show the README and prompt the user to proceed.
+This option causes sboupgrade to skip requirement handling, but still show the README and prompt the user to proceed.
 .RE
 .P
--r
+-z|--force-reqs
 .RS
-When used in combination with the -f option, to force a slackbuild even if it would not constitute an update, this will cause sboupgrade to also rebuild all of that slackbuild's requirements that it can grok. Normally with -f, only the slackbuild(s) specified, and any requirements not already installed, will be rebuilt.
+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 BUGS
 .P
 None known, but there may be some. Please report any found to j@dawnrazor.net; patches are always welcome.
 .SH SEE ALSO
 .P
-sbocheck(1), sboclean(1), sboconfig(1), sbofind(1), sbosnap(1), sbotools.conf(5)
+sbocheck(1), sboclean(1), sboconfig(1), sbofind(1), sboinstall(1), sbosnap(1), sbotools.conf(5)
 .SH AUTHOR
 .P
 Jacob Pipkin <j@dawnrazor.net>