blob: 1b285c6a1a363ad0b38e77b161c880fb0007c882 (
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
|
<!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>oneshot-make</title>
<meta name="Description" content="Helper script to generate s6-rc oneshot source directories from a commandline." />
<meta name="Keywords" content="goetia s6-rc oneshot source directory" />
</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 oneshot-make program</h1>
<p>
oneshot-make contains boilerplate code
required to create the
<a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">source directory</a>
of a oneshot service
based on strings.
</p>
<h2>Interface</h2>
<pre> oneshot-make <em>workingdir</em> <em>name</em> <em>upscript</em> <em>downscript</em> <em>dependencies</em></pre>
<ul>
<li>
<code><em>dependencies</em></code> can only be one of <code>"dependency1 dependency2 ..." | none</code>.
</li>
<li>
oneshot-make creates the directory <code><em>workingdir</em>/<em>name</em></code>
</li>
<li>
it creates the file <code><em>workingdir</em>/<em>name</em>/type</code>
and writes the line <code>oneshot</code> to it.
</li>
<li>
it creates the file <code><em>workingdir</em>/<em>name</em>/up</code>
and writes <code><em>upscript</em></code> to it.
</li>
<li>
it creates the file <code><em>workingdir</em>/<em>name</em>/down</code>
and writes <code><em>downscript</em></code> to it.
</li>
<li>
If <code><em>dependencies</em></code> is not <code>none</code>:
<ul>
<li>
The directory
<code><em>workingdir</em>/<em>name</em>/dependencies.d</code>
is created.
</li>
<li>
For each word <code>"dependency1 dependency2 ..."</code> in
<code><em>dependencies</em></code> separated by spaces,
a file
<code><em>workingdir</em>/<em>name</em>/dependencies.d/<em>dependency</em></code>
is created.
</li>
</ul>
</li>
</ul>
<h2>Exit codes</h2>
<ul>
<li>
0: success
</li>
<li>
Since oneshot-make is an
<a href="https://skarnet.org/software/execline/">execline</a>
script, it exits with an approximation
of employed program that failed.
</li>
<li>
oneshot-make 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 pages.
</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 oneshot-make.
</li>
</ul>
</body>
</html>
|
