From: dsmith Date: Tue, 6 Mar 2007 16:18:55 +0000 (+0000) Subject: Added new man page. X-Git-Url: https://sourceware.org/git/?a=commitdiff_plain;h=b91007199d37d66037b1396a22826bc24015a6a1;p=systemtap-htdocs.git Added new man page. --- diff --git a/man/staprun.8.html b/man/staprun.8.html new file mode 100644 index 00000000..5238d2ac --- /dev/null +++ b/man/staprun.8.html @@ -0,0 +1,207 @@ + +Manpage of STAPRUN + +

STAPRUN

+Section: Maintenance Commands (8)
Updated: 2007-03-06
Index +Return to Main Contents

+ + +

NAME

+ +staprun - systemtap runtime +

+ +

SYNOPSIS

+ +

+
+ +staprun + +[ +OPTIONS + +] +MODULE + +[ +MODULE-OPTIONS + +] +

+ +

DESCRIPTION

+ +

+The +staprun + +program is the back-end to the Systemtap tool. It expects a kernel +module produced by the front-end +stap + +tool. +The +staprun + +must be run as root. +

+ +Splitting the systemtap tool into a front-end and a back-end allows a +user to compile a systemtap script on a development machine that has +the kernel debugging information (need to compile the script) and then +transfer the resulting kernel module to a production machine that +doesn't have any development tools or kernel debugging information installed. +

+ +This manual corresponds to version ?. +

+ +

OPTIONS

+ +The systemtap translator supports the following options. Any other option +prints a list of supported options. +

-q + +: +Quiet mode. Don't display trace to standard output. +
-p + +: +Print only. Don't log to files. +
-c CMD + +: +Command CMD will be run and the staprun program will exit when CMD +does. The '_stp_target' variable will contain the pid for CMD. +
-t PID + +: +The '_stp_target' variable will be set to PID. +
+: +-d PID + +Pass the systemtap driver's PID. +
-o FILE + +: +Send output to FILE. +
-u USERNAME + +: +Run commands as USERNAME. +
-b BUFFER_SIZE + +: +The systemtap module will specify a buffer size. +Setting one here will override that value. The value should be +an integer between 1 and 64 which be assumed to be the +buffer size in MB. That value will be per-cpu if relayfs is used. +
+

+ +

ARGUMENTS

+ +

+ +Any additional arguments on the command line are passed to the +module. +

+ +

EXAMPLES

+ +See the +stapex(5) + +manual page for a collection of sample scripts. +

+ +Here is a very basic example of how to use staprun. First, use +stap + +to compile a script. The +stap + +program will report the pathname to the resulting module. +

+ + + $ stap -p4 -e 'probe begin { printf("Hello World!\n"); exit() }' +
+ + /home/user/.systemtap/cache/85/stap_8553d83f78c_265.ko +

+ +Run +staprun + +with the pathname to the module as an argument. The +sudo(8) + +command is used to grant root privileges. +

+ + + $ sudo staprun /home/user/.systemtap/cache/85/stap_8553d83f78c_265.ko +
+ + Hello World! +

+ +

SAFETY AND SECURITY

+ +Systemtap is an administrative tool. It exposes kernel internal data +structures and potentially private user information. See the +stap(1) + +manual page for more information on safety and security. +

+ +

BUGS

+ +Use the Bugzilla link off of the project web page or our mailing list. + +http://sources.redhat.com/systemtap/,<systemtap@sources.redhat.com>. + + +

+ +

+This document was created by +man2html, +using the manual pages.
+Time: 16:17:39 GMT, March 06, 2007 + +