summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrank Ch. Eigler <fche@elastic.org>2008-09-30 14:49:43 -0400
committerFrank Ch. Eigler <fche@elastic.org>2008-09-30 14:49:43 -0400
commit7115de8281be8cb68880210572ba0a0141509fb9 (patch)
treeebeeb162c4830b42d7d2059376b35733b3064917
parent1496e65102941e844f6218d3942ec019d0ada11c (diff)
downloadsystemtap-steved-7115de8281be8cb68880210572ba0a0141509fb9.tar.gz
systemtap-steved-7115de8281be8cb68880210572ba0a0141509fb9.tar.xz
systemtap-steved-7115de8281be8cb68880210572ba0a0141509fb9.zip
PR6925: add more information about installing and running stap
-rw-r--r--README31
1 files changed, 26 insertions, 5 deletions
diff --git a/README b/README
index 6b62c772..5732cf63 100644
--- a/README
+++ b/README
@@ -23,12 +23,12 @@ Installation steps:
Build steps:
-- Install the kernel-debuginfo, kernel-[smp-]devel, gcc and libcap-devel
+- Install the kernel-debuginfo, kernel-devel, gcc and dependent
packages (or see below if you are building your own kernels from source).
- If available, install your distribution's copy of elfutils and its
- development headers/libraries.
-- Or if desired, download an elfutils source release to build in
+- If available, install your distribution's copy of elfutils and its
+ development headers/libraries.
+ Or if desired, download an elfutils source release to build in
"bundled mode" (below), and untar it into some new directory.
Or if desired, build elfutils separately one time, and install
it to /usr/local.
@@ -45,15 +45,36 @@ Build steps:
% .../configure [other autoconf options]
Or, with build it with a bundled internal copy of elfutils:
% .../configure --with-elfutils=ELFUTILS-SOURCE-DIR [other autoconf options]
+
Consider configuring with "--enable-dejazilla" to automatically
contribute to our public test result database.
+ Consider configuring with "--prefix=DIRECTORY" to specify an
+ installation directory other than /usr/local. It can be an ordinary
+ personal directory.
+
% make all
% sudo make install
- To run the full test suite:
+ To uninstall systemtap:
+ % sudo make uninstall
+
+- Run systemtap:
+
+ To run the full test suite from the build tree.
% sudo make installcheck
+ To run systemtap, add $prefix/bin to your $PATH, or refer to
+ $prefix/bin/stap directly. Some samples should be available under
+ $prefix/share/doc/systemtap/examples. Normally, run "stap" as root.
+
+ If desired, create "stapdev" and "stapusr" entries in /etc/groups.
+ Any users in "stapdev" will be able to run systemtap as if with root
+ privileges. Users in "stapusr" can only launch (with "staprun")
+ pre-compiled probe modules (created by "stap -p4 ...") that a system
+ administrator copied under /lib/modules/`uname -r`/systemtap.
+
+
Tips:
- By default, systemtap looks for the debug info in these locations: