sbotool(1)

NAME

sbotool - text user interface to sbotools

SYNOPSIS
sbotool [-h|-v] sbotool [-d FILE] [--config|--tests]

DESCRIPTION
sbotool is a meta-tool providing a TUI to all of the sbotools based on dialog(1). It can be run by root and non-root users. sbotool must be run as root (preferably in a login shell reached from e.g. su -) to perform package installations, upgrades and removals, and to fetch the repository.

The contents of all menus are dynamic and reflect available and efficacious options. Use the Help buttons for more information about individual menu screens.

The basic workflow is straightforward: Navigate to a SlackBuild with Browse Repository or Package Search and choose from the list of options in the Operations menu. Installed, upgradable and override scripts can be reached from Installed, Upgradable and Overrides, respectively. A number of actions beyond basic package management are available from Operations; see Help for details.

For system-wide actions, see Main Menu. Use Fetch Repository to get or update a copy of the SlackBuilds.org repo, or Settings to view and edit sbotools settings. Large-scale upgrades, rebuilds and package tests can also be done here. To act on the Install, Upgrade, Remove or Template lists, use the List Operations menu screen.

sbotools calculates dependencies automatically, and individual scripts can be added to the blacklist or have optional dependencies specified using the script's Edit Hints interface. Installations and upgrades can be performed either interactively or non-interactively. If the non-interactive batch mode can be offered, sbotool displays a dry run on the confirmation screen. To specify build options for a particular script, install interactively or use Build Options from the Operations menu ahead of time as root.

If package operations are performed or sbotools settings are changed from outside of the running sbotool instance, use the Refresh option in Main Menu to ensure that the output reflects these changes.

Although most sbotools operations can be accomplished in sbotool, calling the scripts individually from the command line provides superior efficiency and fine-tuned option control to experienced users. See the Man Pages menu to read further user documentation.

STARTUP
Ensure that the terminal window is at least 80x25 characters to run sbotool. The lines, cols and clear terminal capabilities are required; tput(1) can be used to check. This should not be a problem for any remotely modern terminal, provided that the TERM environment variable is set correctly.

A copy of the SlackBuilds.org repository must be fetched when using sbotools for the first time, or when the sbotools directory has been changed. Run sbotool as root and select the Fetch Repository option. The local repository is saved to /var/lib/sbotools/repo by default; the default upstream is the SlackBuilds.org GitLab mirror, or the Ponce repository for Slackware -current.

sbotools has a number of potentially useful configuration settings, including the upstream repository, git branch and location. To make changes, run sbotool as root and enter the Settings menu. Select a setting from the list to see an explanation and enter a new value. All configuration values are documented in sbotools.conf(5).

sbotool uses dialog(1) for output. The color scheme and appearance can be changed using a dialogrc file. Set the DIALOGRC setting to an absolute file path to use an alternative dialogrc. See /etc/dialogrc or /usr/share/sbotools for an example, or run
    dialog --create-rc FILE
to generate a default dialogrc to modify. The --dialogrc option can also specify a file at runtime.

OPTIONS
--config
    Enter the Settings menu directly. sboconfig(1) calls sbotool with this option when run without flags.
--tests
    Enter the Package Tests menu directly.

-d|--dialogrc (FILE)
    Use this dialogrc file for the current run of sbotool. Overrides the DIALOGRC setting.

-h|--help
    Show help information.

-v|--version
    Show version information.

EXIT CODES

sbotools scripts can exit with the following codes:
    0: all operations were succesful.
    1: a usage error occured, such as specifying invalid options.
    2: a script or module error occurred.
    3: a SlackBuild exited non-zero.
    4: unable to md5sum verify the source file(s).
    5: unable to download the source file(s).
    6: unable to obtain a required file handle.
    7: unable to get required info from the info file.
    8: unable to unset the exec-on-close bit on a temporary file.
    9: multilib has not been set up (where required).
    10: convertpkg-compat32 exited non-zero.
    11: the convertpkg-compat32 script cannot be found (where required).
    12: interrupt signal received.
    13: circular dependencies detected.
    14: in batch, nointeractive or dry-run, required user or group missing.
    15: GPG verification failed.
    16: reading keyboard input failed.
    17: could not give SBO_HOME valid contents.
    18: terminal lacks the required capabilities to run sbotool(1).

BUGS
None known. If found, Issues and Pull Requests to https://github.com/pghvlaans/sbotools/ are always welcome.

SEE ALSO

sbocheck(1), sboclean(1), sboconfig(1), sbocutleaves(1), sbofind(1), sbohints(1), sboinstall(1), sboremove(1), sboupgrade(1), sbotools(1), sbotools.colors(5), sbotools.conf(5), sbotools.hints(5), dialog(1), tput(1)

AUTHORS

Jacob Pipkin <jacob.pipkin@icloud.com>

Luke Williams <xocel@iquidus.org>

Andreas Guldstrand <andreas.guldstrand@gmail.com>

MAINTAINER

K. Eugene Carlson <kvngncrlsn@gmail.com>