summaryrefslogtreecommitdiff
path: root/doc/s6-dumpenv.html
blob: 6400d4729f15e992163eab7fe425df3ea3c282ba (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
<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>s6-portable-utils: the s6-dumpenv program</title>
    <meta name="Description" content="s6-portable-utils: the s6-dumpenv program" />
    <meta name="Keywords" content="s6-portable-utils command s6-dumpenv environment variables" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="index.html">s6-portable-utils</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>s6-dumpenv</tt> program </h1>

<p>
 s6-dumpenv stores its environment variables into a directory.
</p>

<h2> Interface </h2>

<pre>
     s6-dumpenv [ -N | -n ] [ -m <em>mode</em> ] <em>dir</em>
</pre>

<ul>
 <li> s6-dumpenv creates the directory <em>dir</em> if it does not exist
yet. </li>
 <li> For every environment variable <em>x</em> with value <em>y</em>
that it has, it creates a file <em>dir</em>/<em>x</em> containing
<em>y</em>. </li>
 <li> It then exits 0. </li>
</ul>

<h2> Options </h2>

<ul>
 <li> <tt>-N</tt>&nbsp;: chomp. Write the environment variables with an
extra newline at the end, so the environment can be retrieved via
<tt>s6-envdir -Lf <em>dir</em></tt>. </li>
 <li> <tt>-n</tt>&nbsp;: Write the environment variables as is; the
environment will be retrieved via <tt>s6-envdir -Lfn <em>dir</em></tt>.
This is the default. </li>
 <li> <tt>-m</tt>&nbsp;<em>mode</em>&nbsp;: create <em>dir</em> with
mode <em>mode</em> if it doesn't exist yet. Default is 0755. </li>
</ul>

<h2> Notes </h2>

<ul>
 <li> A program <em>prog</em> can be run with the environment in dir
by using <tt><a href="//skarnet.org/software/s6/s6-envdir.html">s6-envdir</a>
-fn -- <em>dir</em> <em>prog</em></tt>. </li>
</ul>

</body>
</html>