📦 shtk

64 pages

S

shtk(1)Interface to the Shell Toolkit✨
shtk(3)Application Programming Interface (API) of the Shell Toolkit✨
shtk_abort(3)Aborts the program with an optional error message✨
shtk_bool(3)Utilities to manipulate boolean values✨
shtk_bool_check(3)Converts a string to a boolean value✨
shtk_cleanup(3)Utilities to install exit handlers for cleanup routines✨
shtk_cleanup_register(3)Installs cleanup handlers to be called on script termination✨
shtk_cli(3)Utilities to implement command-line interfaces✨
shtk_cli_debug(3)Prints a debug message✨
shtk_cli_dirname(3)Gets the directory where the current script lives✨
shtk_cli_error(3)Prints a runtime error message and exits✨
shtk_cli_info(3)Prints an informational message✨
shtk_cli_log_level(3)Checks if the given logging level is visible✨
shtk_cli_progname(3)Gets the program name✨
shtk_cli_set_log_level(3)Sets the level of the logging messages to display✨
shtk_cli_usage_error(3)Prints a usage error and exits✨
shtk_cli_warning(3)Prints a warning message✨
shtk_config(3)Configuration file processing and queries✨
shtk_config_get(3)Gets the value of a defined configuration variable✨
shtk_config_get_bool(3)Gets the value of a boolean configuration variable✨
shtk_config_get_default(3)Gets the value of a possibly-unset configuration variable✨
shtk_config_has(3)Checks if a configuration variable is set✨
shtk_config_include(3)Includes a file within a configuration file✨
shtk_config_init(3)Initializes the configuration module✨
shtk_config_load(3)Loads a configuration file✨
shtk_config_override(3)Records an override to be applied to the configuration✨
shtk_config_run_hook(3)Executes a hook defined in a configuration file✨
shtk_config_set(3)Sets the value of a configuration variable✨
shtk_config_unset(3)Clears a configuration variable✨
shtk_cvs(3)Utilities to invoke CVS and wrappers to simplify its operation✨
shtk_cvs_checkout(3)Checks out a new working copy out of a CVS repository✨
shtk_cvs_fetch(3)Checks out or updates a CVS working copy✨
shtk_cvs_update(3)Updates an existing working copy of a CVS repository✨
shtk_fs(3)Utilities to manipulate file system paths✨
shtk_fs_join_paths(3)Concatenates a series of path entries✨
shtk_fs_normalize_path(3)Returns a normalized form of a path✨
shtk_hw(3)Utilities to query details about the machine's hardware✨
shtk_hw_ncpus(3)Queries the number of CPUs (threads) in the machine✨
shtk_import(3)Loads an shtk module✨
shtk_list(3)Utilities to manipulate lists✨
shtk_list_contains(3)Checks if an item appears in a list✨
shtk_list_filter(3)Filters the elements of a list based on a pattern✨
shtk_process(3)Utilities to manipulate external processes✨
shtk_process_run(3)Executes a command in a controlled environment✨
shtk_unittest(3)Utilities to implement test programs✨
shtk_unittest_add_fixture(3)Defines a test fixture✨
shtk_unittest_add_test(3)Defines a standalone test case✨
shtk_unittest_assert_command(3)Runs a command and validates its exit status and output✨
shtk_unittest_assert_equal(3)Fatal equality check between two values✨
shtk_unittest_assert_file(3)Validates the contents of a file against golden data✨
shtk_unittest_assert_not_equal(3)Fatal inequality check between two values✨
shtk_unittest_delayed_fail(3)Records a delayed failure✨
shtk_unittest_expect_command(3)Runs a command and validates its exit status and output✨
shtk_unittest_expect_equal(3)Non-fatal equality check between two values✨
shtk_unittest_expect_file(3)Non-fatal check to validate the contents of a file✨
shtk_unittest_expect_not_equal(3)Non-fatal inequality check between two values✨
shtk_unittest_fail(3)Fails the test case✨
shtk_unittest_main(3)Standard test program entry point✨
shtk_unittest_set_expected_failure(3)Makes the test expect a failure✨
shtk_unittest_skip(3)Skips the test currently being run✨
shtk_version(3)Utilities to check the running version of shtk✨
shtk_version_at_least(3)Checks if shtk is a minimum version✨
shtk_version_at_most(3)Checks if shtk is a maximum version✨
shtk_version_is(3)Checks if shtk is a specific version✨