xref: /netbsd-src/external/cddl/dtracetoolkit/dist/Docs/Examples/Readme (revision c29d51755812ace2e87aeefdb06cb2b4dac7087a)
1*c29d5175SchristosExamples - Script demos, screenshots, and how to read the output
2*c29d5175Schristos
3*c29d5175Schristos   This directory contains an example file per script in the DTraceToolkit.
4*c29d5175Schristos
5*c29d5175Schristos   When I hear of a new performance tool or what not, the first thing I want
6*c29d5175Schristos   to see are screenshots. They illustrate,
7*c29d5175Schristos
8*c29d5175Schristos   	- generally what the tool is for
9*c29d5175Schristos	- many details and features, since the output is (supposed to be)
10*c29d5175Schristos	  as intuitive as possible
11*c29d5175Schristos	- how to use the tool (command line usage)
12*c29d5175Schristos
13*c29d5175Schristos   It is a rapid way to get a handle on what a tool generally is, and how
14*c29d5175Schristos   to start using it. The files in this directory serve that purpose.
15*c29d5175Schristos
16*c29d5175Schristos   These are especially important now that the DTraceToolkit has over 200
17*c29d5175Schristos   scripts. Flicking through these files and seeing the screenshots may
18*c29d5175Schristos   be the quickest way to find what you are after.
19*c29d5175Schristos
20*c29d5175Schristos   Of course, don't forget to read the man pages and notes files too :)
21*c29d5175Schristos
22