about summary refs log tree commit diff
path: root/doc/index.html
blob: dd932767a199f0462ec7b9f402e8560aefde99df (plain) (blame)
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
129
130
131
132
133
134
135
136
137
138
139
140
141
<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-linux-init - tools for a Linux init system</title>
    <meta name="Description" content="s6-linux-init - tools for a Linux init system" />
    <meta name="Keywords" content="s6 linux init administration root laurent bercot ska skarnet" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> s6-linux-init </h1>

<h2> What is it&nbsp;? </h2>

<p>
 s6-linux-init is a set of minimalistic tools to create a
<a href="//skarnet.org/software/s6/">s6</a>-based init
system, including a <tt>/sbin/init</tt> binary, on a Linux kernel.
</p>

<p>
 s6-linux-init is meant to automate creation of scripts revolving
around the use of other skarnet.org tools, especially s6, in order
to provide a complete booting environment with integrated supervision
and logging without having to hand-craft all the details.
</p>

<p>
 Please read the documentation for the
<a href="s6-linux-init-maker.html">s6-linux-init-maker</a> program
carefully, but if you're impatient, you can also read this
<a href="quickstart.html">quickstart guide</a>, which includes
a small FAQ.
</p>

<hr />

<h2> Installation </h2>

<h3> Requirements </h3>

<ul>
 <li> A Linux-based system with a standard C development environment </li>
 <li> GNU make, version 3.81 or later </li>
 <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version
2.6.0.0 or later </li>
 <li> <a href="//skarnet.org/software/execline/">execline</a> version
2.3.0.2 or later </li>
 <li> <a href="//skarnet.org/software/s6-portable-utils/">s6-portable-utils</a> version
2.2.1.1 or later </li>
 <li> <a href="//skarnet.org/software/s6-linux-utils/">s6-linux-utils</a> version
2.4.0.0 or later </li>
 <li> <a href="//skarnet.org/software/s6/">s6</a> version
2.6.1.0 or later </li>
</ul>

<p>
When you <em>build</em> s6-linux-init, the
 <a href="s6-linux-init-maker.html">s6-linux-init-maker</a> tool
is created (as well as the shutdown commands);
 then you <em>run</em> that tool to create an init script,
and then you can <em>boot</em> your system on that init script.
</p>

<p>
 skalibs is a <em>build-time</em> dependency. If you are linking binaries
against the shared version of the skalibs library, it also becomes a
<em>run-time</em> and <em>boot-time</em> dependency. <br />
 All the other listed packages are <em>boot-time</em> dependencies only.
</p>

<h3> Licensing </h3>

<p>
 s6-linux-init is free software. It is available under the
<a href="http://opensource.org/licenses/ISC">ISC license</a>.
</p>

<h3> Download </h3>

<ul>
 <li> The current released version of s6-linux-init is
<a href="s6-linux-init-0.3.1.0.tar.gz">0.3.1.0</a>. </li>
 <li> Alternatively, you can checkout a copy of the
<a href="//git.skarnet.org/cgi-bin/cgit.cgi/s6-linux-init/">s6-linux-init
git repository</a>:
<pre> git clone git://git.skarnet.org/s6-linux-init </pre> </li>
 <li> There's also a
<a href="https://github.com/skarnet/s6-linux-init">GitHub mirror</a>
of the s6-linux-init git repository. </li>
</ul>

<h3> Compilation </h3>

<ul>
 <li> See the enclosed INSTALL file for installation details. </li>
</ul>

<h3> Upgrade notes </h3>

<ul>
 <li> <a href="upgrade.html">This page</a> lists the differences to be aware of between
the previous versions of s6-linux-init and the current one. </li>
</ul>

<hr />

<h2> Reference </h2>

<h3> Commands </h3>

<p>
 All these commands exit 111 if they encounter a temporary error, and
100 if they encounter a permanent error - such as a misuse.
</p>

<ul>
<li><a href="s6-linux-init-maker.html">The <tt>s6-linux-init-maker</tt> program</a></li>
<li><a href="s6-halt.html">The <tt>s6-halt</tt> program</a></li>
<li><a href="s6-poweroff.html">The <tt>s6-poweroff</tt> program</a></li>
<li><a href="s6-reboot.html">The <tt>s6-reboot</tt> program</a></li>
</ul>

<h2> Related resources </h2>

<ul>
 <li> <tt>s6-linux-init</tt> is discussed on the
<a href="//skarnet.org/lists.html#skaware">skaware</a> mailing-list. </li>
 <li> There is a <tt>#s6</tt> IRC channel on Freenode. Sometimes people
are there and even answer questions. </li>
</ul>

</body>
</html>