blob: c96c3ae86f446a50ff5ebbcbbe56ed920e650a81 (
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Content-Language" content="en" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>user-init</title>
<meta name="Description" content="Script to initialize a user supervision tree." />
<meta name="Keywords" content="goetia prepare-svscan s6 s6-rc user supervision tree" />
</head>
<header>
<p>
<a href="//0x53.net/software/goetia/goetia-base">goetia-base</a>
<br />
<a href="//0x53.net/software/goetia">goetia</a>
<br />
<a href="//0x53.net/software">Software</a>
<br />
<a href="//0x53.net">0x53.net</a>
</p>
</header>
<body>
<h1>The user-init program</h1>
<p>
user-init starts a user supervision tree for
the user defined in the <code>USER</code>
environment variable.
</p>
<h2>Interface</h2>
<pre> user-init</pre>
<ul>
<li>
user-init takes no arguments.
</li>
<li>
It reads the <code>USER</code> environment variable,
if it is empty it exits 100.
</li>
<li>
It reads the <code>USERTREE</code> environment variable,
if it is empty it exits 100.
</li>
<li>
It reads the <code>BUNDLE</code> environment variable,
defaulting to <code>default</code> if empty.
</li>
<li>
It reads the <code>PATH</code> environment variable,
defaulting to
<code>/command:/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin:/usr/libexec:/usr/local/libexec</code>
if empty.
</li>
<li>
if <code>${USER}/${USERTREE}</code> subdirectory of the
<a href="//0x53.net/software/goetia/rundir.html">runtime directory</a>
olready existis, it exits 100.
</li>
<li>
It sets the <code>HOME</code> environment variable based on the result of
<a href="https://skarnet.org/software/execline/homeof.html">homeof</a>.
</li>
<li>
It prepends <code>${HOME}/.local/bin:</code> to the <code>PATH</code>
environment variable.
</li>
<li>
It sets the <code>UID</code>, <code>GID</code> and <code>GIDLIST</code>
environment variables using
<a href="https://skarnet.org/software/s6/s6-envuidgid.html">s6-envuidgid</a>.
</li>
<li>
It runs
<code><a href="./prepare-svscan.html">prepare-svscan</a></code>
with the proper arguments.
</li>
<li>
Finally, it executes into
<code><a href="https://skarnet.org/software/s6/s6-svscan.html">s6-svscan</a></code>
on the scandir represented by the
<code>${USER}/${USERTREE}/service</code>
subdirectory of the
<a href="//0x53.net/software/goetia/rundir.html#user">user runtime directory</a>.
</li>
</ul>
<h2>Exit codes</h2>
<ul>
<li>
100 if a critical environment variable is missing.
</li>
<li>
user-init usually executes into
<a href="https://skarnet.org/software/s6/s6-svscan.html">s6-svscan</a>
which exits according to its documentation.
</li>
<li>
Since user-init is an
<a href="https://skarnet.org/software/execline/">execline</a>
script, it exits with an approximation
of employed program that failed.
</li>
<li>
user-init mostly uses
<a href="https://skarnet.org/software/execline/">execline</a>
and
<a href="https://skarnet.org/software/s6/">s6</a>
software, the exit behaviour of which can be looked up on
their respective documentation.
</li>
<li>
See also:
<a href="https://skarnet.org/software/execline/exitcodes.html">execline exit code handling</a>.
</li>
</ul>
<h2>Options</h2>
<ul>
<li>
There are no otions to user-init.
</li>
</ul>
<h2>Notes</h2>
<p>
More information about user supervision trees
themselves can be found on the
<a href="//0x53.net/software/goetia/supervisiontree.html#user">user supervision tree</a>
page.
</p>
</body>
</html>
|
