bos apropos(8dfs)

Shows each help entry containing a specified string

Synopsis

bos apropos -topic string [-help]

Options

-topic string
Specifies the keyword string for which to search. If it is more than a single word, surround the string with " " (double quotes) or other delimiters. Type all strings for bos commands in lowercase letters.

-help
Prints the online help for this command. All other valid options specified with this option are ignored.

Description
The bos apropos command displays the first line of the help entry for any bos command containing the string specified by -topic in its name or short description.

To display the syntax for a command, use the bos help command.

Privilege Required
No privileges are required.

Output
The first line of an online help entry for a command lists the command and briefly describes its function. This command displays the first line for any bos command where the string specified by -topic is part of the command name or the first line.

Examples
The following command lists all bos commands that have the word restart in their names or short descriptions:

$ bos apropos restart

getrestart: get restart times

restart: restart all processes

setrestart: set restart times for server processes

Related Information
Commands: bos help(8dfs)