Debian Codegraph @

doc/SystemTap_Beginners_Guide/en-US/References.xml

raw
1 <?xml version='1.0'?>
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3 ]>
4
5 <chapter id="references">
6 <title>References</title>
7 <remark>display links to other useful, more advanced systemtap docs - http://sourceware.org/systemtap/documentation.html, http://sourceware.org/systemtap/wiki/HomePage</remark>
8
9 <para>
10 This chapter enumerates other references for more information about SystemTap.
11 Refer to these sources in the course of writing advanced probes and tapsets.
12 </para>
13
14 <variablelist>
15
16 <varlistentry>
17 <term>SystemTap Wiki</term>
18 <listitem>
19 <para>
20 The <citetitle>SystemTap Wiki</citetitle> is a collection of links and articles related to the
21 deployment, usage, and development of SystemTap. You can find it at
22 <ulink url="http://sourceware.org/systemtap/wiki/HomePage"/>.
23 </para>
24 </listitem>
25 </varlistentry>
26
27 <varlistentry>
28 <term>SystemTap Tutorial</term>
29 <listitem>
30 <para>
31 Much of the content in this book comes from the <citetitle>SystemTap Tutorial</citetitle>.
32 The <citetitle>SystemTap Tutorial</citetitle> is a more appropriate reference for
33 users with intermediate to advanced knowledge of C++ and kernel development, and you can find it at
34 <ulink url="http://sourceware.org/systemtap/tutorial/"/>.
35 </para>
36 </listitem>
37 </varlistentry>
38
39 <varlistentry>
40 <term>man stapprobes</term>
41 <listitem>
42 <para>
43 The <citerefentry><refentrytitle>stapprobes</refentrytitle><manvolnum>3stap</manvolnum></citerefentry> man page enumerates a variety of probe points supported by SystemTap, along with additional aliases
44 defined by the SystemTap tapset library. The bottom part of the man page includes a list of other man pages
45 enumerating similar probe points for specific system components, such as
46 <filename>tapset::scsi</filename>, <filename>tapset::kprocess</filename>,
47 <filename>tapset::signal</filename>, and so on.
48 </para>
49 </listitem>
50 </varlistentry>
51
52 <varlistentry>
53 <term>man stapfuncs</term>
54 <listitem>
55 <para>
56 The <citerefentry><refentrytitle>stapfuncs</refentrytitle><manvolnum>3stap</manvolnum></citerefentry> man page enumerates numerous functions supported by the SystemTap tapset
57 library, along with the prescribed syntax for each of them. Note, however, that it does not provide a
58 complete list of <emphasis>all</emphasis> supported functions; there are more undocumented
59 functions available.
60 </para>
61 </listitem>
62 </varlistentry>
63
64 <varlistentry>
65 <term>SystemTap Tapset Reference Manual</term>
66 <listitem>
67 <para>
68 The <citetitle>SystemTap Tapset Reference Manual</citetitle>
69 describes the individual predefined functions and probe points of the
70 tapsets in greater detail. You can find it at
71 <ulink url="http://sourceware.org/systemtap/tapsets/"/>.
72 </para>
73 </listitem>
74 </varlistentry>
75
76 <varlistentry>
77 <term>SystemTap Language Reference</term>
78 <listitem>
79 <para>
80 The <citetitle>SystemTap Language Reference</citetitle> is a comprehensive reference of SystemTap's language constructs and syntax. It is
81 recommended for users with a rudimentary to intermediate knowledge of C++ and other similar
82 programming languages, and is available to all
83 users at <ulink url="http://sourceware.org/systemtap/langref/"/>.
84 </para>
85 </listitem>
86 </varlistentry>
87
88 <varlistentry>
89 <term>Tapset Developers Guide</term>
90 <listitem>
91 <para>
92 Once you have sufficient proficiency in writing SystemTap scripts, you can try to write your own tapsets. The <citetitle>Tapset Developers Guide</citetitle> describes how to add functions to your tapset library.
93 </para>
94 </listitem>
95 </varlistentry>
96
97 <varlistentry>
98 <term>Test Suite</term>
99 <listitem>
100 <para>
101 The <package>systemtap-testsuite</package> package allows you to test the entire SystemTap
102 toolchain without having to build it from source code. In addition, it also contains numerous examples of
103 SystemTap scripts to study and test; some of these scripts are also documented in
104 <xref linkend="useful-systemtap-scripts"/>.
105 </para>
106
107 <para>
108 By default, the example scripts included in <package>systemtap-testsuite</package> are located
109 in the <filename class="directory">/usr/share/systemtap/testsuite/systemtap.examples/</filename> directory.
110 </para>
111 </listitem>
112 </varlistentry>
113
114 <!--
115 <varlistentry>
116 <term></term>
117 <listitem>
118 <para>
119 </para>
120 </listitem>
121 </varlistentry>
122 -->
123 </variablelist>
124
125
126 </chapter>
127