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