summaryrefslogtreecommitdiffstats
path: root/stap.1.in
diff options
context:
space:
mode:
authorCharley Wang <chwang@redhat.com>2010-02-25 16:25:22 -0500
committerCharley Wang <chwang@redhat.com>2010-02-25 16:25:22 -0500
commit7f0cd081c315cc421e62f2f639817e1abecb9c4c (patch)
tree3a47653b90732ffeac645b80819002a0ea51b666 /stap.1.in
parent4bfb04268d548c4d711784de6b129aef2fc1577b (diff)
downloadsystemtap-steved-7f0cd081c315cc421e62f2f639817e1abecb9c4c.tar.gz
systemtap-steved-7f0cd081c315cc421e62f2f639817e1abecb9c4c.tar.xz
systemtap-steved-7f0cd081c315cc421e62f2f639817e1abecb9c4c.zip
PR11224: Documentation for module arguments
Diffstat (limited to 'stap.1.in')
-rw-r--r--stap.1.in15
1 files changed, 12 insertions, 3 deletions
diff --git a/stap.1.in b/stap.1.in
index 7c62205b..1d9acadb 100644
--- a/stap.1.in
+++ b/stap.1.in
@@ -407,15 +407,23 @@ namespace for all global variables, regardless of which script file
they are found within. A global declaration may be written at the
outermost level anywhere, not within a block of code. Global
variables which are written but never read will be displayed
-automatically at session shutdown. The following
-declaration marks a few variables as global. The translator will
+automatically at session shutdown. The translator will
infer for each its value type, and if it is used as an array, its key
types. Optionally, scalar globals may be initialized with a string
-or number literal.
+or number literal. The following declaration marks variables as global.
.RS
.BR global " var1" , " var2" , " var3=4"
.RE
.PP
+Global variables can also be set as module options. To do this, the
+module must first be compiled using stap \-p4. Global variables can
+then be set on the command line when calling staprun on the
+module generated by stap \-p4. See
+.IR staprun (8)
+for more information.
+.RS
+.RE
+.PP
Arrays are limited in size by the MAXMAPENTRIES variable -- see the
.B SAFETY AND SECURITY
section for details. Optionally, global arrays may be declared with a
@@ -1258,6 +1266,7 @@ unloading.
.SH SEE ALSO
.IR stapprobes (3stap),
.IR stapfuncs (3stap),
+.IR staprun (8),
.IR stapvars (3stap),
.IR stapex (3stap),
.IR stap-client (8),