Replaced blank lines in manpages with .PP/.IP tags

In one instance, inserted a .br instead and, in another, replaced an
.RS/.RE with an .IP.
This commit is contained in:
slakmagik 2010-06-02 23:04:08 +00:00
parent 05fab96338
commit af42f83892
3 changed files with 57 additions and 107 deletions

View File

@ -239,3 +239,5 @@ Manual Page Style Guidelines
* Separate all text header and section header requests with commented lines of
equal (=) signs. Separate all tagged paragraphs that serve as subsections
with commented lines of minus (-) signs.
* Leave no blank lines in the file. E.g., .PP will often serve under .SH and
.IP under .TP.

View File

@ -4,10 +4,8 @@
.SH NAME
.B sbopkg.conf
\- Configuration file for sbopkg
.\"=====================================================================
.SH DESCRIPTION
The sbopkg.conf file contains configuration settings for
.B sbopkg
(8), a tool for interacting with the SlackBuilds.org ("SBo")
@ -15,11 +13,10 @@ repository, a collection of third-party SlackBuild scripts to build
Slackware packages. A sample file is provided at
/etc/sbopkg/sbopkg.conf.new. Also, please see a note below about
$ARCH.
.PP
Boolean options are case-insensitive.
.PP
The different configuration options are:
.\"---------------------------------------------------------------------
.TP 5
.B REPO_NAME
@ -31,11 +28,10 @@ structure must be the same as the one used by SlackBuilds.org. NOTE:
all of the REPO_* variables are affected by the repository files
maintained in /etc/sbopkg/repos.d. Please see the README-repos.d
document in the sbopkg /doc directory.
.IP
The default value of REPO_NAME is:
.br
REPO_NAME=${REPO_NAME:-SBo}.
.\"---------------------------------------------------------------------
.TP 5
.B REPO_BRANCH
@ -44,11 +40,10 @@ This option allows the user to set the default active repository
branch. The current options are 11.0, 12.0, 12.1, 12.2, 13.0, and
13.1 for the SBo repository and local for the local repository. The
Slamd64Builds repository is 'master' but is not officially supported.
.IP
The default value of REPO_BRANCH is:
.br
REPO_BRANCH=${REPO_BRANCH:-13.1}.
.\"---------------------------------------------------------------------
.TP 5
.B REPO_ROOT
@ -56,33 +51,30 @@ REPO_BRANCH=${REPO_BRANCH:-13.1}.
This option allows the user to set the location of the local
mirrors of the remote repositories. Currently, the size of a local copy of
the SBo repository is less than 50MB.
.IP
The default value of REPO_ROOT is:
.br
REPO_ROOT=${REPO_ROOT:-/var/lib/sbopkg}.
.\"---------------------------------------------------------------------
.TP 5
.B SRCDIR
.br
This option contains the location of the cache directory where
source downloads will be saved.
.IP
The default value of SRCDIR is:
.br
SRCDIR=${SRCDIR:-/var/cache/sbopkg}.
.\"---------------------------------------------------------------------
.TP 5
.B SBOPKGTMP
.br
This option sets the default directory where certain working
files are saved on a temporary basis.
.IP
The default value of SBOPKGTMP is:
.br
SBOPKGTMP=${SBOPKGTMP:-/tmp/sbopkg}.
.\"---------------------------------------------------------------------
.TP 5
.B TMP
@ -90,11 +82,10 @@ SBOPKGTMP=${SBOPKGTMP:-/tmp/sbopkg}.
This option sets the default directory where built packages should be stored.
TMP must be exported as it is used by the SlackBuilds. Also note that the
default value of TMP is the same as in the SBo SlackBuild scripts.
.IP
The default value of TMP is:
.br
export TMP=${TMP:-/tmp/SBo}.
.\"---------------------------------------------------------------------
.TP 5
.B OUTPUT
@ -103,22 +94,20 @@ This option sets the default directory where compiled packages are
saved. OUTPUT must be exported as it is also used by the SBo
SlackBuilds. Also note that the default value of OUTPUT is therefore
the same as in the SBo SlackBuilds.
.IP
The default value of OUTPUT is:
.br
export OUTPUT=${OUTPUT:-/tmp}.
.\"---------------------------------------------------------------------
.TP 5
.B QUEUEDIR
.br
This option defines the directory under which saved queue files will
be kept.
.IP
The default value of QUEUEDIR is:
.br
QUEUEDIR=${QUEUEDIR:-/var/lib/sbopkg/queues}.
.\"---------------------------------------------------------------------
.TP 5
.B KEEPLOG
@ -128,20 +117,18 @@ to choose whether to keep a permanent log of packages that are built
with sbopkg in order to go back and review the build, and any errors,
after exiting sbopkg. If set to YES, this permanent log is saved at
$LOGDIR/sbopkg-build-log.
.IP
The default value of KEEPLOG is: YES.
.\"---------------------------------------------------------------------
.TP 5
.B LOGDIR
.br
This option sets the location for the sbopkg permanent log if KEEPLOG
is set to YES (see previous paragraph).
.IP
The default value of LOGDIR is:
.br
LOGDIR=${LOGDIR:-/var/log/sbopkg}.
.\"---------------------------------------------------------------------
.TP 5
.B CLEANUP
@ -151,23 +138,22 @@ files and the various residuals from the process of building a package
are deleted right after the build.
A side effect of setting CLEANUP to YES is that the TMP setting got
from the environment or from the configuration files is ignored.
.IP
The default value of CLEANUP is: NO.
.\"---------------------------------------------------------------------
.TP 5
.B ALLOW_MULTI
.br
When set to YES, this option allows the user to run multiple instances
of sbopkg.
.IP
Please understand that this option is provided for convenience, but
given the number of potential issues you can face when enabling this
(and we aren't going to try to work around users doing silly things),
you should consider working with ALLOW_MULTI=YES as an EXPERIMENTAL
UNSUPPORTED feature. If you encounter problems, please try to make sure
these aren't caused by yourself doing improper things.
.IP
For reference, these are some of the things you shouldn't do with this
option enabled:
.RS 6
@ -184,11 +170,8 @@ simultaneously build or install the same package from different instances
.IP \[bu]
save a queue file while using it from another instance
.RE
.RS 5
.IP
There can be more unsafe situations we haven't thought about. Take care.
.RE
.\"---------------------------------------------------------------------
.TP 5
.B DEBUG
@ -200,9 +183,8 @@ When DEBUG is set to 1, then potential updates plus packages not in the
repo and packages that are newer than the repo are listed. When DEBUG is
set to 2, all non-updated packages are also listed. Changing DEBUG to 1 or
2 may be helpful if it appears the updatelist might be missing an update.
.IP
The default value of DEBUG is: 0.
.\"---------------------------------------------------------------------
.TP 5
.B MKDIR_PROMPT
@ -213,9 +195,8 @@ directories. If you do not wish to be prompted (for instance, if you
have some of the directories on a temporary filesystem and don't wish to
be prompted for confirmation each time the filesystem is reinitialized)
you can set this to NO.
.IP
The default value of MKDIR_PROMPT is: YES.
.\"---------------------------------------------------------------------
.TP 5
.B RSYNCFLAGS
@ -228,9 +209,8 @@ Note: the rsync command in sbopkg already uses the --archive,
--delete, --no-owner, and --exclude flags, so there is no need to add
them to the RSYNCFLAGS option. Changing these default options is not
recommended.
.IP
The default value of RSYNCFLAGS is: "--timeout=10 --verbose".
.\"---------------------------------------------------------------------
.TP 5
.B WGETFLAGS
@ -242,59 +222,55 @@ making any changes to the default values since new flags may or may
not work. Note: the wget command in sbopkg already uses the -O flag,
so there is no need to add that to the WGETFLAGS option. Changing
these default options is not recommended.
.IP
The default value of WGETFLAGS is:
.br
"--continue --progress-bar:force --timeout=15 --tries=5".
.\"---------------------------------------------------------------------
.TP 5
.B DIFF
.br
This option allows the user to set which diff program to use when
sbopkg displays differences between edited files.
.IP
The default value of DIFF is:
.br
DIFF=${DIFF:-diff}.
.\"---------------------------------------------------------------------
.TP 5
.B DIFFOPTS
.br
This option allows the user to set which options are used by the $DIFF
program when sbopkg displays differences between edited files.
.IP
The default value of DIFFOPTS is:
.br
DIFFOPTS=${DIFFOPTS:--u}
.\"=====================================================================
.SH OVERRIDING ENVIRONMENTAL VARIABLES
It is possible to set or override environmental variables and pass
them to the SlackBuild scripts when they are built from within sbopkg.
This is already demonstrated in the following line in the sbopkg.conf
file:
.PP
export TMP=${TMP:-/tmp/SBo}
.PP
This sets $TMP to /tmp/SBo for building SBo packages within sbopkg (which is
currently the default for SBo SlackBuilds already). Since this variable is
exported, it could be changed for both sbopkg and for building SBo
packages within sbopkg. For example, changing this line so it reads:
.PP
export TMP=${TMP:-/home/sbo/tmp}
.PP
would then set $TMP to /home/sbo/tmp for building SBo
packages. OUTPUT can also be changed to save compiled packages in a
location other than the default of /tmp.
.PP
Please note that if the CLEANUP variable is set to YES, the TMP setting
is ignored.
.PP
You can also export variables in sbopkg.conf that are not used by
sbopkg at all.
.\"=====================================================================
.SH ABOUT THE ARCH VARIABLE
You may be wondering why ARCH is not a configuration setting in the
@ -310,21 +286,19 @@ Finally, if ARCH is not set by the user and sbopkg does not detect one of the
previously mentioned architectures, then ARCH will be set by whatever is in
the SlackBuild scripts. Note that the SlackBuild may, in certain instances,
discard or override previous ARCH settings if this is required for the build.
.\"=====================================================================
.SH FILES
.B /etc/sbopkg/sbopkg.conf
\ - File to specify configuration options.
.PP
.B /etc/sbopkg/renames.d/50-default
\ - Default file that lists software in SBo repository that has been renamed.
See the README-renames.d document in the sbopkg doc/ directory for more
information.
.PP
.B /etc/sbopkg/repos.d/{40-sbo.repo,50-sb64.repo,60-local.repo}
\ - Three default files for various types of sbopkg repositories. See the
README-repos.d document in the sbopkg doc/ directory for more information.
.\"=====================================================================
.SH "SEE ALSO"
.BR sbopkg (8)

View File

@ -4,18 +4,15 @@
.SH NAME
.B sbopkg
\ - The SlackBuilds.org Package Browser
.\"=====================================================================
.SH SYNOPSIS
.B sbopkg
.B [options]
.\"=====================================================================
.SH DESCRIPTION
Sbopkg is a command-line and dialog-based tool to interact with the
SlackBuilds.org ("SBo") repository, a collection of third-party
SlackBuild scripts to build Slackware packages.
.\"=====================================================================
.SH INSTRUCTIONS
Sbopkg usage assumes an understanding of SlackBuild scripts,
@ -23,13 +20,13 @@ generally, and the third-party repository SlackBuilds.org,
specifically. A thorough reading of http://www.slackbuilds.org/howto/
and the pages at http://www.slackwiki.org about SlackBuild scripts is
strongly advised.
.PP
Before sbopkg can be used, a configuration file must be created at
/etc/sbopkg/sbopkg.conf. A sample file is provided at
/etc/sbopkg/sbopkg.conf.new. See
.B sbopkg.conf
(5) for more information about the configuration file.
.PP
Sbopkg can be run from the command line by simply invoking "sbopkg."
Sbopkg must be run as the root user (since the SlackBuild scripts at
SlackBuilds.org are written with the intention of being run as root).
@ -63,11 +60,11 @@ automatically build or build and install individual packages or
several packages in a build queue. Finally, if KEEPLOG is set to YES
in the sbopkg.conf file then a permanent log of the build process is
saved in /tmp/sbopkg-build-log.
.PP
Alternatively, sbopkg can be run from the command line without using
the dialog interface. Executing "sbopkg -h" will display a list of
options available from the command line.
.PP
Sbopkg also has the capability of loading, saving, and using
user-created queuefiles. These queuefiles are simple text files with
one application name per line. By default, when a queuefile is loaded
@ -76,7 +73,7 @@ can be changed by inserting a "-" in front of the application name in
the queuefile. Also, queuefiles can reference other queuefiles when
the first character is a "@". See the readme-queuefiles document in
the doc/ directory for more information.
.PP
Certain features of sbopkg rely on outside binaries, such as a pager
to view the text files when sbopkg is run from the comamnd line, and
an editor to edit the .info or SlackBuild files. The pager function
@ -87,7 +84,6 @@ to $EDITOR and will default to 'vi' if no $EDITOR has been defined.
If the user wants sbopkg to use another $EDITOR, such as nano, then
adding the requisite information in ~/.bashrc, /etc/profile, or other
similar configuration file to export $EDITOR will suffice.
.\"=====================================================================
.SH OPTIONS
.\"---------------------------------------------------------------------
@ -95,9 +91,9 @@ similar configuration file to export $EDITOR will suffice.
.B -b PACKAGE(s)/QUEUE(s)
Search for and build PACKAGE(s) from the local SBo repository. If more
than one package is specified, they must be in quotes. For example:
.IP
#sbopkg -b "foo bar"
.IP
will build foo and then bar.
Queuefile names can also be specified. In that case, all the packages
specified in the queuefile will be built. In the unfortunate case a
@ -108,58 +104,51 @@ are processed in the order they are specified on the command line, and
the build order specified in the queuefiles is retained. If a package
is specified more than once, it gets queued only the first time it is
encountered.
.\"---------------------------------------------------------------------
.TP 5
.B -c
Display list of installed SBo packages and potential updates.
.\"---------------------------------------------------------------------
.TP 5
.B -d DIRECTORY
Manually specify the full path to the DIRECTORY containing the
local SBo repository.
.\"---------------------------------------------------------------------
.TP 5
.B -e ask|continue|stop
Specify what sbopkg should do when it encounters an error while building a
package. Valid options are:
.IP
.B ask
: This is the default behavior, asking the user what to do;
.IP
.B continue
: Ignore the error and continue processing (act as if the user
answered "Yes" to all questions);
.IP
.B stop
: Stop the processing (act as if the user answered "No" to all
questions).
.\"---------------------------------------------------------------------
.TP 5
.B -f
Override the default configuration file, which is located by
default at /etc/sbopkg/sbopkg.conf, with another configuration
file.
.\"---------------------------------------------------------------------
.TP 5
.B -g PACKAGE(s)
General search for PACKAGE(s) by glob. For example:
.IP
#sbopkg -g nv
.IP
will return a list of matches, such as the nvidia packages,
konversation, and other packages with 'nv' in their name. If more
than one glob is specified, they must be in quotes.
.\"---------------------------------------------------------------------
.TP 5
.B -h
Display the help.
.\"---------------------------------------------------------------------
.TP 5
.B -i PACKAGE(s)
@ -167,9 +156,9 @@ Search for and build and then install PACKAGE(s) from the local SBo
repository. If more than one package is specified, they must be in
quotes, and the packages will be built and then installed in the
listed order. For example:
.IP
#sbopkg -i "foo bar"
.IP
will build and install foo and then build and install bar. By
carefully considering the order of the packages listed, the user may
be able to build and install dependencies in the right order before
@ -177,68 +166,59 @@ the final application is built and installed. Of course, given the
nature of dependencies, this may not always be possible and so
building dependencies like this is not really a supported feature.
Still, when when it works, it can be helpful.
.IP
Queuefile names are supported, too. See the explanation for the '-b'
command for details.
.\"---------------------------------------------------------------------
.TP 5
.B -k
When used together with -b or -i, this option tells sbopkg to skip
(i.e. don't build) any package it finds to be already installed.
.IP
Please note that only a name comparison is performed, so when this
option is specified sbopkg will also omit the build of different
versions of installed packages.
.\"---------------------------------------------------------------------
.TP 5
.B -l
Display the SBo ChangeLog.txt and quit.
.\"---------------------------------------------------------------------
.TP 5
.B -o
List the currently installed cached source files which are deemed as
obsolete, and optionally delete them.
.IP
Source files are obsolete when no SBo script references it any more,
which is something that can happen after rsync-ing the local
repository.
.IP
Please note that only the currently active repository is
used to identify the obsoleted sources, so if you build packages with
different repositories (e.g. for different Slackware versions) the
source files only used in the "other" repository will be listed.
.\"---------------------------------------------------------------------
.TP 5
.B -P
List the cached package files which are not currently installed on the
system and optionally delete them.
.\"---------------------------------------------------------------------
.TP 5
.B -p
List installed SlackBuilds.org packages.
.\"---------------------------------------------------------------------
.TP 5
.B -q
Enable the "quiet mode." When this flag is specified, the output of
some of the command-line options is minimized.
.\"---------------------------------------------------------------------
.TP 5
.B -r
Rsync the local repository with SlackBuilds.org and quit.
.\"---------------------------------------------------------------------
.TP 5
.B -R
Show all the README files of the queued packages before starting the build.
This is useful when you want to make a final check.
.\"---------------------------------------------------------------------
.TP 5
.B -s PACKAGE(s)
@ -246,51 +226,46 @@ Specific search for PACKAGE(s) by PACKAGE name and, if found, display
the README, SlackBuild, .info, and slack-desc files in that order
using $PAGER, which defaults to 'more' as described above. If more
than one package is specified, they must be in quotes. For example:
.IP
#sbopkg -s "foo bar"
.IP
will search for foo and then bar.
.\"---------------------------------------------------------------------
.TP 5
.B -u
Check for an update to sbopkg itself and then quit.
.\"---------------------------------------------------------------------
.TP 5
.B -V REPO/BRANCH
Set the repository and branch to use.
.IP
For a list of valid versions, invoke sbopkg as
.BR "sbopkg -V ?" .
See the
.B sbopkg.conf (5)
man page for more information about the 'local' repository.
.IP
The VERSION format is repository/branch (e.g. SBo/13.1). If the repository is
omitted, sbopkg will first look for the specified branch in the default
repository. If that attempt fails, sbopkg will look for the first matching
branch in any repository.
.\"---------------------------------------------------------------------
.TP 5
.B -v
Prints the current version of sbopkg on stdout.
.\"=====================================================================
.SH FILES
.B /etc/sbopkg/sbopkg.conf
\ - File to specify configuration options.
.PP
.B /etc/sbopkg/renames.d/50-default
\ - Default file that lists software in SBo repository that has been renamed.
See the README-renames.d document in the sbopkg doc/ directory for more
information.
.PP
.B /etc/sbopkg/repos.d/{40-sbo.repo,50-sb64.repo,60-local.repo}
\ - Three default files for various types of sbopkg repositories. See the
README-repos.d document in the sbopkg doc/ directory for more information.
.\"=====================================================================
.SH "SEE ALSO"
.BR sbopkg.conf (5)
@ -299,7 +274,6 @@ README-repos.d document in the sbopkg doc/ directory for more information.
.BR doc/README-renames.d
.BR doc/README-repos.d
.BR doc/queuefiles/*
.\"=====================================================================
.SH AUTHOR
Chess Griffin