Surprise, surprise... scripts do this better.

pghvlaans · Nov 3, 2024 · cadc0e6 · cadc0e6
1 parent 44ad7c2
commit cadc0e6
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 36 deletions.
diff --git a/man/sbocheck.1.md b/man/sbocheck.1.md
@@ -25,7 +25,7 @@ updates.
 **sbocheck** first updates a previously-fetched copy of the
 **slackbuilds.org** tree (see [sbosnap(1)](sbosnap.1.md)) checks for available
 upgrades, and reports what it finds. SlackBuilds with differing build
-numbers are reported separately, as are any SlackBuilds marked *_SBo*
+numbers are reported separately, as are any SlackBuilds marked *\_SBo*
 that are not found in the repository.
 
 The three output categories are logged separately to

diff --git a/man/sboclean.1.md b/man/sboclean.1.md
@@ -4,9 +4,10 @@
 [SYNOPSIS](#synopsis)\
 [DESCRIPTION](#description)\
 [OPTIONS](#options)\
+[EXIT CODES](#exit-codes)\
 [BUGS](#bugs)\
 [SEE ALSO](#see-also)\
-[AUTHORS](#authors)\
+[AUTHOR](#AUTHOR)\
 [MAINTAINER](#maintainer)
 
 ------------------------------------------------------------------------
@@ -23,11 +24,11 @@
 
 **sboclean** is used to clean files left by **sbotools3**, such as saved
 options (in */var/log/sbotools*), downloaded source files ("distfiles"),
-or working directories under */tmp/SBo* (or *$TMP*) and, for compat32
-installs, under */tmp* (or *$TMP*). Note that if not run with the
+or working directories under */tmp/SBo* (or *\$TMP*) and, for compat32
+installs, under */tmp* (or *\$TMP*). Note that if not run with the
 **\--interactive** flag, **sboclean** will remove anything in the
-distfiles and/or */tmp/SBo* (or *$TMP*) directories and any
-*/tmp/package-\*-compat32* (or *$TMP/package-\*-compat32*) directories
+distfiles and/or */tmp/SBo* (or *\$TMP*) directories and any
+*/tmp/package-\*-compat32* (or *\$TMP/package-\*-compat32*) directories
 with extreme prejudice. One of **\--dist**, **\--work** or **\--option**
 must be specified for this script to do anything.
 
@@ -78,7 +79,7 @@ None known. If found, Issues and Pull Requests to
 [sbocheck(1)](sbocheck.1.md), [sboconfig(1)](sboconfig.1.md), [sbofind(1)](sbofind.1.md), [sboinstall(1)](sboinstall.1.md), [sboremove(1)](sboremove.1.md),
 [sbosnap(1)](sbosnap.1.md), [sboupgrade(1)](sboupgrade.1.md), [sbotools.conf(5)](sbotools.conf.5.md)
 
-## AUTHORS
+## AUTHOR []{#AUTHOR}
 
 Jacob Pipkin \<j (at) dawnrazor (dot) net\>
 

diff --git a/man/sboconfig.1.md b/man/sboconfig.1.md
@@ -4,6 +4,7 @@
 [SYNOPSIS](#synopsis)\
 [DESCRIPTION](#description)\
 [OPTIONS](#options)\
+[EXIT CODES](#exit-codes)\
 [BUGS](#bugs)\
 [SEE ALSO](#see-also)\
 [AUTHORS](#authors)\
@@ -21,7 +22,7 @@
 
     sboconfig [-l]
 
-    sboconfig [-c TRUE|FALSE] [-d TRUE|FALSE] [-j #\|FALSE] \
+    sboconfig [-c TRUE|FALSE] [-d TRUE|FALSE] [-j #|FALSE] \
               [-p /path|FALSE] [-s /path|/usr/sbo] [-B branch_name|FALSE] \
               [-b TRUE|FALSE] [-o /path|FALSE] [-V #.#|FALSE] \
               [-r url|FALSE] [-R TRUE|FALSE]
@@ -65,7 +66,7 @@ number differs.
 
 **NOCLEAN**:If **TRUE**, do not clean working directories after
 building. These are the build and *package-(sbo)* directories under
-*/tmp/SBo* (or *$TMP*).
+*/tmp/SBo* (or *\$TMP*).
 
 **-d\|\--distclean (FALSE\|TRUE)**
 

diff --git a/man/sbofind.1.md b/man/sbofind.1.md
@@ -4,6 +4,7 @@
 [SYNOPSIS](#synopsis)\
 [DESCRIPTION](#description)\
 [OPTIONS](#options)\
+[EXIT CODES](#exit-codes)\
 [BUGS](#bugs)\
 [SEE ALSO](#see-also)\
 [AUTHORS](#authors)\
@@ -13,8 +14,8 @@
 
 ## NAME
 
-**sbofind** - search the local copy of the **slackbuilds.org** tree for a
-given name
+**sbofind** - search the local copy of the **slackbuilds.org** tree for
+a given name
 
 ## SYNOPSIS
 
@@ -28,7 +29,7 @@ given name
 term. It reports back any SlackBuilds found along with path and version
 information. This is equivalent to running
 
-    cd /usr/ports; make search name=$search_term display=name,path
+    cd /usr/ports; make search name=\$search_term display=name,path
 
 on a FreeBSD system. If the repository includes a *TAGS.txt* file, that
 will be used to find additional results.

diff --git a/man/sboinstall.1.md b/man/sboinstall.1.md
@@ -4,6 +4,7 @@
 [SYNOPSIS](#synopsis)\
 [DESCRIPTION](#description)\
 [OPTIONS](#options)\
+[EXIT CODES](#exit-codes)\
 [BUGS](#bugs)\
 [SEE ALSO](#see-also)\
 [AUTHORS](#authors)\
@@ -58,8 +59,8 @@ Show version information.
 
 **-c\|\--noclean (FALSE\|TRUE)**
 
-If TRUE, do not clean working directories after building. These are the
-build and *package-(sbo)* directories under */tmp/SBo* (or *$TMP*).
+If **TRUE**, do not clean working directories after building. These are
+the build and *package-(sbo)* directories under */tmp/SBo* (or *\$TMP*).
 Cleaning these directories can be set as default via the
 [sboconfig(1)](sboconfig.1.md) command. See also [sbotools.conf(5)](sbotools.conf.5.md). This option
 overrides the default.
@@ -74,12 +75,12 @@ This option overrides the default.
 **-i\|\--noinstall**
 
 Do not install the package at the end of the build process. It will be
-left in */tmp* (or *$OUTPUT*), or in **PKG_DIR** if so defined. See
+left in */tmp* (or *\$OUTPUT*), or in **PKG_DIR** if so defined. See
 [sboconfig(1)](sboconfig.1.md) and [sbotools.conf(5)](sbotools.conf.5.md).
 
 **-j\|\--jobs (FALSE\|#)**
 
-If numerical, pass to the **-j** argument when a SlackBuild invoking
+If **numerical**, pass to the **-j** argument when a SlackBuild invoking
 **make** is run.
 
 **-p\|\--compat32**
@@ -128,7 +129,7 @@ prompts.
 4: unable to md5sum verify the source file(s).\
 5: unable to download the source file(s).\
 6: unable to obtain a required file handle.\
-7: unable to get required info from the .info file.\
+7: unable to get required info from the *info* file.\
 8: unable to unset the exec-on-close bit on a temporary file.\
 9: multilib has not been set up (where required).\
 10: **convertpkg-compat32** exited non-zero.\

diff --git a/man/sboremove.1.md b/man/sboremove.1.md
@@ -4,6 +4,7 @@
 [SYNOPSIS](#synopsis)\
 [DESCRIPTION](#description)\
 [OPTIONS](#options)\
+[EXIT CODES](#exit-codes)\
 [BUGS](#bugs)\
 [SEE ALSO](#see-also)\
 [AUTHORS](#authors)\

diff --git a/man/sbosnap.1.md b/man/sbosnap.1.md
@@ -4,6 +4,8 @@
 [SYNOPSIS](#synopsis)\
 [DESCRIPTION](#description)\
 [OPTIONS](#options)\
+[COMMANDS](#commands)\
+[EXIT CODES](#exit-codes)\
 [BUGS](#bugs)\
 [SEE ALSO](#see-also)\
 [AUTHORS](#authors)\
@@ -24,11 +26,11 @@
 ## DESCRIPTION
 
 **sbosnap** is used to download and update a local copy of the
-**slackbuilds.org** tree, without the *\*.tar.gz{,.asc}* files. Note that
-[sbocheck(1)](sbocheck.1.md) also updates the tree and checks for updated and removed
-SlackBuilds. **rsync** is used for rsync repositories, and **git** is
-used for git repositories. **sbotools3** defaults to git unless
-**RSYNC_DEFAULT** is **TRUE**. See [sboconfig(1)](sboconfig.1.md) or
+**slackbuilds.org** tree, without the *\*.tar.gz{,.asc}* files. Note
+that [sbocheck(1)](sbocheck.1.md) also updates the tree and checks for updated and
+removed SlackBuilds. **rsync** is used for rsync repositories, and
+**git** is used for git repositories. **sbotools3** defaults to git
+unless **RSYNC_DEFAULT** is **TRUE**. See [sboconfig(1)](sboconfig.1.md) or
 [sbotools.conf(5)](sbotools.conf.5.md).
 
 ## OPTIONS
@@ -45,7 +47,7 @@ Show version information.
 
 **fetch**
 
-Download a local copy of the **slackbuilds.org** tree. The copy will be
+Download a local copy of the *slackbuilds.org* tree. The copy will be
 downloaded to the path in the **SBO_HOME** setting (see [sboconfig(1)](sboconfig.1.md)
 and [sbotools.conf(5)](sbotools.conf.5.md)), */usr/sbo* by default.
 

diff --git a/man/sbotools.conf.5.md b/man/sbotools.conf.5.md
@@ -22,8 +22,7 @@ The current configuration keys are as follows:
 **DISTCLEAN=(FALSE\|TRUE)**
 
 If **TRUE**, then remove the source archives after building. They are
-retained in */usr/sbo/distfiles* (with **SBO_HOME**=*/usr/sbo*) by
-default.
+retained in */usr/sbo/distfiles* (with *SBO_HOME=/usr/sbo*) by default.
 
 **JOBS=(FALSE\|#)**
 
@@ -33,7 +32,7 @@ If **numerical**, pass to the **-j** argument when a SlackBuild invoking
 **NOCLEAN=(FALSE\|TRUE)**
 
 If **TRUE**, do not clean working directories after building. These are
-the build and *package-(sbo)* directories under */tmp/SBo* (or *$TMP*).
+the build and *package-(sbo)* directories under */tmp/SBo* (or *\$TMP*).
 
 **GIT_BRANCH=(FALSE\|branch_name)**
 
@@ -79,10 +78,10 @@ If set to a git or rsync **URL**, use that repository instead of the
 repositories are under rsync://slackbuilds.org/slackbuilds if
 **RSYNC_DEFAULT** is **TRUE** and <https://gitlab.com/SlackBuilds.org>
 otherwise. The repository must be laid out in the same manner as one
-found at <https://git.slackbuilds.org/slackbuilds>, such that
-SlackBuild directories are under the category directories.
+found at <https://git.slackbuilds.org/slackbuilds> such that SlackBuild
+directories are under the category directories.
 
-**RSYNC_DEFAULT(FALSE\|TRUE)**
+**RSYNC_DEFAULT=(FALSE\|TRUE)**
 
 If set to **TRUE**, use rsync default mirrors except for Slackware
 -current.

diff --git a/man/sboupgrade.1.md b/man/sboupgrade.1.md
@@ -4,6 +4,7 @@
 [SYNOPSIS](#synopsis)\
 [DESCRIPTION](#description)\
 [OPTIONS](#options)\
+[EXIT CODES](#exit-codes)\
 [BUGS](#bugs)\
 [SEE ALSO](#see-also)\
 [AUTHORS](#authors)\
@@ -66,7 +67,7 @@ upgrades even if the build number is unchanged. This overrides the
 **-c\|\--noclean (FALSE\|TRUE)**
 
 If **TRUE**, do not clean working directories after building. These are
-the build and *package-(sbo)* directories under */tmp/SBo* (or *$TMP*).
+the build and *package-(sbo)* directories under */tmp/SBo* (or *\$TMP*).
 Cleaning these directories can be set as default via the
 [sboconfig(1)](sboconfig.1.md) command. See also [sbotools.conf(5)](sbotools.conf.5.md). This option
 overrides the default.
@@ -86,7 +87,7 @@ equal to the **slackbuilds.org** version.
 **-i\|\--noinstall**
 
 Do not install the package at the end of the build process. It will be
-left in */tmp* (or *$OUTPUT*), or in **PKG_DIR** if so defined. See
+left in */tmp* (or *\$OUTPUT*), or in **PKG_DIR** if so defined. See
 [sboconfig(1)](sboconfig.1.md) and [sbotools.conf(5)](sbotools.conf.5.md).
 
 **-j\|\--jobs (FALSE\|#)**
@@ -101,16 +102,16 @@ Create a -compat32 package on multilib x86_64 systems. This requires the
 operation is not necessarily foolproof, and is unsupported by anyone in
 principle. As a best practice, **\--compat32** should be combined with
 **\--noinstall** so that the contents of the package can be inspected
-prior to installation. Ensure that the running shell has already sourced
-*/etc/profile.d/32dev.{c,}sh* before running, and that the **DISTCLEAN**
-option is set to **FALSE.** GitHub Issues are welcome in case of
-unexpected failure.
+prior to installation. If the base package and compat32 package are to
+be built at the same time, ensure that the **DISTCLEAN** option is set
+to **FALSE.** GitHub Issues are welcome in case of unexpected failure.
 
 **-r\|\--nointeractive**
 
 Bypass all user prompts and all dependency resolution for the requested
 SlackBuilds. Unless it is obvious that dependency resolution and build
-options are not required, consider using a template instead.
+options are not required, this option should not be used with
+**sboupgrade**.
 
 **-z\|\--force-reqs**