]> TLD Linux GIT Repositories - rc-scripts.git/blob - doc/sysconfig.docb
- disable lock checks (happens on LUKS2 and fails during system boot)
[rc-scripts.git] / doc / sysconfig.docb
1 <refentry>
2   <refnamediv>
3     <refname>/etc/sysconfig/</refname>
4     <refpurpose>Basic system settings</refpurpose>
5   </refnamediv>
6   <refsect1>
7     <title><filename moreinfo="None">/etc/sysconfig/keyboard</filename></title>
8     <variablelist>
9       <varlistentry>
10         <term>KEYTABLE=&lt;keytable file&gt;</term>
11         <listitem><para>for example:
12             KEYTABLE="/usr/lib/kbd/keytables/us.map"</para>
13         </listitem>
14       </varlistentry>
15     </variablelist>
16   </refsect1>
17
18   <refsect1>
19     <title><filename moreinfo="None">/etc/sysconfig/mouse</filename></title>
20     <variablelist>
21       <varlistentry>
22         <term>MOUSETYPE=microsoft|mouseman|mousesystems|ps/2|msbm|logibm|atibm|
23           logitech|mmseries|mmhittab</term>
24         <listitem><para> </para>
25         </listitem>
26       </varlistentry>
27       <varlistentry>
28         <term>XEMU3=yes|no</term>
29         <listitem><para>(emulate three buttons with two buttons whenever
30             necessary, most notably in X)</para>
31         </listitem>
32       </varlistentry>
33     </variablelist>
34     <para>In addition, /dev/mouse points to the mouse device.</para>
35   </refsect1>
36   <refsect1>
37     <title><filename moreinfo="None">/etc/sysconfig/network</filename></title>
38     <variablelist>
39       <varlistentry><term>NETWORKING=yes|no</term>
40         <listitem><para>IPV6NETWORKING=yes|no</para>
41         </listitem>
42       </varlistentry>
43       <varlistentry><term>HOSTNAME=$&lt;whatever hostname you want&gt;</term>
44         <listitem><note><para> for compatibility with some old software people might
45               install (like trn), the /etc/HOSTNAME file should contain the
46               same value as here.</para></note>
47         </listitem>
48       </varlistentry>
49       <varlistentry><term>IGNORE_ICMP_BCAST_IPV4=yes|no</term>
50         <listitem><para>(Please note that if you accept ICMP echo
51             requests with a broadcast/multicast destination address your network
52             may be used as an exploder for denial of service packet flooding attacks
53             to other hosts.</para>
54         </listitem>
55       </varlistentry>
56       <varlistentry>
57         <term>SPOOFING_IPV4=yes|no</term>
58         <listitem>
59           <para>(anti spoofing protection)</para></listitem>
60       </varlistentry>
61
62       <varlistentry>
63         <term>GATEWAY=&lt;gateway IP&gt;</term>
64         <listitem>
65     <para>
66       </para>
67     
68         </listitem>
69       </varlistentry>
70
71       <varlistentry>
72         <term>GATEWAYDEV=&lt;gateway device&gt;</term>
73         <listitem>
74           <para>
75             (e.g. eth0)</para>
76         </listitem>
77       </varlistentry>
78
79       <varlistentry>
80         <term>NISDOMAIN=&lt;nis domain name></term>
81         <listitem>
82           <para></para>
83         </listitem>
84       </varlistentry>
85
86       <varlistentry>
87         <term>IPX=yes|no</term>
88         <listitem>
89     <para>
90       </para>
91         </listitem>
92       </varlistentry>
93
94       <varlistentry>
95         <term>IPXAUTOPRIMARY=on|off</term>
96         <listitem>
97     <para>
98        (note, that MUST be on|off, not yes|no)</para>
99         </listitem>
100       </varlistentry>
101
102       <varlistentry>
103         <term>IPXAUTOFRAME=on|off</term>
104         <listitem>
105     <para>
106        (again, not yes|no)</para>
107         </listitem>
108       </varlistentry>
109
110       <varlistentry>
111         <term>IPXINTERNALNETNUM=&lt;netnum></term>
112         <listitem>
113     <para>
114       </para>
115         </listitem>
116       </varlistentry>
117
118       <varlistentry>
119         <term>IPXINTERNALNODENUM=&lt;nodenum></term>
120         <listitem>
121     <para></para>
122         </listitem>
123       </varlistentry>
124     </variablelist>
125     <para>All the IPX stuff is optional, and should default to off.</para>
126   </refsect1>
127
128   <refsect1>
129     <title><filename>/etc/sysconfig/static-nat</filename></title>
130     <para>
131       Configuration file for static Network Address Translation (NAT).
132       Contains lines of the form:</para>
133     <para>
134 <literal>&lt;address> via &lt;addressreal></literal></para>
135     <para>
136       NAT will translate address &lt;address> to &lt;addressreal>.</para>
137   </refsect1>
138   <refsect1>
139     <title><filename>/etc/sysconfig/static-routes</filename></title>
140     <para>Contains lines of the form:</para>
141     <para><literal>&lt;device&gt; to [type] &lt;network&gt;/&lt;prefix&gt; via &lt;gateway&gt;</literal></para>
142     <para>&lt;device&gt; may be a device name to have the route brought up and
143       down with the device, or "none" if the route is not to be bound to any specific
144       device. [type] is optional. RH style isn't supported !</para>
145     <para>Also you can set few options after "&lt;gateway>":</para>
146       <simplelist columns=1>
147         <member>tos &lt;tos></member>
148         <member>metric &lt;number></member>
149         <member>table &lt;table></member>
150         <member>src &lt;address></member>
151         <member>realm &lt;realmid></member>
152         <member>mtu &lt;mtu> or mtu lock &lt;mtu></member>
153         <member>window &lt;number></member>
154         <member>rtt &lt;number></member>
155         <member>nexthop &lt;nexthop></member>
156         <member>scope &lt;scope></member>
157         <member>protocol &lt;rtproto></member>
158         <member>onlink</member>
159         <member>equalize</member>
160       </simplelist>
161
162     <para>For more informations see iproute2 documentation .</para>
163   </refsect1>
164
165   <refsect1>
166     <title><filename>/etc/sysconfig/static-routes6</filename></title>
167     <para>Same as <filename>/etc/sysconfig/static-routes</filename> but
168       for IPv6.</para>
169   </refsect1>
170
171   <refsect1>
172     <title><filename>/etc/sysconfig/routed</filename></title>
173     <simplelist>
174       <member>SILENT=yes|no</member>
175       <member>EXPORT_GATEWAY=yes|no</member>
176     </simplelist>
177   </refsect1>
178
179   <refsect1>
180     <title><filename>/etc/sysconfig/pcmcia</filename></title>
181     <simplelist>
182       <member>PCMCIA=yes|no</member>
183       <member>PCIC=i82365|tcic</member>
184       <member>PCIC_OPTS=&lt;socket driver (i82365 or tcic) timing parameters></member>
185       <member>CORE_OPTS=&lt;pcmcia_core options></member>
186       <member>CARDMGR_OPTS=&lt;cardmgr options></member>
187     </simplelist>
188   </refsect1>
189
190   <refsect1>
191     <title><filename>/etc/sysconfig/amd</filename></title>
192     <variablelist>
193       <varlistentry><term>ADIR=/.automount</term>
194         <listitem><para>(normally never changed)</para></listitem>
195       </varlistentry>
196       <varlistentry><term>MOUNTPTS='/net /etc/amd.conf'</term>
197         <listitem><para>(standard automount stuff)</para></listitem>
198       </varlistentry>
199       <varlistentry><term>AMDOPTS=</term>
200         <listitem><para>(extra options for AMD)</para></listitem>
201       </varlistentry>
202     </variablelist>
203   </refsect1>
204
205   <refsect1>
206     <title><filename moreinfo="None">/etc/sysconfig/tape</filename></title>
207     <variablelist>
208       <varlistentry><term>DEV=/dev/nst0</term>
209         <listitem>
210           <para>
211             Tape device.  Use the non-rewinding one for these scripts.</para>
212           <para>
213             For SCSI tapes this is /dev/nst#, where # is the number of the
214             tape drive you want to use.  If you only have one then use
215             nst0.</para>
216           <para> 
217             For IDE tapes you use /dev/ht#, where # is the number of the tape
218             drive you want to use (usually ht0).</para>
219           <para>
220             For floppy tape drives use /dev/ftape.</para>
221         </listitem>
222       </varlistentry>
223
224       <varlistentry><term>ADMIN=root</term>
225         <listitem><para>Person to mail to if the backup fails for any reason</para>
226         </listitem>
227       </varlistentry>
228
229       <varlistentry>
230         <term>SLEEP=5</term>
231         <listitem>
232 <para>
233     Time to sleep between tape operations.  Some drives need a bit
234     more than others, but 5 seems to work for 8mm, 4mm, and DLT</para>
235         </listitem>
236       </varlistentry>
237
238       <varlistentry>
239         <term>BLOCKSIZE=32768</term>
240         <listitem>
241     <para>
242     This worked fine for 8mm, then 4mm, and now DLT.  An optimal
243     setting is probably however much data your drive writes at one
244     time.</para>
245         </listitem>
246       </varlistentry>
247
248       <varlistentry>
249         <term>SHORTDATE=$(date +%y:%m:%d:%H:%M)</term>
250         <listitem>
251    <para>
252     A short date string, used in backup log filenames.</para>
253         </listitem>
254       </varlistentry>
255       
256
257       <varlistentry>
258         <term>DAY=$(date +log-%y:%m:%d)</term>
259         <listitem>
260      <para>
261     This is used for the log file directory.</para>
262         </listitem>
263       </varlistentry>
264
265       <varlistentry>
266         <term>DATE=$(date)</term>
267         <listitem>
268     <para>
269     Regular date string, used in log files.</para>
270         </listitem>
271       </varlistentry>
272
273       <varlistentry>
274         <term>LOGROOT=/var/log/backup</term>
275         <listitem>
276     <para>
277     Root of the logging directory</para>
278         </listitem>
279       </varlistentry>
280
281       <varlistentry>
282         <term>LIST=$LOGROOT/incremental-list</term>
283         <listitem>
284     <para>
285     This is the file name the incremental backup will use to store
286     the incremental list.  It will be $LIST-{some number}.
287     </para>
288         </listitem>
289       </varlistentry>
290
291       <varlistentry>
292         <term>DOTCOUNT=$LOGROOT/.count</term>
293         <listitem>
294     <para>
295     For counting as you go to know which incremental list to use
296     </para>
297         </listitem>
298       </varlistentry>
299
300
301       <varlistentry>
302         <term>COUNTER=$LOGROOT/counter-file</term>
303         <listitem>
304     <para>
305     For rewinding when done...might not use.
306     </para>
307         </listitem>
308       </varlistentry>
309
310       <varlistentry>
311         <term>BACKUPTAB=/etc/backuptab</term>
312         <listitem>
313     <para>
314     The file in which we keep our list of backup(s) we want to make.
315     </para>
316         </listitem>
317       </varlistentry>
318     </variablelist>
319   </refsect1>
320
321   <refsect1>
322     <title><filename>/etc/sysconfig/sendmail</filename></title>
323       <variablelist>
324         <varlistentry>
325           <term>DAEMON=yes|no</term>
326           <listitem>
327             <para>yes implies -bd</para>
328           </listitem>
329         </varlistentry>
330         <varlistentry>
331           <term>QUEUE=1h</term>
332           <listitem>
333             <para>given to sendmail as -q$QUEUE
334               -q option is not given to sendmail if /etc/sysconfig/sendmail
335               exists and QUEUE is empty or undefined.</para></listitem>
336         </varlistentry>
337       </variablelist>
338   </refsect1>
339
340   <refsect1>
341     <title><filename>/etc/sysconfig/i18n</filename></title>
342       <simplelist>
343         <member>LANG= can be any two letter ISO language code</member>
344         <member>
345           LC_ALL= is the setting of the localedata configuration (eg fr_CA)</member>
346         <member>
347           LINGUAS= can be a : separated list of language codes</member>
348         <member>
349           SYSTERM= use to set default TERM environment variable</member>
350       </simplelist>
351         <para>
352           The above three variables are used in rc.sysinit.</para>
353     <variablelist>
354       <varlistentry>
355         <term>SYSFONT= any font that is legal when used as</term>
356         <listitem>
357           <para>        /usr/sbin/setfont $SYSFONT ...
358     (See kbd package for sysfont command)
359 </para> </listitem>
360       </varlistentry>
361       <varlistentry>
362         <term>UNIMAP= any unicode font that is legal fodder for</term>
363         <listitem>
364           <para>/usr/sbin/setfont $SYSFONT-u $UNIMAP</para>
365         </listitem>
366       </varlistentry>
367     </variablelist>
368     <para>
369       The above is used by the /sbin/setsysfont command (which is run
370       by rc.sysinit at boot time).
371     </para>
372   </refsect1>
373
374   <refsect1>
375     <title><filename>/etc/sysconfig/\<service\></filename></title>
376     <para>
377       The following are used when starting service.
378     </para>
379       <variablelist>
380         <varlistentry>
381           <term>SERVICE_LIMITS="-u unlimited -c 0"</term>
382           <listitem>
383             <para>
384               System limits for this service.
385             </para>
386           </listitem>
387         </varlistentry>
388         <varlistentry>
389           <term>SERVICE_CPUSET="name"</term>
390           <listitem>
391             <para>
392               CPUSET to run this service in.
393             </para>
394           </listitem>
395         </varlistentry>
396         <varlistentry>
397           <term>SERVICE_UMASK="022"</term>
398           <listitem>
399             <para>
400               File creation mask for this service.
401             </para>
402           </listitem>
403         </varlistentry>
404         <varlistentry>
405           <term>SERVICE_RUN_NICE_LEVEL="0"</term>
406           <listitem>
407             <para>
408               Scheduling priority for this service.
409             </para>
410           </listitem>
411         </varlistentry>
412       </variablelist>
413   </refsect1>
414 </refentry>
415
416
417
418
419 <!-- to są informacje dla emacsa -->
420 <!-- Keep this comment at the end of the file
421 Local variables:
422 mode: sgml
423 sgml-omittag:nil
424 sgml-shorttag:nil
425 sgml-minimize-attributes:nil
426 sgml-always-quote-attributes:t
427 sgml-indent-step:2
428 sgml-indent-data:t
429 sgml-parent-document:"rc-scripts.docb"
430 sgml-default-dtd-file:nil
431 sgml-exposed-tags:nil
432 sgml-local-catalogs:nil
433 sgml-local-ecat-files:nil
434 sgml-declaration:nil
435 sgml-validate-command:"nsgmls -s %s %s"
436 End:
437 -->
438