xref: /netbsd-src/external/cddl/dtracetoolkit/dist/Docs/Readme (revision c29d51755812ace2e87aeefdb06cb2b4dac7087a)
1*c29d5175SchristosDocs - DTraceToolkit Documentation
2*c29d5175Schristos
3*c29d5175Schristos   Docs/Contents	summary of toolkit commands
4*c29d5175Schristos   Examples		examples of command usage
5*c29d5175Schristos   Notes		notes on commands
6*c29d5175Schristos
7*c29d5175SchristosThe following may be followed to learn about a DTraceToolkit command,
8*c29d5175Schristos
9*c29d5175Schristos	1. read "Contents" for a command name and toolkit location.
10*c29d5175Schristos	2. run the command with "-h" to check it's usage.
11*c29d5175Schristos	3. read the manpage from Man/man1m.
12*c29d5175Schristos	4. read the examples from Examples.
13*c29d5175Schristos	5. read the notes from Notes.
14*c29d5175Schristos	6. read the script itself
15*c29d5175Schristos
16*c29d5175SchristosTry the following to discover all docs related to a command, eg iosnoop,
17*c29d5175Schristos
18*c29d5175Schristos	find . | grep iosnoop
19*c29d5175Schristos
20*c29d5175Schristosbest run from the DTraceToolkit root directory.
21*c29d5175Schristos
22