SBOPKG.CONF(5)

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. The default configuration file is installed at /etc/sbopkg/sbopkg.conf. The user may override any settings in that file by creating ~/.sbopkg.conf.

Please see the NOTES section for more information about variables, including ARCH.

All boolean options require a YES or a NO without regard to case. All path values must be full.

The default configuration options are:

ALLOW_MULTI
    Boolean.

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

    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 this 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:

    •   run instances with a mixture of YES and NO settings

    •   sync a repository when another instance is using it

    •   change the branch of a git repository when another instance is using it (this caveat does not apply to rsync repositories)

    •   simultaneously process the same package from different instances

    •   save a queue file while using it from another instance

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

    The default assignment is:

    xxxALLOW_MULTIxxx

CLEANUP
    Boolean.

    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.

    A side effect of setting CLEANUP to YES is that TMP is set to sbopkg's own temporary directory ($TMPDIR/sbopkg.RANDOM_STRING) and any other TMP setting is ignored.

    The default assignment is:

    xxxCLEANUPxxx

DEBUG_UPDATES
    Enumeration.

    This option should be set to 0, 1, or 2. DEBUG_UPDATES sets the default debugging level for the update list feature of sbopkg. When set to 0, only potential updated (or downgraded) packages are listed. When set to 1, potential updates plus packages not in the repo and packages that are newer than the repo are listed. When set to 2, all non-updated packages are also listed. Changing DEBUG_UPDATES to 1 or 2 may be helpful if it appears the updatelist might be missing an update.

    The default assignment is:

    xxxDEBUG_UPDATESxxx

DIFF
    Command.

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

    The default assignment is:

    xxxDIFFxxx

DIFFOPTS
    Command options.

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

    The default assignment is:

    xxxDIFFOPTSxxx

KEEPLOG
    Boolean.

    This option allows the user to choose whether to keep a permanent log of packages that are built with sbopkg in order to review the builds for historical or troubleshooting purposes. See LOGFILE for the location of this log.

    The default assignment is:

    xxxKEEPLOGxxx

LOGFILE
    Path.

    This option sets the name for the build log if KEEPLOG is set to YES.

    The default assignment is:

    xxxLOGFILExxx

MKDIR_PROMPT
    Boolean.

    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 assignment is:

    xxxMKDIR_PROMPTxxx

NICE
    Integer.

    This value is passed to nice(1) as its -n argument. If this value is unset or left at the default, sbopkg will execute SlackBuilds with nice's default niceness, which is 10. If you do not wish the priority to be effected, be sure to set it to 0. Note that this only affects SlackBuild execution and does not affect the priority of sbopkg as a whole.

    The default assignment is:

    xxxNICExxx

OUTPUT
    Path.

    This option sets the default directory where compiled packages are saved. OUTPUT must be exported as it is also used by the SBo SlackBuilds. Note that the default value of OUTPUT is therefore the same as in the SBo SlackBuilds.

    The default assignment is:

    xxxOUTPUTxxx

QUEUEDIR
    Path.

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

    The default assignment is:

    xxxQUEUEDIRxxx

REPO_BRANCH
    Enumeration.

    This option allows the user to set the default active repository branch. The current standard values are listed in the default repos.d/* files and can also be listed by issuing

        # sbopkg -V ?

    The default assignment is:

    xxxREPO_BRANCHxxx

REPO_NAME
    Enumeration.

    This option allows the user to choose the repository to use. See REPO_BRANCH for how to get an enumeration of standard values. The ``local'' choice corresponds to a user-maintained repository whose structure must be the same as the one used by SBo, 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 document in the sbopkg documentation directory.

    The default assignment is:

    xxxREPO_NAMExxx

REPO_ROOT
    Path.

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

    The default assignment is:

    xxxREPO_ROOTxxx

RSYNCFLAGS
    Command options.

    Rsync is used by sbopkg to mirror the SBo 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 those internal default options is not recommended. However, --timeout is a useful option to play with if getting syncing errors.

    The default assignment is:

    xxxRSYNCFLAGSxxx

SRCDIR
    Path.

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

    The default assignment is:

    xxxSRCDIRxxx

BLACKLISTFILE
    Path.

    This option contains the location of the file that list all blacklisted package(s).

    The default assignment is:

    xxxBLACKLISTFILExxx

TMP Path.

    This option sets the default directory where built packages are saved. TMP must be exported as it is also used by the SBo SlackBuilds. Note that the default value of TMP is therefore the same as in the SBo SlackBuilds.

    Also note that if the CLEANUP variable is set to YES, any custom TMP setting is ignored.

    The default assignment is:

    xxxTMPxxx

TMPDIR
    Path.

    This option sets the default directory where certain working files specific to sbopkg are saved on a temporary basis. Note that this variable is actually used by mktemp(1), and that the actual directory is hardcoded internally to sbopkg.XXXXXX where 'XXXXXX' is a random string. This variable determines the containing directory for that. If /tmp is not a suitable containing directory, TMPDIR can be assigned to on the command line when invoking sbopkg or the variable can be modified in sbopkg.conf.

    The default assignment is:

    xxxTMPDIRxxx

WGETFLAGS
    Command options.

    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. However, --timeout is a useful option to play with if getting download errors.

    The default assignment is:

    xxxWGETFLAGSxxx

SRC_REPO
    Path

    This option sets the alternative third party source repository that can be used to download the source files for package building.

    The default value is hard-coded to http://slackware.uk/sbosrcarch

NOTES

  Overriding Environmental Variables
It is possible to set or override environmental variables and pass them to the SlackBuilds when they are built from within sbopkg. This is already demonstrated in the following example line (and others like it) 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 and still allow it to be overridden at runtime by invoking sbopkg as

    # export TMP=foo; sbopkg

OUTPUT can also be changed to save compiled packages in a location other than the default of /tmp.

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 the output of 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 i586, 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 SlackBuilds. 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.

~/.sbopkg.conf
    File to override system configuration options.

/etc/sbopkg/renames.d/*.renames
    Files that list software in the SBo repository that has been renamed. See the README-renames document in the sbopkg documentation directory for more information.

/etc/sbopkg/repos.d/*.repo
    Files for various types of sbopkg repositories. See the README-repos document in the sbopkg documentation directory for more information.

AUTHORS
Willy Sudiarto Raharjo <willysr@sbopkg.org> Chess Griffin <chess@chessgriffin.com>

Mauro Giachero <mauro.giachero@gmail.com>

slakmagik <slakmagik@gmail.com>

SEE ALSO
diff(1), mktemp(1), nice(1), rsync(1), sbopkg(8), uname(1), wget(1), /usr/doc/sbopkg-xxxVERSIONxxx/*