Debian Codegraph @

man/stappaths.7.in

raw
1 .\" -*- nroff -*-
2 .TH STAP 7 "Systemtap Team"
3 .SH NAME
4
5 stappaths \- systemtap configurable file paths
6
7
8 .\" macros
9 .de SAMPLE
10 .br
11 .RS
12 .nf
13 ..
14 .de ESAMPLE
15 .hy
16 .fi
17 .RE
18 ..
19
20 .SH DESCRIPTION
21 This manual page was generated for systemtap @VERSION@.
22 The following section will list the main paths in systemtap that are
23 important to know and may be required to reference.
24 .TP
25 @prefix@/share/systemtap/tapset/
26 The directory for the standard probe-alias / function tapset library,
27 unless overridden by the
28 .I SYSTEMTAP_TAPSET
29 environment variable or the
30 .I XDG_DATA_DIRS
31 environment variable.
32 These are described in the
33 .IR stapprobes (3stap),
34 .IR probe::* (3stap),
35 and
36 .IR function::* (3stap)
37 manual pages.
38 .TP
39 @prefix@/share/systemtap/runtime/
40 The runtime sources, unless overridden by the
41 .I SYSTEMTAP_RUNTIME
42 environment variable.
43 .TP
44 @prefix@/bin/staprun
45 The auxiliary program supervising module loading, interaction, and
46 unloading.
47 .TP
48 @sysconfdir@/stap\-exporter
49 The default directory to search for \fB*.stp\fR files, for exporting to HTTP.
50 .TP
51 @libexecdir@/systemtap/stapio
52 The auxiliary program for module input and output handling.
53 .TP
54 @oldincludedir@/sys/sdt.h
55 Location of the <sys/sdt.h> headers.
56 .TP
57 Kernel debuginfo Path: /usr/lib/debug/lib/modules/$(uname \-r)/
58 The location of kernel debugging information when packaged into the
59 .IR kernel\-debuginfo
60 RPM, unless overridden by the
61 .I SYSTEMTAP_DEBUGINFO_PATH
62 environment variable. The default value for this variable is
63 .IR \+:.debug:/usr/lib/debug:build .
64 elfutils searches vmlinux in this path and it interprets the path as a base
65 directory of which various subdirectories will be searched for finding debuginfo
66 for the kernel, kernel modules, and user-space binaries.
67 By default, systemtap will also look for vmlinux in these locations:
68
69 .SAMPLE
70 /boot/vmlinux\-`uname \-r`
71 /lib/modules/`uname \-r`/vmlinux
72 /lib/modules/`uname \-r`/vmlinux.debug
73 /lib/modules/`uname \-r`/build/vmlinux
74 /lib/modules/`uname \-r`/.debug/vmlinux.debug
75 /usr/lib/debug/lib/modules/`uname \-r`/vmlinux.debug
76 /var/cache/abrt\-di/usr/debug/lib/modules/`uname \-r`/
77 /var/cache/abrt\-di/usr/lib/debug/lib/modules/`uname \-r`/vmlinux.debug
78 .PP
79 .ESAMPLE
80 .IP
81
82 Corresponding source files are usually located under /usr/src/debug/.
83 Further file information on user-space applications can be determined per-basis using
84 rpm \-ql <package>\-debuginfo. For supported user-space applications information please
85 visit the systemtap wiki.
86
87 With elfutils version >0.178, systemtap can automatically download
88 debugging information from \%debuginfod servers. You can try it by
89 setting an environment variable or two:
90 .SAMPLE
91 export DEBUGINFOD_URLS=https://debuginfod.elfutils.org/
92 export DEBUGINFOD_PROGRESS=1
93 .ESAMPLE
94
95 .TP
96 $HOME/.systemtap
97 Systemtap data directory for cached systemtap files, unless overridden
98 by the
99 .I SYSTEMTAP_DIR
100 environment variable.
101 .TP
102 /tmp/stapXXXXXX
103 Temporary directory for systemtap files, including translated C code
104 and kernel object.
105 .TP
106 /lib/modules/VERSION/build
107 The location of kernel module building infrastructure.
108 .TP
109 @prefix@/share/doc/systemtap*/examples
110 Examples with greater detail can be found here. Each example comes with a .txt
111 or .meta file explaining what the example, sample or demo does and how it is
112 ordinarily run. See also online at:
113 .nh
114 .IR https://sourceware.org/systemtap/examples/
115 .hy
116 .TP
117 $SYSTEMTAP_DIR/ssl/server
118 User's server-side SSL certificate database. If SYSTEMTAP_DIR is not
119 set, the default is $HOME/.systemtap.
120 .TP
121 $SYSTEMTAP_DIR/ssl/client
122 User's private client-side SSL certificate database. If SYSTEMTAP_DIR is not
123 set, the default is $HOME/.systemtap.
124 .TP
125 @sysconfdir@/systemtap/ssl/client
126 Global client-side SSL certificate database.
127 .TP
128 @sysconfdir@/systemtap/staprun/
129 \fIstaprun\fR\[aq]s trusted signer certificate database.
130 .TP
131 @sysconfdir@/sysconfig/stap\-server
132 stap\-server service global configuration file.
133 .TP
134 @sysconfdir@/sysconfig/stap\-exporter
135 stap\-exporter service global configuration file.
136 .TP
137 @localstatedir@/run/stap\-server/
138 stap\-server service default location of status files for running servers.
139 .TP
140 @localstatedir@/log/stap\-server/log
141 stap\-server service default log file.
142
143 .SH SEE ALSO
144 .nh
145 .nf
146 .IR stapprobes (3stap),
147 .IR staprun (8),
148 .IR stapvars (3stap),
149 .IR stapex (3stap),
150 .IR stap\-server (8),
151 .IR awk (1),
152 .IR gdb (1)
153 .IR \%http://sourceware.org/elfutils/Debuginfod.html
154
155 .SH BUGS
156 Use the Bugzilla link of the project web page or our mailing list.
157 .nh
158 .BR http://sourceware.org/systemtap/ , <[email protected]> .
159 .hy