--- /dev/null
+
+<HTML><HEAD><TITLE>Manpage of STAPRUN</TITLE>
+</HEAD><BODY>
+<H1>STAPRUN</H1>
+Section: Maintenance Commands (8)<BR>Updated: 2007-03-06<BR><A HREF="#index">Index</A>
+<A HREF="../index.html">Return to Main Contents</A><HR>
+
+<A NAME="lbAB"> </A>
+<H2>NAME</H2>
+
+staprun - systemtap runtime
+<P>
+<A NAME="lbAC"> </A>
+<H2>SYNOPSIS</H2>
+
+<P>
+<BR>
+
+<B>staprun</B>
+
+[
+<I>OPTIONS</I>
+
+]
+<I>MODULE</I>
+
+[
+<I>MODULE-OPTIONS</I>
+
+]
+<P>
+<A NAME="lbAD"> </A>
+<H2>DESCRIPTION</H2>
+
+<P>
+The
+<I>staprun</I>
+
+program is the back-end to the Systemtap tool. It expects a kernel
+module produced by the front-end
+<I>stap</I>
+
+tool.
+The
+<I>staprun</I>
+
+must be run as root.
+<P>
+
+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.
+<P>
+
+This manual corresponds to version ?.
+<P>
+<A NAME="lbAE"> </A>
+<H2>OPTIONS</H2>
+
+The systemtap translator supports the following options. Any other option
+prints a list of supported options.
+<DL COMPACT>
+<DT><B>-q</B>
+
+<DD>
+Quiet mode. Don't display trace to standard output.
+<DT><B>-p</B>
+
+<DD>
+Print only. Don't log to files.
+<DT><B>-c CMD</B>
+
+<DD>
+Command CMD will be run and the staprun program will exit when CMD
+does. The '_stp_target' variable will contain the pid for CMD.
+<DT><B>-t PID</B>
+
+<DD>
+The '_stp_target' variable will be set to PID.
+<DT>
+<DD>
+<B>-d PID</B>
+
+Pass the systemtap driver's PID.
+<DT><B>-o FILE</B>
+
+<DD>
+Send output to FILE.
+<DT><B>-u USERNAME</B>
+
+<DD>
+Run commands as USERNAME.
+<DT><B>-b BUFFER_SIZE</B>
+
+<DD>
+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.
+<P>
+</DL>
+<A NAME="lbAF"> </A>
+<H2>ARGUMENTS</H2>
+
+<P>
+
+Any additional arguments on the command line are passed to the
+module.
+<P>
+<A NAME="lbAG"> </A>
+<H2>EXAMPLES</H2>
+
+See the
+<I><A HREF="stapex.5.html">stapex</A></I>(5)
+
+manual page for a collection of sample scripts.
+<P>
+
+Here is a very basic example of how to use staprun. First, use
+<I>stap</I>
+
+to compile a script. The
+<I>stap</I>
+
+program will report the pathname to the resulting module.
+<P>
+
+
+ $ stap -p4 -e 'probe begin { printf("Hello World!\n"); exit() }'
+<BR>
+
+ /home/user/.systemtap/cache/85/stap_8553d83f78c_265.ko
+<P>
+
+Run
+<I>staprun</I>
+
+with the pathname to the module as an argument. The
+<I><A HREF="sudo.8.html">sudo</A></I>(8)
+
+command is used to grant root privileges.
+<P>
+
+
+ $ sudo staprun /home/user/.systemtap/cache/85/stap_8553d83f78c_265.ko
+<BR>
+
+ Hello World!
+<P>
+<A NAME="lbAH"> </A>
+<H2>SAFETY AND SECURITY</H2>
+
+Systemtap is an administrative tool. It exposes kernel internal data
+structures and potentially private user information. See the
+<I><A HREF="stap.1.html">stap</A></I>(1)
+
+manual page for more information on safety and security.
+<P>
+<A NAME="lbAI"> </A>
+<H2>SEE ALSO</H2>
+
+<I><A HREF="stap.1.html">stap</A></I>(1),
+
+<I><A HREF="stapprobes.5.html">stapprobes</A></I>(5),
+
+<I><A HREF="stapfuncs.5.html">stapfuncs</A></I>(5),
+
+<I><A HREF="stapex.5.html">stapex</A></I>(5),
+
+<I><A HREF="lket.5.html">lket</A></I>(5),
+
+<I><A HREF="sudo.8.html">sudo</A></I>(8)
+
+<P>
+<A NAME="lbAJ"> </A>
+<H2>BUGS</H2>
+
+Use the Bugzilla link off of the project web page or our mailing list.
+
+<B><A HREF="http://sources.redhat.com/systemtap/">http://sources.redhat.com/systemtap/</A></B>,<B><<A HREF="mailto:systemtap@sources.redhat.com">systemtap@sources.redhat.com</A>></B>.
+
+
+<P>
+<P>
+
+<HR>
+<A NAME="index"> </A><H2>Index</H2>
+<DL>
+<DT><A HREF="#lbAB">NAME</A><DD>
+<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
+<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
+<DT><A HREF="#lbAE">OPTIONS</A><DD>
+<DT><A HREF="#lbAF">ARGUMENTS</A><DD>
+<DT><A HREF="#lbAG">EXAMPLES</A><DD>
+<DT><A HREF="#lbAH">SAFETY AND SECURITY</A><DD>
+<DT><A HREF="#lbAI">SEE ALSO</A><DD>
+<DT><A HREF="#lbAJ">BUGS</A><DD>
+</DL>
+<HR>
+This document was created by
+<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
+using the manual pages.<BR>
+Time: 16:17:39 GMT, March 06, 2007
+</BODY>
+</HTML>
git://sourceware.org / systemtap-htdocs.git / commitdiff