fstrace_help - Displays help for fstrace commands
Contents
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.
OpenAFS 2025-03-21 FSTRACE_HELP(8)
Description
The fstracehelp command displays the complete online help entry (short description and syntax statement)
for each command operation code specified by the -topic argument. If the -topic argument is omitted, the
output includes the first line (name and short description) of the online help entry for every fstrace
command.
To list every fstrace command whose name or short description includes a specified keyword, use the
fstraceapropos command.
Examples
The following command displays the online help entry for the fstracesetset command:
% fstrace help -topic setset
fstrace setset: set state of event sets
Usage: fstrace setset [-set <set_name>+] [-active] [-inactive]
[-dormant] [-help]
Name
fstrace_help - Displays help for fstrace commands
Options
-topic <helpstring>+
Indicates each command for which to display the complete online help entry. Omit the fstrace part of
the command name, providing only the operation code (for example, specify clear, not fstraceclear).
If this argument is omitted, the output briefly describes every fstrace command.
-help
Prints the online help for this command. All other valid options are ignored.
Output
The online help entry for each fstrace command consists of two or three lines:
• The first line names the command and briefly describes its function.
• The second line lists aliases for the command, if any.
• The final line, which begins with the string "Usage", lists the command's options in the prescribed
order. Online help entries use the same symbols (for example, brackets) as the reference pages in
this document.
Privilege Required
None
See Also
fstrace(8), fstrace_apropos(8)
Synopsis
fstracehelp [-topic <helpstring>+] [-help]
fstraceh [-t <helpstring>+] [-h]
