Skip to content

HomeSetup Developer Handbook

Standard-Tools

Table of contents

Tool checks functions


__hhs_toolcheck

usage: __hhs_toolcheck [options] <app_name>

    Options:
      -q  : Quiet mode on
Purpose:

Check whether a tool is installed on the system.

Returns:

0 if the tool is installed; non-zero otherwise.

Parameters:
  • $1 Required : The app to check.
Examples:
  $ __hhs_toolcheck java && echo "java is installed"
  $ __hhs_toolcheck -q nottatool || echo "nottatool is not installed"

__hhs_version

usage: __hhs_version <app_name>
Purpose:

Check the version of the app using the most common ways.

Returns:

0 on success; non-zero otherwise.

Parameters:
  • $1 Required : The app to check.
Examples:
  $ __hhs_version java
  $ __hhs_version git

__hhs_tools

usage: __hhs_tools [tool_list]
Purpose:

Check whether a list of development tools are installed or not.

Returns:

0 on success; non-zero otherwise.

Parameters:
  • $1..$N Optional : The tool list to be checked.
Examples:
  $ __hhs_tools 'git' 'svn' 'java' 'python3'

__hhs_about

usage: __hhs_about <command>
Purpose:

Display information about the given command.

Returns:

0 on success; non-zero otherwise.

Parameters:
  • $1 Required : The command to check.
Examples:
  $ __hhs_about ls