README
1Guide - Guide to the DTraceToolkit
2
3 How to get started, and a table of contents.
4
5QuickStart
6
7 1. The top most useful scripts are in this directory.
8 2. Try running them with "-h". Eg, "./execsnoop -h".
9 3. read Docs/Contents for a full list of scripts.
10
11Not-so-QuickStart
12
13 1. Welcome!
14 2. Check the Table of Contents below to become famaliar with the
15 directory structure of the DTraceToolkit.
16 3. see Docs/Faq for any initial questions.
17 4. read Docs/Contents for a list of scripts.
18 5. read Docs/Readme to see where scripts are documented.
19 6. check Docs/Links for further DTrace.
20 7. Once famaliar with the toolkit, the following may be useful to
21 add to your shell initialisation file,
22 PATH=$PATH:/opt/DTT/Bin
23 MANPATH=$MANPATH:/opt/DTT/Man
24 in this case assuming the toolkit was installed in /opt/DTT.
25
26Installation
27
28 1. Run ./install
29 This will replace any existing version of the DTraceToolkit
30 with this one. It will prompt. Final install location is
31 printed by this install script.
32
33Table of Contents
34
35 DTraceToolkit-X.XX/
36 Bin/ Symlinks to the scripts
37 Apps/ Application specific scripts
38 Cpu/ Scripts for CPU analysis
39 Disk/ Scripts for disk I/O analysis
40 Docs/ Documentation
41 Contents Command list for the Toolkit
42 Examples/ Examples of command usage
43 Faq Frequently asked questions
44 Links Further DTrace links
45 Notes/ Notes on Toolkit commands
46 Readme Readme for using the docs
47 Extra/ Misc scripts
48 Guide This file!
49 Kernel/ Scripts for kernel analysis
50 License The CDDL license
51 Locks/ Scripts for lock analysis
52 Man/ Man pages
53 man1m/ Man pages for the Toolkit commands
54 Mem/ Scripts for memory analysis
55 Net/ Scripts for network analysis
56 Proc/ Scripts for process analysis
57 System/ Scripts for system analysis
58 User/ Scripts for user based activity analysis
59 Zones/ Scripts for analysis by zone
60 Version DTraceToolkit version
61 install Install script, use for installs only
62
63When you type ls in the DTraceToolkit, you will be looking at the top ten
64or so most useful scripts. Other scripts have been placed in meaningful
65subdirectories, such as Disk, Kernel, Proc, etc. An optional Bin directory
66has been provided that links to all the scripts.
67
68The DTraceToolkit is released under the CDDL license. It's the same freeware
69license that OpenSolaris has been released under.
70
71Thank you for using the DTraceToolkit!
72
73