summaryrefslogtreecommitdiffstats
path: root/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml
diff options
context:
space:
mode:
authorFrank Ch. Eigler <fche@elastic.org>2008-09-09 20:00:13 -0400
committerFrank Ch. Eigler <fche@elastic.org>2008-09-09 20:00:13 -0400
commit23b3bb31858e54b8a10ad570a3bc8ad49487d725 (patch)
tree0096ff3573baefdb7cffc55574266587e0e8283b /doc/SystemTap_Beginners_Guide/en-US/Scripts.xml
parent5ff217f44e1e069fcfbd59c27866afef35a61c9a (diff)
parent256d22cfb336b4cf0ec5b35bab89ca55ff5ce9ee (diff)
downloadsystemtap-steved-23b3bb31858e54b8a10ad570a3bc8ad49487d725.tar.gz
systemtap-steved-23b3bb31858e54b8a10ad570a3bc8ad49487d725.tar.xz
systemtap-steved-23b3bb31858e54b8a10ad570a3bc8ad49487d725.zip
Merge branch 'master' of ssh://sources.redhat.com/git/systemtap
* 'master' of ssh://sources.redhat.com/git/systemtap: Added tests for utrace-syscall probe context variables. Add $return context variables on per-process-syscall.return probes Add $argN context variables on per-process-syscall probes Add $name context variable support on marker probes Utrace on ia64 fast fetch-register support Add ia64 utrace support Correct this_section_offset calculation in _stp_kallsyms_lookup. tiny grammar fix in NEWS separated Scripts, edited accordingly PR1288: runtime functions for avoiding certain addresses remove test tag added content for Ch1 and 2, to add more later
Diffstat (limited to 'doc/SystemTap_Beginners_Guide/en-US/Scripts.xml')
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/Scripts.xml46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml
new file mode 100644
index 00000000..abb087bc
--- /dev/null
+++ b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml
@@ -0,0 +1,46 @@
+<?xml version='1.0'?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+
+<section id="scripts">
+ <title>SystemTap Scripts</title>
+
+ <para>
+ For the most part, SystemTap scripts are the foundation of each SystemTap session. The SystemTap scripts you use or write yourself instruct SystemTap on what type of information to trap, and what to do once that information is trapped.
+ </para>
+
+ <para>
+ As stated in <xref linkend="understanding-how-systemtap-works"/>, SystemTap scripts are made up of two components: <emphasis>events</emphasis> and <emphasis>handlers</emphasis>. Once a SystemTap session is underway, SystemTap monitors the operating system for the specified events and executes the handlers as they occur.
+ </para>
+
+<note>
+ <title>Note</title>
+ <para>An event and its corresponding handler is collectively called a <emphasis>probe</emphasis>. A SystemTap script can have multiple probes, in the same manner that each event can have multiple corresponding handlers.</para>
+</note>
+
+ <para>
+ In terms of application development, using events and handlers is similar to inserting <command>print</command> statements in a program's sequence of commands. These <command>print</command> statements allow you to view a history of commands executed once the program is run.
+ </para>
+
+ <para>
+ SystemTap scripts go one step further by allowing you more flexibility with regard to handlers. Events serve as the triggers for handlers to run; handlers can be specified to trap specified data and print it in a certain manner.
+ </para>
+
+
+
+ <section id="systemtapscript-format">
+ <title>Format</title>
+ <para>
+ SystemTap scripts use the following format:
+ </para>
+ </section>
+
+ <!-- <section id="SystemTap_Beginners_Guide-Test-Section_2_Test">
+ <title>Section 2 Test</title>
+ <para>
+ Test of a section
+ </para>
+ </section>-->
+
+</section>
+