fstrace_help(8) [debian man page]
FSTRACE_HELP(8) AFS Command Reference FSTRACE_HELP(8) NAME
fstrace_help - Displays help for fstrace commands SYNOPSIS
fstrace help [-topic <help string>+] [-help] fstrace h [-t <help string>+] [-h] DESCRIPTION
The fstrace help 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 fstrace apropos command. OPTIONS
-topic <help string>+ 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 fstrace clear). 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: o The first line names the command and briefly describes its function. o The second line lists aliases for the command, if any. o 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. EXAMPLES
The following command displays the online help entry for the fstrace setset command: % fstrace help -topic setset fstrace setset: set state of event sets Usage: fstrace setset [-set <set_name>+] [-active] [-inactive] [-dormant] [-help] PRIVILEGE REQUIRED
None SEE ALSO
fstrace(8), fstrace_apropos(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. OpenAFS 2012-03-26 FSTRACE_HELP(8)
Check Out this Related Man Page
FSTRACE_LSLOG(8) AFS Command Reference FSTRACE_LSLOG(8) NAME
fstrace_lslog - Displays information about a log SYNOPSIS
fstrace lslog [-set <set name>+] [-log <log name>] [-long] [-help] fstrace lsl [-s <set name>+] [-log <log name>] [-lon] [-h] DESCRIPTION
The fstrace lslog command reports whether the "cmfx" log is available for use. If the -long argument is included, the output reports the log's defined size, and whether that amount of space is currently allocated in kernel memory or not. To change the "cmfx" trace log's size, use the fstrace setlog command. To display or set whether space is allocated for it in kernel memory, use the fstrace lsset or fstrace setset command to display or set the state of the corresponding "cm" event set, respectively. OPTIONS
-set <set name>+ Names the event set for which to display information about the corresponding trace log. The only acceptable value is "cm" (for which the associated trace log is "cmfx"). Provide either this argument or the -log argument, or omit both to display information about the "cmfx" log by default. -log <log name> Names the trace log about which to report. The only acceptable value is "cmfx". Provide either this argument or the -set argument, or omit both to report on the "cmfx" log by default. -long Reports the defined size of the log in kilobyte units and whether that amount of space is currently allocated in kernel memory. -help Prints the online help for this command. All other valid options are ignored. OUTPUT
By default, the fstrace lslog command displays only the name of the available log, "cmfx", in the following format: Available logs: cmfx When the -long flag is included, the output also reports the defined size of the log in kilobytes, and whether or not that amount of space is currently allocated in kernel memory, in the following format: Available logs: cmfx : <log_size> kbytes (allocated | unallocated) The "allocated" state indicates that the indicated number of kilobytes is reserved for the "cmfx" trace log in kernel memory. The "cm" event set's state is either "active" or "inactive", as reported by the fstrace lsset command, and set by the fstrace setset command's -active or -inactive flags respectively. The "unallocated" state indicates that no kernel memory is currently reserved for the "cmfx" trace log. The cm event set's state is "dormant", as reported by the fstrace lsset command and set by the fstrace setset command's -dormant flag. If the event set's state is later changed to active or inactive, the number of kilobytes indicated as <log_size> are again allocated in kernel memory. EXAMPLES
The following example uses the -long flag to display information about the "cmfx" log: # fstrace lslog -log cmfx -long Available logs: cmfx : 60 kbytes (allocated) PRIVILEGE REQUIRED
The issuer must be logged in as the local superuser "root". SEE ALSO
fstrace(8), fstrace_lsset(8), fstrace_setlog(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. OpenAFS 2012-03-26 FSTRACE_LSLOG(8)