diff options
author | Jacob Pipkin <d4wnr4z0r@yahoo.com> | 2012-05-14 00:17:55 -0500 |
---|---|---|
committer | Jacob Pipkin <d4wnr4z0r@yahoo.com> | 2012-05-14 00:17:55 -0500 |
commit | 4e71b8b0036c96869cc64bbea7251ae7d6bad102 (patch) | |
tree | 6691d9793d584f6672678eb1af0ebf3aba25984b | |
parent | 3d832379c320564550a503ac7fd66167a0b80944 (diff) | |
download | sbotools2-4e71b8b0036c96869cc64bbea7251ae7d6bad102.tar.xz |
updated man pages
-rw-r--r-- | man1/sbocheck.1 | 2 | ||||
-rw-r--r-- | man1/sboconfig.1 | 19 | ||||
-rw-r--r-- | man1/sbofind.1 | 2 | ||||
-rw-r--r-- | man1/sboinstall.1 | 27 | ||||
-rw-r--r-- | man1/sbosnap.1 | 2 | ||||
-rw-r--r-- | man1/sboupgrade.1 | 26 | ||||
-rw-r--r-- | man5/sbotools.conf.5 | 16 |
7 files changed, 53 insertions, 41 deletions
diff --git a/man1/sbocheck.1 b/man1/sbocheck.1 index 6f49a91..52c831e 100644 --- a/man1/sbocheck.1 +++ b/man1/sbocheck.1 @@ -1,4 +1,4 @@ -.TH sbocheck 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.2 fnord" dawnrazor.net +.TH sbocheck 1 "Prickle-Prickle, the 61st day of Discord in the YOLD 3178" "sbotools 0.3 fnord" dawnrazor.net .SH NAME .P sbocheck - update a local slackbuilds.org tree and check for updates. diff --git a/man1/sboconfig.1 b/man1/sboconfig.1 index c6f5188..6f7299d 100644 --- a/man1/sboconfig.1 +++ b/man1/sboconfig.1 @@ -1,10 +1,10 @@ -.TH sboconfig 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.2 fnord" dawnrazor.net +.TH sboconfig 1 "Prickle-Prickle, the 61st day of Discord in the YOLD 3178" "sbotools 0.3 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] +sboconfig [-h] [-l] [-d TRUE|FALSE] [-j #|FALSE] [-c 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. @@ -17,17 +17,22 @@ Show help information. .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). +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). .RE .P --c (TRUE|FALSE) +-d (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). +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 --d (TRUE|FALSE) +-j (#|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). +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 +-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 -p (/path|FALSE) diff --git a/man1/sbofind.1 b/man1/sbofind.1 index 4e4e1f1..6fa0870 100644 --- a/man1/sbofind.1 +++ b/man1/sbofind.1 @@ -1,4 +1,4 @@ -.TH sbofind 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.2 fnord" dawnrazor.net +.TH sbofind 1 "Prickle-Prickle, the 61st day of Discord in the YOLD 3178" "sbotools 0.3 fnord" dawnrazor.net .SH NAME .P sbofind - search SlackBuilds for a given name diff --git a/man1/sboinstall.1 b/man1/sboinstall.1 index 139e010..6da268c 100644 --- a/man1/sboinstall.1 +++ b/man1/sboinstall.1 @@ -1,13 +1,13 @@ -.TH sboupgrade 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.2 fnord" dawnrazor.net +.TH sboinstall 1 "Prickle-Prickle, the 61st day of Discord in the YOLD 3178" "sbotools 0.3 fnord" dawnrazor.net .SH NAME .P -sboupgrade,sboinstall - install or upgrade SBos +sboinstall - install SBos .SH SYNAPSES .P -sboinstall [-h] [-v] [-c TRUE|FALSE] [-d TRUE|FALSE] [-N] [-r] [-i] sbo_name (sbo_name) +sboinstall [-h] [-v] [-d TRUE|FALSE] [-j #|FALSE] [-c TRUE|FALSE] [-N] [-r] [-i] sbo_name (sbo_name) .SH DESCRIPTION .P -sboupgrade is used to upgrade packages installed from SBos. sboinstall is equivalent to sboupgrade -N, but is faster, so is preferred if only installing a new package. +sboinstall is equivalent to sboupgrade -N, but is faster, so is preferred if only installing one or more new packages. .SH OPTIONS .P -h @@ -15,14 +15,19 @@ sboupgrade is used to upgrade packages installed from SBos. sboinstall is equiva Show help information. .RE .P --c (TRUE|FALSE) +-d (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. +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 --d (TRUE|FALSE) +-j (#|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. +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 +-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 -N @@ -46,11 +51,7 @@ Show sbotools version information. .RE .SH BUGS .P -- Installing compat-32 packages on 64-bit systems is currently 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. +None that I'm aware of, but I may have missed 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), sbosnap(1), sbotools.conf(5) diff --git a/man1/sbosnap.1 b/man1/sbosnap.1 index 98b4dc1..cb1e81f 100644 --- a/man1/sbosnap.1 +++ b/man1/sbosnap.1 @@ -1,4 +1,4 @@ -.TH sbosnap 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.2 fnord" dawnrazor.net +.TH sbosnap 1 "Prickle-Prickle, the 61st day of Discord in the YOLD 3178" "sbotools 0.3 fnord" dawnrazor.net .SH NAME .P sbosnap - slackbuilds.org tree fetch and update command. diff --git a/man1/sboupgrade.1 b/man1/sboupgrade.1 index bfb46d0..f947282 100644 --- a/man1/sboupgrade.1 +++ b/man1/sboupgrade.1 @@ -1,13 +1,13 @@ -.TH sboupgrade 1 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.2 fnord" dawnrazor.net +.TH sboupgrade 1 "Prickle-Prickle, the 61st day of Discord in the YOLD 3178" "sbotools 0.3 fnord" dawnrazor.net .SH NAME .P -sboupgrade,sboinstall - install or upgrade SBos +sboupgrade - install or upgrade SBos .SH SYNAPSES .P -sboupgrade [-h] [-v] [-c TRUE|FALSE] [-d TRUE|FALSE] [-f] [-N] [-r] [-i] sbo_name (sbo_name) +sboupgrade [-h] [-v] [-d TRUE|FALSE] [-j #|FALSE] [-c TRUE|FALSE] [-f] [-N] [-r] [-i] sbo_name (sbo_name) .SH DESCRIPTION .P -sboupgrade is used to upgrade packages installed from SBos. sboinstall is equivalent to sboupgrade -N, but is faster, so is preferred if only installing a new package. +sboupgrade is used to upgrade packages installed from SBos. .SH OPTIONS .P -h @@ -15,14 +15,18 @@ sboupgrade is used to upgrade packages installed from SBos. sboinstall is equiva Show help information. .RE .P --c (TRUE|FALSE) +-d (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. +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 +-j (#|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 --d (TRUE|FALSE) +-c (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. +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 -f @@ -51,11 +55,7 @@ Show sbotools version information. .RE .SH BUGS .P -- Installing compat-32 packages on 64-bit systems is currently 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. +None that I'm aware of, but I may have missed 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), sbosnap(1), sbotools.conf(5) diff --git a/man5/sbotools.conf.5 b/man5/sbotools.conf.5 index 1240f47..9a90182 100644 --- a/man5/sbotools.conf.5 +++ b/man5/sbotools.conf.5 @@ -1,4 +1,4 @@ -.TH sbotools.conf 5 "Pungenday, the 45th day of Discord in the YOLD 3178" "sbotools 0.2 fnord" dawnrazor.net +.TH sbotools.conf 5 "Prickle-Prickle, the 61st day of Discord in the YOLD 3178" "sbotools 0.3 fnord" dawnrazor.net .SH NAME .P sbotools.conf - configuration file for sbotools commands. @@ -8,15 +8,21 @@ This file, location at /etc/sbotools/sbotools.conf, contains key=value configura .P The current configuration keys are as follows: .P -NOCLEAN=(TRUE|FALSE) +DISTCLEAN=(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. 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). +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 -DISTCLEAN=(TRUE|FALSE) +JOBS=(#|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. Setting this option to TRUE causes the source code to be removed by default. This can be overridden when running sboupgrade(1)/sboinstall(1). +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 +NOCLEAN=(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. 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 PKG_DIR=(/path|FALSE) .RS |