1. Manuals
  2. Tumbleweed
  3. openafs
  4. bos_apropos(8)

Scroll to navigation

BOS_APROPOS(8) AFS Command Reference BOS_APROPOS(8)

NAME

bos_apropos - Displays each help entry containing a keyword string

SYNOPSIS

bos apropos -topic <help string> [-help]

bos ap -t <help string> [-h]

DESCRIPTION

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

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

OPTIONS

Specifies the keyword string to match, in lowercase letters only. If the string is more than a single word, surround it with double quotes ("") or other delimiters.
Prints the online help for this command. All other valid options are ignored.

OUTPUT

The first line of a command's online help entry names it and briefly describes its function. This command displays the first line for any bos command where the string specified with the -topic argument is part of the command name or first line.

EXAMPLES

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

   % bos apropos restart
   getrestart: get restart times
   restart: restart all processes
   setrestart: set restart times

PRIVILEGE REQUIRED

None

SEE ALSO

bos(8), bos_help(8)

COPYRIGHT

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0. It was converted from HTML to POD by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.

2024-11-25 OpenAFS