stappaths.7.in

   1 .\" -*- nroff -*-
   2 .TH STAP 7  "Systemtap Team"
   3 .SH NAME
   4
   5 stappaths \- systemtap miscellaneous and 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 on @DATE@ 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 Tapset Path: @prefix@/share/systemtap/tapset/
  26 Systemtap data directory for cached systemtap files, unless overridden
  27 by the
  28 .I SYSTEMTAP_TAPSET
  29 environment variable or the
  30 .I XDG_DATA_DIRS
  31 environment variable.
  32 This directory stores a set of builtin functions and probe point
  33 aliases are provided by the scripts installed here.
  34 These are described in the
  35 .IR stapfuncs "(3stap) and " stapprobes (3stap)
  36 manual pages.
  37 .TP
  38 Runtime Path: @prefix@/share/systemtap/runtime/
  39 The runtime sources, unless overridden by the
  40 .I SYSTEMTAP_RUNTIME
  41 environment variable.
  42 .TP
  43 Staprun Path: @prefix@/bin/staprun/
  44 The auxiliary program supervising module loading, interaction, and
  45 unloading.
  46 .TP
  47 Stapio Path: @prefix@/libexec/systemtap/stapio/
  48 The Systemtap module input and output handler.
  49 .TP
  50 sdt.h Path: @oldincludedir@/include/sys/std.h
  51 .TP
  52 Kernel debuginfo Path: /usr/lib/debug/lib/modules/$(uname -r)/
  53 The location of kernel debugging information when packaged into the
  54 .IR kernel\-debuginfo
  55 RPM, unless overridden by the
  56 .I SYSTEMTAP_DEBUGINFO_PATH
  57 environment variable.  The default value for this variable is
  58 .I \+:.debug:/usr/lib/debug:build
  59 and can be changed using $env SYSTEMTAP_DEBUGINFO_PATH=/path/to/vmlinux .
  60 Elfutils searches vmlinux in this path and it interprets the path as a base
  61 directory of which various subdirectories will be searched for finding modules.
  62 By default, systemtap will also look for vmlinux in these locations:
  63
  64 .SAMPLE
  65 /boot/vmlinux\-`uname \-r`
  66 /lib/modules/`uname \-r`/vmlinux
  67 /lib/modules/`uname \-r`/vmlinux.debug
  68 /lib/modules/`uname \-r`/build/vmlinux
  69 /lib/modules/`uname \-r`/.debug/vmlinux.debug
  70 /usr/lib/debug/lib/modules/`uname \-r`/vmlinux.debug
  71 /var/cache/abrt\-di/usr/debug/lib/modules/`uname \-r`/
  72 /var/cache/abrt\-di/usr/lib/debug/lib/modules/`uname \-r`/vmlinux.debug
  73 .PP
  74 .ESAMPLE
  75 .IP
  76
  77 Debuginfo for user-space applications have source files located in /usr/src/debug/
  78 Further file information on user-space applications can be determined per-basis using
  79 rpm \-ql <package>\-debuginfo. For supported user-space applications information please
  80 visit the systemtap wiki.
  81 .TP
  82 $HOME/.systemtap
  83 Systemtap data directory for cached systemtap files, unless overridden
  84 by the
  85 .I SYSTEMTAP_DIR
  86 environment variable.
  87 .TP
  88 /tmp/stapXXXXXX
  89 Temporary directory for systemtap files, including translated C code
  90 and kernel object.
  91 .TP
  92 /lib/modules/VERSION/build
  93 The location of kernel module building infrastructure.
  94 .TP
  95 @prefix@/share/doc/systemtap*/examples
  96 Examples with greater detail, can be found here. Each example comes with a .txt
  97 or .meta file explaining what the example, sample or demo does and how it is
  98 ordinarily run.
  99 .TP
 100 $SYSTEMTAP_DIR/ssl/server
 101 User's server\-side SSL certificate database. If SYSTEMTAP_DIR is not
 102 set, the default is $HOME/.systemtap.
 103 .TP
 104 $SYSTEMTAP_DIR/ssl/client
 105 User's private client\-side SSL certificate database. If SYSTEMTAP_DIR is not
 106 set, the default is $HOME/.systemtap.
 107 .TP
 108 @prefix@/etc/systemtap/ssl/client
 109 Global client\-side SSL certificate database.
 110 .TP
 111 @prefix@/etc/systemtap/staprun/
 112 \fIstaprun\fR\[aq]s trusted signer certificate database.
 113 .TP
 114 @prefix@/etc/sysconfig/stap\-server/
 115 stap\-server service global configuration file.
 116 .TP
 117 @prefix@/etc/stap\-server/conf.d/*.conf
 118 stap\-server service configuration files for default servers.
 119 .TP
 120 @prefix@/var/run/stap\-server/
 121 stap\-server service default location of status files for running servers.
 122 .TP
 123 @prefix@/var/log/stap\-server.log
 124 stap\-server service default log file.
 125
 126
 127 .PP
 128 .SH FILES
 129 .nh
 130 .IR @prefix@/share/systemtap/tapset
 131 .hy
 132
 133 .SH SEE ALSO
 134 .IR stapprobes (3stap),
 135 .IR stapfuncs (3stap),
 136 .IR staprun (8),
 137 .IR stapvars (3stap),
 138 .IR stapex (3stap),
 139 .IR stap\-server (8),
 140 .IR awk (1),
 141 .IR gdb (1)
 142
 143
 144 .SH BUGS
 145 Use the Bugzilla link of the project web page or our mailing list.
 146 .nh
 147 .BR http://sourceware.org/systemtap/  ,  <systemtap@sourceware.org> .
 148 .hy