aboutsummaryrefslogtreecommitdiff
path: root/man1
diff options
context:
space:
mode:
Diffstat (limited to 'man1')
-rw-r--r--man1/sbocheck.125
-rw-r--r--man1/sboconfig.155
-rw-r--r--man1/sbofind.125
-rw-r--r--man1/sboinstall.159
-rw-r--r--man1/sbosnap.136
-rw-r--r--man1/sboupgrade.159
6 files changed, 259 insertions, 0 deletions
diff --git a/man1/sbocheck.1 b/man1/sbocheck.1
new file mode 100644
index 0000000..ee1463b
--- /dev/null
+++ b/man1/sbocheck.1
@@ -0,0 +1,25 @@
+.TH sbocheck 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.1 fnord" dawnrazor.net
+.SH NAME
+.P
+sbocheck - update a local slackbuilds.org tree and check for updates.
+.SH SYNAPSES
+.P
+sbocheck [-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 slackbuilds have updates, and reports what it finds.
+.SH OPTIONS
+.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.
+.SH SEE ALSO
+.P
+sboconfig(1), sbofind(1), sboinstall(1), sboupgrade(1), sbosnap(1), sbotools.conf(5)
+.SH AUTHOR
+.P
+Jacob Pipkin <j@dawnrazor.net>
diff --git a/man1/sboconfig.1 b/man1/sboconfig.1
new file mode 100644
index 0000000..a52930f
--- /dev/null
+++ b/man1/sboconfig.1
@@ -0,0 +1,55 @@
+.TH sboconfig 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.1 fnord" dawnrazor.net
+.SH NAME
+.P
+sboconfig - set sbotools configuration options.
+.SH SYNAPSES
+.P
+sboconfig [-h] [-l] [-c TRUE|FALSE] [-d TRUE|FALSE] [-p /path|FALSE] [-s /path|/usr/sbo] [-v]
+.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.
+.SH OPTIONS
+.P
+-h
+.RS
+Show help information.
+.RE
+.P
+-l
+.RS
+List out current configuration options, included 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).
+.RE
+.P
+-c (TRUE|FALSE)
+.RS
+NOCLEAN: If TRUE, then DO NOT clean working directories after building the SBo. 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 SBo. 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 (TRUE|FALSE)
+.RS
+DISTCLEAN: If TRUE, then DO remove the source code after building the SBo. 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)
+.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.
+.RE
+.P
+-s (/path|/usr/sbo)
+.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
+.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.
+.SH SEE ALSO
+.P
+sbocheck(1), sbofind(1), sboinstall(1), sboupgrade(1), sbosnap(1), sbotools.conf(5)
+.SH AUTHOR
+.P
+Jacob Pipkin <j@dawnrazor.net>
diff --git a/man1/sbofind.1 b/man1/sbofind.1
new file mode 100644
index 0000000..08c6d3a
--- /dev/null
+++ b/man1/sbofind.1
@@ -0,0 +1,25 @@
+.TH sbofind 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.1 fnord" dawnrazor.net
+.SH NAME
+.P
+sbofind - search SlackBuilds for a given name
+.SH SYNAPSES
+.P
+sbofind [-v] search_term
+.SH DESCRIPTION
+.P
+sbofind searches the names of all SlackBuilds for a given term. It reports back any SBos 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
+-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.
+.SH SEE ALSO
+.P
+sbocheck(1), sboconfig(1), sboinstall(1), sboupgrade(1), sbosnap(1), sbotools.conf(5)
+.SH AUTHOR
+.P
+Jacob Pipkin <j@dawnrazor.net>
diff --git a/man1/sboinstall.1 b/man1/sboinstall.1
new file mode 100644
index 0000000..7572fd3
--- /dev/null
+++ b/man1/sboinstall.1
@@ -0,0 +1,59 @@
+.TH sboupgrade 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.1 fnord" dawnrazor.net
+.SH NAME
+.P
+sboupgrade,sboinstall - install or upgrade SBos
+.SH SYNAPSES
+.P
+sboupgrade [-h] [-v] [-c TRUE|FALSE] [-d TRUE|FALSE] [-f] [-N] [-r] sbo_name (sbo_name)
+.SH DESCRIPTION
+.P
+sboupgrade is used to upgrade packages installed from SBos. sboinstall is equivalent to sboupgrade -N
+.SH OPTIONS
+.P
+-h
+.RS
+Show help information.
+.RE
+.P
+-c (TRUE|FALSE)
+.RS
+If TRUE, then DO NOT clean working directories after building the SBo. 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 SBo. 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)
+.RS
+If TRUE, then DO remove the source code after building the SBo. 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
+.RS
+Force an upgrade, even if the installed version is equal to or less than the slackbuilds.org version.
+.RE
+.P
+-N
+.RS
+Install any new SBos 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
+-r
+.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 SBo and ask whether or not you wish to proceed; this option skips the README and bypasses the question. If multiple SBos are specified, this option bypasses them all.
+.RE
+.P
+-v
+.RS
+Show sbotools version information.
+.RE
+.SH BUGS
+.P
+- Installing 32-bit packages on 64-bit systems is currently unsupported and in some cases impossible.
+.P
+- It is currently not possible to specify how many concurrent jobs make should run (make's -j flag).
+.P
+- Probably more that I've missed. 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.
+.SH SEE ALSO
+.P
+sbocheck(1), sboconfig(1), sbofind(1), sbosnap(1), sbotools.conf(5)
+.SH AUTHOR
+.P
+Jacob Pipkin <j@dawnrazor.net>
diff --git a/man1/sbosnap.1 b/man1/sbosnap.1
new file mode 100644
index 0000000..9a15345
--- /dev/null
+++ b/man1/sbosnap.1
@@ -0,0 +1,36 @@
+.TH sbosnap 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.1 fnord" dawnrazor.net
+.SH NAME
+.P
+sbosnap - slackbuilds.org tree fetch and update command.
+.SH SYNAPSES
+.P
+sbosnap [-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 SBos. rsync is used for both operations.
+.SH OPTIONS
+.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
+.RE
+.P
+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.
+.SH SEE ALSO
+.P
+sbocheck(1), sboconfig(1), sbofind(1), sboinstall(1), sboupgrade(1), sbotools.conf(5)
+.SH AUTHOR
+.P
+Jacob Pipkin <j@dawnrazor.net>
diff --git a/man1/sboupgrade.1 b/man1/sboupgrade.1
new file mode 100644
index 0000000..7572fd3
--- /dev/null
+++ b/man1/sboupgrade.1
@@ -0,0 +1,59 @@
+.TH sboupgrade 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.1 fnord" dawnrazor.net
+.SH NAME
+.P
+sboupgrade,sboinstall - install or upgrade SBos
+.SH SYNAPSES
+.P
+sboupgrade [-h] [-v] [-c TRUE|FALSE] [-d TRUE|FALSE] [-f] [-N] [-r] sbo_name (sbo_name)
+.SH DESCRIPTION
+.P
+sboupgrade is used to upgrade packages installed from SBos. sboinstall is equivalent to sboupgrade -N
+.SH OPTIONS
+.P
+-h
+.RS
+Show help information.
+.RE
+.P
+-c (TRUE|FALSE)
+.RS
+If TRUE, then DO NOT clean working directories after building the SBo. 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 SBo. 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)
+.RS
+If TRUE, then DO remove the source code after building the SBo. 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
+.RS
+Force an upgrade, even if the installed version is equal to or less than the slackbuilds.org version.
+.RE
+.P
+-N
+.RS
+Install any new SBos 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
+-r
+.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 SBo and ask whether or not you wish to proceed; this option skips the README and bypasses the question. If multiple SBos are specified, this option bypasses them all.
+.RE
+.P
+-v
+.RS
+Show sbotools version information.
+.RE
+.SH BUGS
+.P
+- Installing 32-bit packages on 64-bit systems is currently unsupported and in some cases impossible.
+.P
+- It is currently not possible to specify how many concurrent jobs make should run (make's -j flag).
+.P
+- Probably more that I've missed. 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.
+.SH SEE ALSO
+.P
+sbocheck(1), sboconfig(1), sbofind(1), sbosnap(1), sbotools.conf(5)
+.SH AUTHOR
+.P
+Jacob Pipkin <j@dawnrazor.net>