Update 'check' rationale.
[linux_from_scratch.git] / chapter07 / bootscripts.xml
blob0b163b2cb6192e789e3953ed2e9da1d640b165ea
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4   <!ENTITY % general-entities SYSTEM "../general.ent">
5   %general-entities;
6 ]>
8 <sect1 id="ch-scripts-bootscripts" role="wrap" revision="sysv">
9   <?dbhtml filename="bootscripts.html"?>
11   <sect1info condition="script">
12     <productname>bootscripts</productname>
13     <productnumber>&lfs-bootscripts-version;</productnumber>
14     <address>&lfs-bootscripts-url;</address>
15   </sect1info>
17   <title>LFS-Bootscripts-&lfs-bootscripts-version;</title>
19   <indexterm zone="ch-scripts-bootscripts">
20     <primary sortas="a-Bootscripts">Bootscripts</primary>
21   </indexterm>
23   <sect2 role="package">
24     <title/>
26     <para>The LFS-Bootscripts package contains a set of scripts to start/stop
27     the LFS system at bootup/shutdown.  
28     The configuration files and procedures needed to
29     customize the boot process are described in the following sections.</para>
31     <segmentedlist>
32       <segtitle>&buildtime;</segtitle>
33       <segtitle>&diskspace;</segtitle>
35       <seglistitem>
36         <seg>&lfs-bootscripts-ch7-sbu;</seg>
37         <seg>&lfs-bootscripts-ch7-du;</seg>
38       </seglistitem>
39     </segmentedlist>
41   </sect2>
43   <sect2 role="installation">
44     <title>Installation of LFS-Bootscripts</title>
46     <para>Install the package:</para>
48 <screen><userinput remap="install">make install</userinput></screen>
50   </sect2>
52   <sect2 id="contents-bootscripts" role="content">
53     <title>Contents of LFS-Bootscripts</title>
54     <segmentedlist>
55       <segtitle>Installed scripts</segtitle>
56       <segtitle>Installed directories</segtitle>
58       <seglistitem>
59         <seg>checkfs, cleanfs, console, functions, halt, ifdown,
60         ifup, localnet, modules, mountfs, mountvirtfs, network, rc, reboot,
61         sendsignals, setclock, ipv4-static, swap, sysctl, sysklogd, template,
62         udev, and udev_retry</seg>
63         <seg>/etc/rc.d, /etc/init.d (symbolic link), /etc/sysconfig,
64         /lib/services, /lib/lsb (symbolic link)</seg>
65       </seglistitem>
66     </segmentedlist>
68     <variablelist>
69       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
70       <?dbfo list-presentation="list"?>
71       <?dbhtml list-presentation="table"?>
73       <varlistentry id="checkfs-bootscripts">
74         <term><command>checkfs</command></term>
75         <listitem>
76           <para>Checks the integrity of the file systems before they are mounted
77           (with the exception of journal and network based file systems)</para>
78           <indexterm zone="ch-scripts-bootscripts checkfs-bootscripts">
79             <primary sortas="d-checkfs">checkfs</primary>
80           </indexterm>
81         </listitem>
82       </varlistentry>
84       <varlistentry id="cleanfs-bootscripts">
85         <term><command>cleanfs</command></term>
86         <listitem>
87           <para>Removes files that should not be preserved between reboots, such
88           as those in <filename class="directory">/var/run/</filename> and
89           <filename class="directory">/var/lock/</filename>; it re-creates
90           <filename>/var/run/utmp</filename> and removes the possibly present
91           <filename>/etc/nologin</filename>, <filename>/fastboot</filename>, and
92           <filename>/forcefsck</filename> files</para>
93           <indexterm zone="ch-scripts-bootscripts cleanfs-bootscripts">
94             <primary sortas="d-cleanfs">cleanfs</primary>
95           </indexterm>
96         </listitem>
97       </varlistentry>
99       <varlistentry id="console-bootscripts">
100         <term><command>console</command></term>
101         <listitem>
102           <para>Loads the correct keymap table for the desired keyboard layout;
103           it also sets the screen font</para>
104           <indexterm zone="ch-scripts-bootscripts console-bootscripts">
105             <primary sortas="d-console">console</primary>
106           </indexterm>
107         </listitem>
108       </varlistentry>
110       <varlistentry id="functions-bootscripts">
111         <term><command>functions</command></term>
112         <listitem>
113           <para>Contains common functions, such as error and status checking,
114           that are used by several bootscripts</para>
115           <indexterm zone="ch-scripts-bootscripts functions-bootscripts">
116             <primary sortas="d-functions">functions</primary>
117           </indexterm>
118         </listitem>
119       </varlistentry>
121       <varlistentry id="halt-bootscripts">
122         <term><command>halt</command></term>
123         <listitem>
124           <para>Halts the system</para>
125           <indexterm zone="ch-scripts-bootscripts halt-bootscripts">
126             <primary sortas="d-halt">halt</primary>
127           </indexterm>
128         </listitem>
129       </varlistentry>
131       <varlistentry id="ifdown-bootscripts">
132         <term><command>ifdown</command></term>
133         <listitem>
134           <para>Stops a network device</para>
135           <indexterm zone="ch-scripts-bootscripts ifdown-bootscripts">
136             <primary sortas="d-ifdown">ifdown</primary>
137           </indexterm>
138         </listitem>
139       </varlistentry>
141       <varlistentry id="ifup-bootscripts">
142         <term><command>ifup</command></term>
143         <listitem>
144           <para>Initializes a network device</para>
145           <indexterm zone="ch-scripts-bootscripts ifup-bootscripts">
146             <primary sortas="d-ifup">ifup</primary>
147           </indexterm>
148         </listitem>
149       </varlistentry>
151       <varlistentry id="localnet-bootscripts">
152         <term><command>localnet</command></term>
153         <listitem>
154           <para>Sets up the system's hostname and local loopback device</para>
155           <indexterm zone="ch-scripts-bootscripts localnet-bootscripts">
156             <primary sortas="d-localnet">localnet</primary>
157           </indexterm>
158         </listitem>
159       </varlistentry>
161       <varlistentry id="modules-bootscripts">
162         <term><command>modules</command></term>
163         <listitem>
164           <para>Loads kernel modules listed in
165           <filename>/etc/sysconfig/modules</filename>, using arguments
166           that are also given there</para>
167           <indexterm zone="ch-scripts-bootscripts modules-bootscripts">
168             <primary sortas="d-modules">modules</primary>
169           </indexterm>
170         </listitem>
171       </varlistentry>
173       <varlistentry id="mountfs-bootscripts">
174         <term><command>mountfs</command></term>
175         <listitem>
176           <para>Mounts all file systems, except ones that are marked
177           <emphasis>noauto</emphasis> or are network based</para>
178           <indexterm zone="ch-scripts-bootscripts mountfs-bootscripts">
179             <primary sortas="d-mountfs">mountfs</primary>
180           </indexterm>
181         </listitem>
182       </varlistentry>
184       <varlistentry id="mountvirtfs-bootscripts">
185         <term><command>mountvirtfs</command></term>
186         <listitem>
187           <para>Mounts virtual kernel file systems, such as <systemitem
188           class="filesystem">proc</systemitem></para>
189           <indexterm zone="ch-scripts-bootscripts mountvirtfs-bootscripts">
190             <primary sortas="d-mountvirtfs">mountvirtfs</primary>
191           </indexterm>
192         </listitem>
193       </varlistentry>
195       <varlistentry id="network-bootscripts">
196         <term><command>network</command></term>
197         <listitem>
198           <para>Sets up network interfaces, such as network cards, and sets up
199           the default gateway (where applicable)</para>
200           <indexterm zone="ch-scripts-bootscripts network-bootscripts">
201             <primary sortas="d-network">network</primary>
202           </indexterm>
203         </listitem>
204       </varlistentry>
206       <varlistentry id="rc-bootscripts">
207         <term><command>rc</command></term>
208         <listitem>
209           <para>The master run-level control script; it is responsible for
210           running all the other bootscripts one-by-one, in a sequence determined
211           by the name of the symbolic links being processed</para>
212           <indexterm zone="ch-scripts-bootscripts rc-bootscripts">
213             <primary sortas="d-rc">rc</primary>
214           </indexterm>
215         </listitem>
216       </varlistentry>
218       <varlistentry id="reboot-bootscripts">
219         <term><command>reboot</command></term>
220         <listitem>
221           <para>Reboots the system</para>
222           <indexterm zone="ch-scripts-bootscripts reboot-bootscripts">
223             <primary sortas="d-reboot">reboot</primary>
224           </indexterm>
225         </listitem>
226       </varlistentry>
228       <varlistentry id="sendsignals-bootscripts">
229         <term><command>sendsignals</command></term>
230         <listitem>
231           <para>Makes sure every process is terminated before the system reboots
232           or halts</para>
233           <indexterm zone="ch-scripts-bootscripts sendsignals-bootscripts">
234             <primary sortas="d-sendsignals">sendsignals</primary>
235           </indexterm>
236         </listitem>
237       </varlistentry>
239       <varlistentry id="setclock-bootscripts">
240         <term><command>setclock</command></term>
241         <listitem>
242           <para>Resets the kernel clock to local time in case the hardware clock
243           is not set to UTC time</para>
244           <indexterm zone="ch-scripts-bootscripts setclock-bootscripts">
245             <primary sortas="d-setclock">setclock</primary>
246           </indexterm>
247         </listitem>
248       </varlistentry>
250       <varlistentry id="ipv4-static-bootscripts">
251         <term><command>ipv4-static</command></term>
252         <listitem>
253           <para>Provides the functionality needed to assign a static Internet
254           Protocol (IP) address to a network interface</para>
255           <indexterm zone="ch-scripts-bootscripts ipv4-static-bootscripts">
256             <primary sortas="d-ipv4-static">ipv4-static</primary>
257           </indexterm>
258         </listitem>
259       </varlistentry>
261       <varlistentry id="swap-bootscripts">
262         <term><command>swap</command></term>
263         <listitem>
264           <para>Enables and disables swap files and partitions</para>
265           <indexterm zone="ch-scripts-bootscripts swap-bootscripts">
266             <primary sortas="d-swap">swap</primary>
267           </indexterm>
268         </listitem>
269       </varlistentry>
271       <varlistentry id="sysctl-bootscripts">
272         <term><command>sysctl</command></term>
273         <listitem>
274           <para>Loads system configuration values from
275           <filename>/etc/sysctl.conf</filename>, if that file exists,
276           into the running kernel</para>
277           <indexterm zone="ch-scripts-bootscripts sysctl-bootscripts">
278             <primary sortas="d-sysctl">sysctl</primary>
279           </indexterm>
280         </listitem>
281       </varlistentry>
283       <varlistentry id="sysklogd-bootscripts">
284         <term><command>sysklogd</command></term>
285         <listitem>
286           <para>Starts and stops the system and kernel log daemons</para>
287           <indexterm zone="ch-scripts-bootscripts sysklogd-bootscripts">
288             <primary sortas="d-sysklogd">sysklogd</primary>
289           </indexterm>
290         </listitem>
291       </varlistentry>
293       <varlistentry id="template-bootscripts">
294         <term><command>template</command></term>
295         <listitem>
296           <para>A template to create custom bootscripts for other
297           daemons</para>
298           <indexterm zone="ch-scripts-bootscripts template-bootscripts">
299             <primary sortas="d-template">template</primary>
300           </indexterm>
301         </listitem>
302       </varlistentry>
304       <varlistentry id="udev-bootscripts">
305         <term><command>udev</command></term>
306         <listitem>
307           <para>Prepares the <filename class="directory">/dev</filename>
308           directory and starts Udev</para>
309           <indexterm zone="ch-scripts-bootscripts udev-bootscripts">
310             <primary sortas="d-udev">udev</primary>
311           </indexterm>
312         </listitem>
313       </varlistentry>
315       <varlistentry id="udev-retry-bootscripts">
316         <term><command>udev_retry</command></term>
317         <listitem>
318           <para>Retries failed udev uevents, and copies generated rules
319           files from <filename class="directory">/run/udev</filename> to
320           <filename class="directory">/etc/udev/rules.d</filename> if required</para>
321           <indexterm zone="ch-scripts-bootscripts udev-retry-bootscripts">
322             <primary sortas="d-udev-retry">udev_retry</primary>
323           </indexterm>
324         </listitem>
325       </varlistentry>
327     </variablelist>
329   </sect2>
331 </sect1>