Shows syntax of specified bos commands or lists functional descriptions of all bos commands
Synopsis
bos help [-topic string...] [-help]
Options
-topic string
Specifies each command whose syntax is to be displayed. Provide only the second part of the command name (for example, status, not bos
status). If this option is omitted, the output provides a short description of all bos commands.
-help
Prints the online help for this command. All other valid options specified with this option are ignored.
Description
The bos help command displays the first line (name and short description) of the online help entry for every bos command if -topic is not
provided. For each command name specified with -topic, the output lists the entire help entry.
Use the bos apropos command to show each help entry containing a specified string.
Privilege Required
No privileges are required.
Output
The online help entry for each bos command consists of the following two lines:
· The first line names the command and briefly describes its function.
· The second line, which begins with Usage:, lists the command options in the prescribed order.
Examples
The following command displays the online help entry for the bos status command:
$ bos help status
bos status: show server process status
Usage: bos status -server <machine> [-process <server_process>...]
[-long] [{-noauth | -localauth}] [-help]
Related Information
Commands: bos apropos(8dfs)