zfsadm apropos
Purpose
Shows each help entry containing a specified string.
Format
zfsadm apropos -topic string [-level] [-help]Options
- -help
- Prints the online help for this command. All other valid options specified with this option are ignored.
- -level
- Prints the level of the zfsadm command. This is useful when you are diagnosing a problem. Except for -help, all other valid options specified with -level are ignored.
- -topic
- Specifies the keyword string for which to search. If it is more than a single word, surround it with quotation marks ("") or another delimiter. Type all strings for zfsadm commands in all lowercase letters.
Usage
The zfsadm apropos command displays the first line of the online help entry for any zfsadm command containing the string specified by -topic in its name or short description. To display the syntax for a command, use the zfsadm help command.
Privilege required
If
you are using an IOEFSPRM file in your startup proc,
the issuer
must have READ authority to the data set that contains the IOEFSPRM
file. If you are using parmlib (IOEPRMxx), the issuer does not need
special authorization.
Results
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 zfsadm command where the string specified by -topic is part of the command name or first line.
Examples
The following command lists all zfsadm commands that have the word list in their names or short descriptions:
zfsadm apropos list
lsaggr: list aggregates
lsfs: list filesystem informationRelated information
- zfsadm help