blob: 26ef3104012d7318dbc775f5f709215ade013f3b (
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
|
<!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-db</title>
<meta name="Description" content="Script to compile the user supervision tree database." />
<meta name="Keywords" content="goetia compile-db 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-db program</h1>
<p>
user-db compiles the
<a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">source directories</a>
of the
<a href="//0x53.net/software/goetia/confdir.html#user">user configuration directory</a>
into the <em>compiled</em> format.
This format can then be used by init and
<a href="./user-rc.html">user-rc</a>
to set up and control a
<a href="//0x53.net/software/goetia/supervisiontree.html#user">user supervision tree</a>.
</p>
<p>
user-db is a wrapper around the more general
<a href="./compile-db.html">compile-db</a>
making it target the user supervision tree.
</p>
<h2>Interface</h2>
<pre> user-db</pre>
<ul>
<li>
user-db 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>HOME</code> environment variable,
if it is empty it exits 100.
</li>
<li>
It runs compile-db supplementing it the correct
<a href="//0x53.net/software/goetia/confdir.html#user">user configuration directory</a>
and
<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>
Since user-db is a wrapper around compile-db, it
<a href="./compile-db.html">behaves exactly like it</a>.
</li>
</ul>
<h2>Options</h2>
<ul>
<li>
There are no options to user-db.
</li>
</ul>
</body>
</html>
|
