Debian Codegraph @

doc/SystemTap_Tapset_Reference/man3/function::cmdline_args.3stap

raw
1 '\" t
2 .\" Title: function::cmdline_args
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: October 2025
6 .\" Manual: Context Functions
7 .\" Source: SystemTap Tapset Reference
8 .\" Language: English
9 .\"
10 .TH "FUNCTION::CMDLINE_AR" "3stap" "October 2025" "SystemTap Tapset Reference" "Context Functions"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 function::cmdline_args \- Fetch command line arguments from current process
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 cmdline_args:string(n:long,m:long,delim:string)
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 \fIn\fR
40 .RS 4
41 First argument to get (zero is normally the program itself)
42 .RE
43 .PP
44 \fIm\fR
45 .RS 4
46 Last argument to get (or minus one for all arguments after n)
47 .RE
48 .PP
49 \fIdelim\fR
50 .RS 4
51 String to use to separate arguments when more than one\&.
52 .RE
53 .SH "DESCRIPTION"
54 .PP
55 Returns arguments from the current process starting with argument number n, up to argument m\&. If there are less than n arguments, or the arguments cannot be retrieved from the current process, the empty string is returned\&. If m is smaller than n then all arguments starting from argument n are returned\&. Argument zero is traditionally the command itself\&.
56 .SH SEE ALSO\n
57 .IR tapset::context (3stap)