| 1 |
.\" -*- nroff -*- |
| 2 |
.TH STAPVARS 3stap |
| 3 |
.SH NAME |
| 4 |
stapvars \- systemtap variables |
| 5 |
|
| 6 |
.SH DESCRIPTION |
| 7 |
The following sections enumerate the public variables provided by |
| 8 |
standard tapsets installed, (the installation path is show in the |
| 9 |
stappaths (7) manual page). Each variable is described with a |
| 10 |
type, and its behavior/restrictions. |
| 11 |
The syntax is the same as printed with the |
| 12 |
.IR stap " option " \-p2 . |
| 13 |
Examples: |
| 14 |
|
| 15 |
.TP |
| 16 |
example1:long |
| 17 |
Variable "example1" contains an integer. |
| 18 |
|
| 19 |
.TP |
| 20 |
example2:string [long] |
| 21 |
Variable "example2" is an array of strings, indexed by integers. |
| 22 |
|
| 23 |
.SS ARGV |
| 24 |
|
| 25 |
.TP |
| 26 |
argc:long |
| 27 |
Contains the value of the |
| 28 |
.BR |
| 29 |
$# |
| 30 |
value: the number of command line arguments passed to the systemtap script. |
| 31 |
It is initialized with an implicit begin(\-1) probe. |
| 32 |
|
| 33 |
.TP |
| 34 |
argv:string [long] |
| 35 |
Contains each command line argument as a string. argv[1] will equal @1 if |
| 36 |
there was at least one command line argument. Arguments beyond #32 are not |
| 37 |
transcribed, and produce a warning message within the begin(\-1) probe that |
| 38 |
initializes this array. |
| 39 |
|
| 40 |
.SS NULL |
| 41 |
|
| 42 |
.TP |
| 43 |
NULL:long |
| 44 |
Simply defined as the number 0. |
| 45 |
|
| 46 |
.SH FILES |
| 47 |
.TP |
| 48 |
More files and their corresponding paths can be found in the stappaths (7) manual page. |
| 49 |
|
| 50 |
.SH SEE ALSO |
| 51 |
.nh |
| 52 |
.nf |
| 53 |
.IR stap (1) |
| 54 |
.IR stappaths (7) |