Content-type: text/html Manpage of SBOPKG.CONF

SBOPKG.CONF

Section: (5)
Updated: May 2010
Index Return to Main Contents

NAME

sbopkg.conf - Configuration file for sbopkg

DESCRIPTION

The sbopkg.conf file contains configuration settings for sbopkg (8), a tool for interacting with the SlackBuilds.org ("SBo") 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.

Boolean options are case-insensitive.

The different configuration options are:

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. 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.

The default value of REPO_NAME is:
REPO_NAME=${REPO_NAME:-SBo}.

REPO_BRANCH

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.

The default value of REPO_BRANCH is:
REPO_BRANCH=${REPO_BRANCH:-13.1}.

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 less than 50MB.

The default value of REPO_ROOT is:
REPO_ROOT=${REPO_ROOT:-/var/lib/sbopkg}.

SRCDIR

This option contains the location of the cache directory where source downloads will be saved.

The default value of SRCDIR is:
SRCDIR=${SRCDIR:-/var/cache/sbopkg}.

SBOPKGTMP

This option sets the default directory where certain working files are saved on a temporary basis.

The default value of SBOPKGTMP is:
SBOPKGTMP=${SBOPKGTMP:-/tmp/sbopkg}.

TMP

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.

The default value of TMP is:
export TMP=${TMP:-/tmp/SBo}.

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.

The default value of OUTPUT is:
export OUTPUT=${OUTPUT:-/tmp}.

QUEUEDIR

This option defines the directory under which saved queue files will be kept.

The default value of QUEUEDIR is:
QUEUEDIR=${QUEUEDIR:-/var/lib/sbopkg/queues}.

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.

The default value of KEEPLOG is: YES.

LOGDIR

This option sets the location for the sbopkg permanent log if KEEPLOG is set to YES (see previous paragraph).

The default value of LOGDIR is:
LOGDIR=${LOGDIR:-/var/log/sbopkg}.

CLEANUP

This option should be set to YES or NO. When set to YES, the source 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.

The default value of CLEANUP is: NO.

ALLOW_MULTI

When set to YES, this option allows the user to run multiple instances of sbopkg.

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.

For reference, these are some of the things you shouldn't do with this option enabled:

[bu]: run an ALLOW_MULTI=NO instance together with one or more having ALLOW_MULTI=YES
[bu]: sync a repository when another instance is using it
[bu]: change the branch of a git repository when another instance is using it (you can do this with rsync -- i.e. SlackBuild.org -- repos)
[bu]: simultaneously build or install the same package from different instances
[bu]: save a queue file while using it from another instance

: There can be more unsafe situations we haven't thought about. Take care.

DEBUG

This option should be set to 0, 1, or 2. DEBUG sets the default debugging level for the update list feature of sbopkg. When DEBUG is set to 0, then only potential updated (or downgraded) packages are listed. 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.

The default value of DEBUG is: 0.

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.

The default value of MKDIR_PROMPT is: YES.

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.

The default value of RSYNCFLAGS is: "--timeout=10 --verbose".

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.

The default value of WGETFLAGS is:
"--continue --progress-bar:force --timeout=15 --tries=5".

DIFF

This option allows the user to set which diff program to use when sbopkg displays differences between edited files.

The default value of DIFF is:
DIFF=${DIFF:-diff}.

DIFFOPTS

This option allows the user to set which options are used by the $DIFF program when sbopkg displays differences between edited files.

The default value of DIFFOPTS is:

DIFFOPTS=${DIFFOPTS:--u}

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:

export TMP=${TMP:-/tmp/SBo}

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:

export TMP=${TMP:-/home/sbo/tmp}

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.

Please note that if the CLEANUP variable is set to YES, the TMP setting is ignored.

You can also export variables in sbopkg.conf that are not used by sbopkg at all.

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 is not set, sbopkg does some checking (using 'uname -m') to determine what the system's architecture is. If the architecture is x86, x86_64, or arm*, then sbopkg automatically sets ARCH to i486, x86_64, or arm, respectively. If ARCH is set, sbopkg will inherit that setting. This means the user can add, for example, 'export ARCH=i686' in their .bashrc or similar file, or the user can also execute something in the root terminal like 'export ARCH=i686 && sbopkg'. The user can also manually add it to their sbopkg.conf file if they wish. 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.

FILES

/etc/sbopkg/sbopkg.conf - File to specify configuration options.

/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.

/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.

This document was created by man2html, using the manual pages.
Time: 18:31:58 GMT, May 27, 2010