summaryrefslogtreecommitdiff
path: root/doc/dollarat.html
blob: d9346fa00cf845531d6ebf8d75a0cdbe215022db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <meta http-equiv="Content-Language" content="en" />
 <title>execline: the $@ command</title>
 <meta name="Description" content="execline: the $@ command" />
 <meta name="Keywords" content="execline command $@" />
 <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
</head>
<body>

<p>
<a href="index.html">execline</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>$@</tt> program </h1>

<p>
<tt>$@</tt> prints the positional parameters of an execline script.
</p>

<h2> Interface </h2>

<pre>
     $@ [ -n ] [ -0 | -d <em>delimchar</em> ]
</pre>

<ul>
 <li> <tt>$@</tt> reads the number <em>n</em> of "positional
parameters" in the <tt>#</tt> environment variable. If that variable
is not set or does not contain a valid <em>n</em>, <tt>$@</tt>
exits 100. </li>
 <li> <tt>$@</tt> prints the value of the <tt>1</tt> environment
variable, then <em>delimchar</em>, then the value of the <tt>2</tt>
environment variable... and so on until <tt><em>n</em></tt>. If one of
these variables is not set, <tt>$@</tt> exits 100. </li>
 <li> If everything runs OK, <tt>$@</tt> exits 0. This makes it
one of the rare "exiting" execline commands. </li>
</ul>

<h2> Options </h2>

<ul>
 <li> <tt>-n</tt>&nbsp;: <em>chomp</em>. Do not print the last
<em>delimchar</em>. </li>
 <li> <tt>-d</tt>&nbsp;<em>delimchar</em>&nbsp;: use the character
<em>delimchar</em> as separator between the arguments. Default: <tt>\n</tt>.
If <em>delimchar</em> has more than one character, only the first one is
used. If <em>delimchar</em> is the empty string, then <tt>$@</tt>
will output the positional parameters as a
<a href="el_transform.html#netstrings">sequence of netstrings</a> (and the
<tt>-n</tt> option will be ignored). </li>
 <li> <tt>-0</tt>&nbsp;: use the null character as separator. Any <tt>-d</tt>
argument will be ignored. Warning: this option should only be used to feed
data to programs that know how to handle null-separated lists. </li>
</ul>

<h2> Notes </h2>

<ul>
 <li> The <tt>$@</tt> word gets interpreted by execline as the list of
all positional parameters. To make sure it's not substituted, and
correctly refers to the <tt>$@</tt> command, make sure to escape the
<tt>$</tt> character in execline scripts: <tt>\\$@</tt>. </li>
 <li> You can use <tt>$@&nbsp;-d&nbsp;""</tt> along with the
<a href="forbacktickx.html">forbacktickx</a> command to reliably loop
over the positional parameters:
<pre>
 #!/command/execlineb
 forbacktickx -d "" ARG { \\$@ -d "" }
 dosomething $ARG
</pre>

 will call <tt>dosomething</tt> in turn on each argument to the script.
That will work even if those arguments contain spaces, newlines,
or other fancy characters. </li>

 <li> Alternatively, instead of encoding data into a netstring, you can
use a null-separated list, which will work the same way:
<pre>
 #!/command/execlineb
 forbacktickx -0 ARG { \\$@ -0 }
 dosomething $ARG
</pre> </li>
</ul>

</body>
</html>