aboutsummaryrefslogtreecommitdiff
path: root/docs/shell_doc.md
blob: 6c655be8d198a53deba5009b2a349052050c9fef (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
## shell.array_literal

<pre>
shell.array_literal(<a href="#shell.array_literal-iterable">iterable</a>)
</pre>

Creates a string from a sequence that can be used as a shell array.

For example, `shell.array_literal(["a", "b", "c"])` would return the string
`("a" "b" "c")`, which can be used in a shell script wherever an array
literal is needed.

Note that all elements in the array are quoted (using `shell.quote`) for
safety, even if they do not need to be.


### Parameters

<table class="params-table">
  <colgroup>
    <col class="col-param" />
    <col class="col-description" />
  </colgroup>
  <tbody>
    <tr id="shell.array_literal-iterable">
      <td><code>iterable</code></td>
      <td>
        required.
        <p>
          A sequence of elements. Elements that are not strings will be
    converted to strings first, by calling `str()`.
        </p>
      </td>
    </tr>
  </tbody>
</table>


## shell.quote

<pre>
shell.quote(<a href="#shell.quote-s">s</a>)
</pre>

Quotes the given string for use in a shell command.

This function quotes the given string (in case it contains spaces or other
shell metacharacters.)


### Parameters

<table class="params-table">
  <colgroup>
    <col class="col-param" />
    <col class="col-description" />
  </colgroup>
  <tbody>
    <tr id="shell.quote-s">
      <td><code>s</code></td>
      <td>
        required.
        <p>
          The string to quote.
        </p>
      </td>
    </tr>
  </tbody>
</table>