mirror of
https://github.com/sbopkg/sbopkg
synced 2025-01-13 20:01:13 +01:00
Added commented dividers to man pages
Also added a man page style guide section to HACKING and added a point reflecting this change.
This commit is contained in:
slakmagik
parent
1de589ca1a
commit
05fab96338
3 changed files with 63 additions and 0 deletions
|
|
@ -231,3 +231,11 @@ Please make sure your patches conform to these stylistic points:
|
|||
sure that they work across bash 3.1, 3.2, and 4.0. This means the regexes
|
||||
must be unquoted for bash >=3.2 and still work in bash 3.1 (i.e., no
|
||||
'foo|bar' expressions).
|
||||
|
||||
----------------------------
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,11 @@
|
|||
.\"=====================================================================
|
||||
.TH SBOPKG.CONF 5 "May 2010" sbopkg-SVN ""
|
||||
.\"=====================================================================
|
||||
.SH NAME
|
||||
.B sbopkg.conf
|
||||
\- Configuration file for sbopkg
|
||||
|
||||
.\"=====================================================================
|
||||
.SH DESCRIPTION
|
||||
|
||||
The sbopkg.conf file contains configuration settings for
|
||||
|
|
@ -17,6 +20,7 @@ Boolean options are case-insensitive.
|
|||
|
||||
The different configuration options are:
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B REPO_NAME
|
||||
.br
|
||||
|
|
@ -32,6 +36,7 @@ The default value of REPO_NAME is:
|
|||
.br
|
||||
REPO_NAME=${REPO_NAME:-SBo}.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B REPO_BRANCH
|
||||
.br
|
||||
|
|
@ -44,6 +49,7 @@ The default value of REPO_BRANCH is:
|
|||
.br
|
||||
REPO_BRANCH=${REPO_BRANCH:-13.1}.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B REPO_ROOT
|
||||
.br
|
||||
|
|
@ -55,6 +61,7 @@ The default value of REPO_ROOT is:
|
|||
.br
|
||||
REPO_ROOT=${REPO_ROOT:-/var/lib/sbopkg}.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B SRCDIR
|
||||
.br
|
||||
|
|
@ -65,6 +72,7 @@ The default value of SRCDIR is:
|
|||
.br
|
||||
SRCDIR=${SRCDIR:-/var/cache/sbopkg}.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B SBOPKGTMP
|
||||
.br
|
||||
|
|
@ -75,6 +83,7 @@ The default value of SBOPKGTMP is:
|
|||
.br
|
||||
SBOPKGTMP=${SBOPKGTMP:-/tmp/sbopkg}.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B TMP
|
||||
.br
|
||||
|
|
@ -86,6 +95,7 @@ The default value of TMP is:
|
|||
.br
|
||||
export TMP=${TMP:-/tmp/SBo}.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B OUTPUT
|
||||
.br
|
||||
|
|
@ -98,6 +108,7 @@ The default value of OUTPUT is:
|
|||
.br
|
||||
export OUTPUT=${OUTPUT:-/tmp}.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B QUEUEDIR
|
||||
.br
|
||||
|
|
@ -108,6 +119,7 @@ The default value of QUEUEDIR is:
|
|||
.br
|
||||
QUEUEDIR=${QUEUEDIR:-/var/lib/sbopkg/queues}.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B KEEPLOG
|
||||
.br
|
||||
|
|
@ -119,6 +131,7 @@ $LOGDIR/sbopkg-build-log.
|
|||
|
||||
The default value of KEEPLOG is: YES.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B LOGDIR
|
||||
.br
|
||||
|
|
@ -129,6 +142,7 @@ The default value of LOGDIR is:
|
|||
.br
|
||||
LOGDIR=${LOGDIR:-/var/log/sbopkg}.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B CLEANUP
|
||||
.br
|
||||
|
|
@ -140,6 +154,7 @@ from the environment or from the configuration files is ignored.
|
|||
|
||||
The default value of CLEANUP is: NO.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B ALLOW_MULTI
|
||||
.br
|
||||
|
|
@ -174,6 +189,7 @@ save a queue file while using it from another instance
|
|||
There can be more unsafe situations we haven't thought about. Take care.
|
||||
.RE
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B DEBUG
|
||||
.br
|
||||
|
|
@ -187,6 +203,7 @@ set to 2, all non-updated packages are also listed. Changing DEBUG to 1 or
|
|||
|
||||
The default value of DEBUG is: 0.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B MKDIR_PROMPT
|
||||
.br
|
||||
|
|
@ -199,6 +216,7 @@ you can set this to NO.
|
|||
|
||||
The default value of MKDIR_PROMPT is: YES.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B RSYNCFLAGS
|
||||
.br
|
||||
|
|
@ -213,6 +231,7 @@ recommended.
|
|||
|
||||
The default value of RSYNCFLAGS is: "--timeout=10 --verbose".
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B WGETFLAGS
|
||||
.br
|
||||
|
|
@ -228,6 +247,7 @@ The default value of WGETFLAGS is:
|
|||
.br
|
||||
"--continue --progress-bar:force --timeout=15 --tries=5".
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B DIFF
|
||||
.br
|
||||
|
|
@ -238,6 +258,7 @@ The default value of DIFF is:
|
|||
.br
|
||||
DIFF=${DIFF:-diff}.
|
||||
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B DIFFOPTS
|
||||
.br
|
||||
|
|
@ -248,6 +269,7 @@ The default value of DIFFOPTS is:
|
|||
|
||||
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.
|
||||
|
|
@ -273,6 +295,7 @@ is ignored.
|
|||
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
|
||||
default sbopkg.conf file. The reason is that it does not have to be. If ARCH
|
||||
|
|
@ -288,6 +311,7 @@ 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.
|
||||
|
|
@ -301,6 +325,7 @@ information.
|
|||
\ - 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)
|
||||
.BR doc/README
|
||||
|
|
@ -308,3 +333,4 @@ 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/*
|
||||
.\" vim:set tw=72:
|
||||
|
|
|
|||
|
|
@ -1,17 +1,22 @@
|
|||
.\"=====================================================================
|
||||
.TH SBOPKG 8 "May 2010" sbopkg-SVN ""
|
||||
.\"=====================================================================
|
||||
.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,
|
||||
generally, and the third-party repository SlackBuilds.org,
|
||||
|
|
@ -83,7 +88,9 @@ 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
|
||||
.\"---------------------------------------------------------------------
|
||||
.TP 5
|
||||
.B -b PACKAGE(s)/QUEUE(s)
|
||||
Search for and build PACKAGE(s) from the local SBo repository. If more
|
||||
|
|
@ -102,15 +109,18 @@ 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
|
||||
|
|
@ -127,12 +137,14 @@ answered "Yes" to all questions);
|
|||
: 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:
|
||||
|
|
@ -143,10 +155,12 @@ 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)
|
||||
Search for and build and then install PACKAGE(s) from the local SBo
|
||||
|
|
@ -167,6 +181,7 @@ Still, when when it works, it can be helpful.
|
|||
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
|
||||
|
|
@ -176,10 +191,12 @@ 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
|
||||
|
|
@ -194,29 +211,35 @@ 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)
|
||||
Specific search for PACKAGE(s) by PACKAGE name and, if found, display
|
||||
|
|
@ -228,10 +251,12 @@ than one package is specified, they must be in quotes. For example:
|
|||
|
||||
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.
|
||||
|
|
@ -247,10 +272,12 @@ 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.
|
||||
|
|
@ -264,6 +291,7 @@ information.
|
|||
\ - 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)
|
||||
.BR doc/README
|
||||
|
|
@ -272,6 +300,7 @@ README-repos.d document in the sbopkg doc/ directory for more information.
|
|||
.BR doc/README-repos.d
|
||||
.BR doc/queuefiles/*
|
||||
|
||||
.\"=====================================================================
|
||||
.SH AUTHOR
|
||||
Chess Griffin
|
||||
<chess@chessgriffin.com>
|
||||
|
|
|
|||
Loading…
Reference in a new issue