summaryrefslogtreecommitdiffstats
path: root/doc/bin/user-run.html
blob: 924849c05bd6ea2f125832ac5566fcbb58bc8e4b (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
<!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-run</title>
    	<meta name="Description" content="Run little scripts from the user supervision tree, providing reliability." />
    	<meta name="Keywords" content="goetia s6 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-run program</h1>
		<p>
			The user-run program allows
			to hand over the execution of commands to the
			<a href="//0x53.net/software/goetia/supervisiontree.html#user">user supervision tree</a>.
		</p>
		<h2>Interface</h2>
		<pre>     user-run <em>prog...</em></pre>
		<ul>
			<li>
    			user-rc 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>
    			Internally, user-run invokes
				<a href="https://skarnet.org/software/s6/s6-sudo.html">s6-sudo</a>
				to connect to an
				<a href="https://skarnet.org/software/s6/s6-sudod.html">s6-sudod</a>
				instance provided by the user
				<a href="//0x53.net/software/goetia/service/user/goetia-runner.html">goetia-runner</a>.
			</li>
			<li>
    			<code><em>prog...</em></code> is then transferred
				to and executed by goetia-runner.
			</li>
			<li>
    			See
				<a href="https://skarnet.org/software/s6/s6-sudo.html">s6-sudo</a>
				and
				<a href="https://skarnet.org/software/s6/s6-sudod.html">s6-sudod</a>
				for configuration options and detailed information.
			</li>
		</ul>
		<h2>Exit codes</h2>
		<ul>
			<li>
    			100 if a critical environment variable is missing.
			</li>
			<li>
    			user-run behaves exactly as
				<a href="https://skarnet.org/software/s6/s6-sudo.html">s6-sudo</a>.
			</li>
		</ul>
		<h2>Options</h2>
		<ul>
			<li>
    			user-run takes the exact same options as
				<a href="https://skarnet.org/software/s6/s6-sudoc.html">s6-sudoc</a>.
			</li>
		</ul>
	</body>
</html>