mirrors/sbopkg
2
0
Fork 0
mirror of https://github.com/sbopkg/sbopkg synced 2024-11-09 19:50:25 +03:00
Code Issues Packages Projects Releases Wiki Activity

Reorder options in sbopkg.conf(5)

Browse Source 
Despite the huge diff, nothing was changed but alphabetizing the
options.
This commit is contained in:
slakmagik 2010-06-02 23:05:09 +00:00
parent 1e0fe22e0a
commit 123b3799bc
1 changed files with 170 additions and 170 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

340
src/usr/man/man5/sbopkg.conf.5
View File

@ -18,130 +18,6 @@ Boolean options are case-insensitive.
The different configuration options are:
.\"---------------------------------------------------------------------
.TP 3
.B REPO_NAME
This option allows the user to choose the repository to use.
The default options are SBo, SB64 and local.
The 'local' choice corresponds to a user-maintained repository whose
structure must be the same as the one used by SlackBuilds.org, in the
sense of a category/package/files hierarchy.
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 assignment is:
.IP
\fCREPO_NAME=${REPO_NAME:-SBo}\fP
.\"---------------------------------------------------------------------
.TP
.B REPO_BRANCH
This option allows the user to set the default active repository branch.
The current options are listed in the default repos.d/* files and can
also be listed by issuing 'sbopkg -V ?'.
.IP
The default assignment is:
.IP
\fCREPO_BRANCH=${REPO_BRANCH:-13.1}\fP
.\"---------------------------------------------------------------------
.TP
.B REPO_ROOT
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 about 70MB.
.IP
The default assignment is:
.IP
\fCREPO_ROOT=${REPO_ROOT:-/var/lib/sbopkg}\fP
.\"---------------------------------------------------------------------
.TP
.B SRCDIR
This option contains the location of the cache directory where source
downloads will be saved.
.IP
The default assignment is:
.IP
\fCSRCDIR=${SRCDIR:-/var/cache/sbopkg}\fP
.\"---------------------------------------------------------------------
.TP
.B SBOPKGTMP
This option sets the default directory where certain working files are
saved on a temporary basis.
.IP
The default assignment is:
.IP
\fCSBOPKGTMP=${SBOPKGTMP:-/tmp/sbopkg}\fP
.\"---------------------------------------------------------------------
.TP
.B TMP
This option sets the default directory where built packages should be
stored.
TMP must be exported as it is used by the SlackBuilds.
Note that the default value of TMP is the same as in the SBo SlackBuild
scripts.
.IP
Also note that if the CLEANUP variable is set to YES, any custom TMP
setting is ignored.
.IP
The default assignment is:
.IP
\fCexport TMP=${TMP:-/tmp/SBo}\fP
.\"---------------------------------------------------------------------
.TP
.B OUTPUT
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 assignment is:
.IP
\fCexport OUTPUT=${OUTPUT:-/tmp}\fP
.\"---------------------------------------------------------------------
.TP
.B QUEUEDIR
This option defines the directory under which saved queue files will be
kept.
.IP
The default assignment is:
.IP
\fCQUEUEDIR=${QUEUEDIR:-/var/lib/sbopkg/queues}\fP
.\"---------------------------------------------------------------------
.TP
.B KEEPLOG
This option should be set to YES or NO.
This option allows the user 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 assignment is:
.IP
\fCKEEPLOG=YES\fP
.\"---------------------------------------------------------------------
.TP
.B LOGDIR
This option sets the location for the sbopkg permanent log if KEEPLOG is
set to YES.
.IP
The default assignment is:
.IP
\fCLOGDIR=${LOGDIR:-/var/log/sbopkg}\fP
.\"---------------------------------------------------------------------
.TP
.B CLEANUP
This option should be set to YES or NO.
When set to YES, the unpacked source files and package tree in $TMP are
deleted right after the build, though the downloaded source archive and
completed package are left in $SRCDIR and $OUTPUT.
.IP
A side effect of setting CLEANUP to YES is that TMP is set to an
internal value and any other TMP setting is ignored.
.IP
The default assignment is:
.IP
\fCCLEANUP=NO\fP
.\"---------------------------------------------------------------------
.TP
.B ALLOW_MULTI
This option should be set to YES or NO.
When set to YES, this option allows the user to run multiple instances
@ -186,6 +62,20 @@ The default assignment is:
\fCALLOW_MULTI=NO\fP
.\"---------------------------------------------------------------------
.TP
.B CLEANUP
This option should be set to YES or NO.
When set to YES, the unpacked source files and package tree in $TMP are
deleted right after the build, though the downloaded source archive and
completed package are left in $SRCDIR and $OUTPUT.
.IP
A side effect of setting CLEANUP to YES is that TMP is set to an
internal value and any other TMP setting is ignored.
.IP
The default assignment is:
.IP
\fCCLEANUP=NO\fP
.\"---------------------------------------------------------------------
.TP
.B DEBUG
This option should be set to 0, 1, or 2.
DEBUG sets the default debugging level for the update list feature of
@ -203,52 +93,6 @@ The default assignment is:
\fCDEBUG=0\fP
.\"---------------------------------------------------------------------
.TP
.B MKDIR_PROMPT
This option may be set to YES or NO.
When set to YES, sbopkg will prompt for confirmation before changing the
filesystem by creating its 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 assignment is:
.IP
\fCMKDIR_PROMPT=YES\fP
.\"---------------------------------------------------------------------
.TP
.B RSYNCFLAGS
Rsync is used by sbopkg to mirror the SlackBuilds.org repository.
This option allows the user to manually tweak the rsync flags (options)
that are used by sbopkg.
Users are cautioned against making any changes to the default values
since new flags may or may not work.
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 assignment is:
.IP
\fCRSYNCFLAGS="--verbose --timeout=10"\fP
.\"---------------------------------------------------------------------
.TP
.B WGETFLAGS
Wget is used by sbopkg to download the source files for package
building.
This option allows the user to manually tweak the wget flags (options)
that are used by sbopkg.
Users are cautioned against 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 assignment is:
.IP
\fCWGETFLAGS="--continue --progress=bar:force --timeout=15 --tries=5"\fP
.\"---------------------------------------------------------------------
.TP
.B DIFF
This option allows the user to set which diff program to use when sbopkg
displays differences between edited files.
@ -265,6 +109,162 @@ program when sbopkg displays differences between edited files.
The default assignment is:
.IP
\fCDIFFOPTS=${DIFFOPTS:--u}\fP
.\"---------------------------------------------------------------------
.TP
.B KEEPLOG
This option should be set to YES or NO.
This option allows the user 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 assignment is:
.IP
\fCKEEPLOG=YES\fP
.\"---------------------------------------------------------------------
.TP
.B LOGDIR
This option sets the location for the sbopkg permanent log if KEEPLOG is
set to YES.
.IP
The default assignment is:
.IP
\fCLOGDIR=${LOGDIR:-/var/log/sbopkg}\fP
.\"---------------------------------------------------------------------
.TP
.B MKDIR_PROMPT
This option may be set to YES or NO.
When set to YES, sbopkg will prompt for confirmation before changing the
filesystem by creating its 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 assignment is:
.IP
\fCMKDIR_PROMPT=YES\fP
.\"---------------------------------------------------------------------
.TP
.B OUTPUT
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 assignment is:
.IP
\fCexport OUTPUT=${OUTPUT:-/tmp}\fP
.\"---------------------------------------------------------------------
.TP
.B QUEUEDIR
This option defines the directory under which saved queue files will be
kept.
.IP
The default assignment is:
.IP
\fCQUEUEDIR=${QUEUEDIR:-/var/lib/sbopkg/queues}\fP
.\"---------------------------------------------------------------------
.TP
.B REPO_BRANCH
This option allows the user to set the default active repository branch.
The current options are listed in the default repos.d/* files and can
also be listed by issuing 'sbopkg -V ?'.
.IP
The default assignment is:
.IP
\fCREPO_BRANCH=${REPO_BRANCH:-13.1}\fP
.\"---------------------------------------------------------------------
.TP
.B REPO_NAME
This option allows the user to choose the repository to use.
The default options are SBo, SB64 and local.
The 'local' choice corresponds to a user-maintained repository whose
structure must be the same as the one used by SlackBuilds.org, in the
sense of a category/package/files hierarchy.
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 assignment is:
.IP
\fCREPO_NAME=${REPO_NAME:-SBo}\fP
.\"---------------------------------------------------------------------
.TP
.B REPO_ROOT
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 about 70MB.
.IP
The default assignment is:
.IP
\fCREPO_ROOT=${REPO_ROOT:-/var/lib/sbopkg}\fP
.\"---------------------------------------------------------------------
.TP
.B RSYNCFLAGS
Rsync is used by sbopkg to mirror the SlackBuilds.org repository.
This option allows the user to manually tweak the rsync flags (options)
that are used by sbopkg.
Users are cautioned against making any changes to the default values
since new flags may or may not work.
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 assignment is:
.IP
\fCRSYNCFLAGS="--verbose --timeout=10"\fP
.\"---------------------------------------------------------------------
.TP
.B SBOPKGTMP
This option sets the default directory where certain working files are
saved on a temporary basis.
.IP
The default assignment is:
.IP
\fCSBOPKGTMP=${SBOPKGTMP:-/tmp/sbopkg}\fP
.\"---------------------------------------------------------------------
.TP
.B SRCDIR
This option contains the location of the cache directory where source
downloads will be saved.
.IP
The default assignment is:
.IP
\fCSRCDIR=${SRCDIR:-/var/cache/sbopkg}\fP
.\"---------------------------------------------------------------------
.TP
.B TMP
This option sets the default directory where built packages should be
stored.
TMP must be exported as it is used by the SlackBuilds.
Note that the default value of TMP is the same as in the SBo SlackBuild
scripts.
.IP
Also note that if the CLEANUP variable is set to YES, any custom TMP
setting is ignored.
.IP
The default assignment is:
.IP
\fCexport TMP=${TMP:-/tmp/SBo}\fP
.\"---------------------------------------------------------------------
.TP
.B WGETFLAGS
Wget is used by sbopkg to download the source files for package
building.
This option allows the user to manually tweak the wget flags (options)
that are used by sbopkg.
Users are cautioned against 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 assignment is:
.IP
\fCWGETFLAGS="--continue --progress=bar:force --timeout=15 --tries=5"\fP
.\"=====================================================================
.SH NOTES
.\"---------------------------------------------------------------------