sbohints(1)

NAME

sbohints - set and unset per-script hints

SYNOPSIS

sbohints [-h|-v]

sbohints [-l|--reset]

sbohints [-c] [-Obort] sbo_name (sbo_name)

sbohints [-q] sbo_name (sbo_name)

sbohints [--color|--nocolor] [--wrap|--nowrap] ...

DESCRIPTION

sbohints queries and edits script-specific hints in sbotools.hints(5). Four kinds of hints are recognized:
    • blacklist • optional dependencies • automatic reverse dependency rebuild • test failures are ignored by sboupgrade(1)
The modification flags are --blacklist, --optional, --replace-optional, --reverse and --ignore-tests. These can be used in conjunction with --clear, but not with each other.

Please note that all hints apply equally to the compat32 version of the target script or scripts; specific requests for compat32 scripts are unsupported.

Non-root users can only call sbohints with the --list, --query, --help and --version flags. If an invalid configuration is detected in /etc/sbotools/sbotools.conf, the script exits with a diagnostic message. To use a configuration directory other than /etc/sbotools, export an environment variable SBOTOOLS_CONF_DIR with an absolute path.

OPTIONS

-b|--blacklist
    Modify the blacklist by adding (or, with --clear, clearing) one or more scripts.

-o|--optional
    Add (or clear with --clear) optional dependency requests for one or more scripts. The current optional dependencies are displayed together with a prompt for adding or clearing.

-O|--replace-optional
    Replace all existing optional dependency requests for one or more scripts. The current optional dependencies are displayed together with a prompt for the new request list. If used with --clear, a confirmation prompt for clearing the optional dependencies appears.

-r|--reverse
    Add (or, with --clear, clear) automatic reverse dependency rebuild requests for one or more scripts. Please note that building against some packages, such as google-go-lang, fails unless a version-specific profile script has been sourced. Requesting reverse dependency rebuilds for such packages is not advised unless the ETC_PROFILE setting is TRUE. See sboconfig(1) or sbotools.conf(5) for details.

-t|--ignore-tests
    Add (or, with --clear, clear) a request that sboupgrade(1) ignore test failures for one or more scripts when running with --all-plus-failures. Please note that scripts with missing shared object failures only in /opt are skipped by sboupgrade(1) unless running interactively.

-c|--clear
    This flag is used together with one (and only one) of --blacklist, --optional, --replace-optional, --ignore-tests or --reverse. For --blacklist, --optional, --ignore-tests and --reverse, clear entries instead of adding them. For --replace-optional, clear all existing optional dependency requests.

-l|--list
    List all active hints. If a blacklisted script has optional dependency requests or is requested as an optional depenedency, the user is notified. The --list flag can be used without root privileges.

-q|--query
    Return the hint status for one or more scripts. There is no output unless the queried script is involved with one or more hints. The --query flag can be used without root privileges.

--reset
    Clear all hints upon confirmation.

-h|--help
    Show help information.

-v|--version
    Show version information.

--color
    Turn on sbotools color output (default). See also sbotools.colors(5).

--nocolor
    Turn off sbotools color output.

--wrap
    Turn on sbotools word wrapping (default).

--nowrap
    Turn off sbotools word wrapping.

SBOTEST
sbohints is called when running sbotest hints; flags are unchanged.

EXIT CODES

sbohints can exit with the following codes:
    0: all operations were successful.
    1: a usage error occurred.
    2: a script or module error occurred.
    6: a required file handle could not be obtained.
    16: reading keyboard input failed.

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), sboinstall(1), sboremove(1), sbotool(1), sboupgrade(1), sbotools.colors(5), sbotools.conf(5), sbotools.hints(5)

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>