Skip to content

Commit

Permalink
Link the man pages together
Browse files Browse the repository at this point in the history
  • Loading branch information
pghvlaans committed Nov 1, 2024
1 parent 2e02b05 commit 6e5dd28
Show file tree
Hide file tree
Showing 9 changed files with 176 additions and 184 deletions.
6 changes: 3 additions & 3 deletions man/sbocheck.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ sbocheck \[-h\|-v\]
## DESCRIPTION

**sbocheck** first updates a previously-fetched copy of the
**slackbuilds.org** tree (see **sbosnap(1)**) checks for available
**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`
that are not found in the repository.
Expand All @@ -49,8 +49,8 @@ None known. If found, Issues and Pull Requests to

## SEE ALSO

sboclean(1), sboconfig(1), sbofind(1), sboinstall(1), sboremove(1),
sbosnap(1), sboupgrade(1), sbotools.conf(5)
[sboclean(1)](sboclean.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)

## AUTHORS

Expand Down
43 changes: 21 additions & 22 deletions man/sboclean.1.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,25 @@
# sboclean {#sboclean align="center"}

[NAME](#NAME)\
[SYNOPSIS](#SYNOPSIS)\
[DESCRIPTION](#DESCRIPTION)\
[OPTIONS](#OPTIONS)\
[EXIT CODES](#EXIT%20CODES)\
[BUGS](#BUGS)\
[SEE ALSO](#SEE%20ALSO)\
[AUTHOR](#AUTHOR)\
[MAINTAINER](#MAINTAINER)\
# sboclean

[NAME](#name)\
[SYNOPSIS](#synopsis)\
[DESCRIPTION](#description)\
[OPTIONS](#options)\
[BUGS](#bugs)\
[SEE ALSO](#see-also)\
[AUTHORS](#authors)\
[MAINTAINER](#maintainer)

------------------------------------------------------------------------

## NAME []{#NAME}
## NAME

**sboclean** - clean files left by **sbotools3.**

## SYNOPSIS []{#SYNOPSIS}
## SYNOPSIS

sboclean \[-h\|-v\] \[-dwi\] \[-o ALL\|package\]

## DESCRIPTION []{#DESCRIPTION}
## DESCRIPTION

**sboclean** is used to clean files left by **sbotools3**, such as saved
options (in `/var/log/sbotools`), downloaded source files ("distfiles"),
Expand All @@ -32,7 +31,7 @@ distfiles and/or `/tmp/SBo` (or `$TMP`) directories and any
with extreme prejudice. One of **\--dist**, **\--work** or **\--option**
must be specified for this script to do anything.

## OPTIONS []{#OPTIONS}
## OPTIONS

**-h\|\--help**

Expand Down Expand Up @@ -61,33 +60,33 @@ name of a SlackBuild, clean the saved options for that SlackBuild only.
Be interactive; **sboclean** will use confirmation prompts for each item
that could be removed.

## EXIT CODES []{#EXIT CODES}
## EXIT CODES

**sboclean** can exit with the following codes:

0: all operations completed successfully.\
1: a usage error occurred, such as running **sboclean** with nothing to
clean.

## BUGS []{#BUGS}
## BUGS

None known. If found, Issues and Pull Requests to
<https://github.com/pghvlaans/sbotools3/> are always welcome.

## SEE ALSO []{#SEE ALSO}
## SEE ALSO

sbocheck(1), sboconfig(1), sbofind(1), sboinstall(1), sboremove(1),
sbosnap(1), sboupgrade(1), sbotools.conf(5)
[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)

## AUTHOR []{#AUTHOR}
## AUTHORS

Jacob Pipkin \<j (at) dawnrazor (dot) net\>

Luke Williams \<xocel (at) iquidus (dot) org\>

Andreas Guldstrand \<andreas (dot) guldstrand (at) gmail (dot) com\>

## MAINTAINER []{#MAINTAINER}
## MAINTAINER

K. Eugene Carlson \<kvngncrlsn (at) gmail (dot) com\>

Expand Down
45 changes: 22 additions & 23 deletions man/sboconfig.1.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
# sboconfig {#sboconfig align="center"}

[NAME](#NAME)\
[SYNOPSIS](#SYNOPSIS)\
[DESCRIPTION](#DESCRIPTION)\
[OPTIONS](#OPTIONS)\
[EXIT CODES](#EXIT%20CODES)\
[BUGS](#BUGS)\
[SEE ALSO](#SEE%20ALSO)\
[AUTHORS](#AUTHORS)\
[MAINTAINER](#MAINTAINER)\
# sboconfig

[NAME](#name)\
[SYNOPSIS](#synopsis)\
[DESCRIPTION](#description)\
[OPTIONS](#options)\
[BUGS](#bugs)\
[SEE ALSO](#see-also)\
[AUTHORS](#authors)\
[MAINTAINER](#maintainer)

------------------------------------------------------------------------

## NAME []{#NAME}
## NAME

**sboconfig** - set **sbotools3 configuration options.**

## SYNOPSIS []{#SYNOPSIS}
## SYNOPSIS

sboconfig \[-h\|-v\]

Expand All @@ -27,13 +26,13 @@ sboconfig \[-c TRUE\|FALSE\] \[-d TRUE\|FALSE\] \[-j #\|FALSE\] \[-p
TRUE\|FALSE\] \[-o /path\|FALSE\] \[-V #.#\|FALSE\] \[-r url\|FALSE\]
\[-R TRUE\|FALSE\]

## DESCRIPTION []{#DESCRIPTION}
## DESCRIPTION

**sboconfig** is a front-end for managing **sbotools3** configuration
options. The **sbotools.conf(5)** file can also be manually edited; any
fields not relevant to **sbotools3 configuration will be ignored.**

## OPTIONS []{#OPTIONS}
## OPTIONS

**-h\|\--help**

Expand All @@ -53,7 +52,7 @@ for reference.

**GIT_BRANCH**: If **FALSE**, use the default git branch for the
Slackware version, if any. If **branch_name**, attempt to change
branches to **branch_name** when using **sbosnap(1)** or **sbocheck(1)**
branches to **branch_name** when using **[sbosnap(1)](sbosnap.1.md)** or **[sbocheck(1)](sbocheck.1.md)**
with an upstream git repository.

**-b\|\--build-ignore (FALSE\|TRUE)**
Expand Down Expand Up @@ -121,33 +120,33 @@ directories are under the category directories.
**RSYNC_DEFAULT**: If set to **TRUE**, use rsync default mirrors except
for Slackware -current.

## EXIT CODES []{#EXIT CODES}
## EXIT CODES

**sboconfig** can exit with the following codes:

0: all operations were successful.\
1: a usage error occurred (e.g. passing invalid option specifications)\
6: **sboconfig** was unable to obtain a required file handle.

## BUGS []{#BUGS}
## BUGS

None known. If found, Issues and Pull Requests to
<https://github.com/pghvlaans/sbotools3/> are always welcome.

## SEE ALSO []{#SEE ALSO}
## SEE ALSO

sbocheck(1), sboclean(1), sbofind(1), sboinstall(1), sboremove(1),
sbosnap(1), sboupgrade(1), sbotools.conf(5)
[sbocheck(1)](sbocheck.1.md), [sboclean(1)](sboclean.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)

## AUTHORS []{#AUTHORS}
## AUTHORS

Jacob Pipkin \<j (at) dawnrazor (dot) net\>

Luke Williams \<xocel (at) iquidus (dot) org\>

Andreas Guldstrand \<andreas (dot) guldstrand (at) gmail (dot) com\>

## MAINTAINER []{#MAINTAINER}
## MAINTAINER

K. Eugene Carlson \<kvngncrlsn (at) gmail (dot) com\>

Expand Down
43 changes: 21 additions & 22 deletions man/sbofind.1.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
# sbofind {#sbofind align="center"}

[NAME](#NAME)\
[SYNOPSIS](#SYNOPSIS)\
[DESCRIPTION](#DESCRIPTION)\
[OPTIONS](#OPTIONS)\
[EXIT CODES](#EXIT%20CODES)\
[BUGS](#BUGS)\
[SEE ALSO](#SEE%20ALSO)\
[AUTHORS](#AUTHORS)\
[MAINTAINER](#MAINTAINER)\
# sbofind

[NAME](#name)\
[SYNOPSIS](#synopsis)\
[DESCRIPTION](#description)\
[OPTIONS](#options)\
[BUGS](#bugs)\
[SEE ALSO](#see-also)\
[AUTHORS](#authors)\
[MAINTAINER](#maintainer)

------------------------------------------------------------------------

## NAME []{#NAME}
## NAME

**sbofind** - search the local copy of the *slackbuilds.org* tree for a
given name

## SYNOPSIS []{#SYNOPSIS}
## SYNOPSIS

sbofind \[-h\|-v\]

sbofind \[-etirq\] search_term

## DESCRIPTION []{#DESCRIPTION}
## DESCRIPTION

**sbofind** searches the names of all available SlackBuilds for a given
term. It reports back any SlackBuilds found along with path and version
Expand All @@ -34,7 +33,7 @@ information. This is equivalent to running
on a FreeBSD system. If the repository includes a *TAGS.txt* file, that
will be used to find additional results.

## OPTIONS []{#OPTIONS}
## OPTIONS

**-h\|\--help**

Expand Down Expand Up @@ -64,33 +63,33 @@ Show the contents of the `README` file for each SlackBuild found.

Show the build queue for each SlackBuild found.

## EXIT CODES []{#EXIT CODES}
## EXIT CODES

**sbofind** can exit with the following codes:

0: all operations were succesful.\
1: a usage error occured (i.e. **sbofind** ran with nothing to find)\
6: **sbofind** was unable to obtain a required file handle.

## BUGS []{#BUGS}
## BUGS

None known. If found, Issues and Pull Requests to
<https://github.com/pghvlaans/sbotools3/> are always welcome.

## SEE ALSO []{#SEE ALSO}
## SEE ALSO

sbocheck(1), sboclean(1), sboconfig(1), sboinstall(1), sboremove(1),
sbosnap(1), sboupgrade(1), sbotools.conf(5)
[sbocheck(1)](sbocheck.1.md), [sboclean(1)](sboclean.1.md), [sboconfig(1)](sboconfig.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)

## AUTHORS []{#AUTHORS}
## AUTHORS

Jacob Pipkin \<j (at) dawnrazor (dot) net\>

Luke Williams \<xocel (at) iquidus (dot) org\>

Andreas Guldstrand \<andreas (dot) guldstrand (at) gmail (dot) com\>

## MAINTAINER []{#MAINTAINER}
## MAINTAINER

K. Eugene Carlson \<kvngncrlsn (at) gmail (dot) com\>

Expand Down
Loading

0 comments on commit 6e5dd28

Please sign in to comment.