Mercurial > vanilla
annotate core/rc/rc.conf.5 @ 585:75c8521c9b7a
core/rc: add initial documentation
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 08 Jul 2019 20:30:00 +0200 |
parents | |
children | 58211c615a8c |
rev | line source |
---|---|
585
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 .\" |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 .\" Copyright (c) 2019 David Demelier <markand@malikania.fr> |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 .\" |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 .\" Permission to use, copy, modify, and/or distribute this software for any |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 .\" purpose with or without fee is hereby granted, provided that the above |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 .\" copyright notice and this permission notice appear in all copies. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 .\" |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 .\" |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 .Dd July 08, 2019 |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 .Dt RC.CONF 5 |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 .Os |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 .Sh NAME |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 .Nm rc.conf |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 .Nd system configuration |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 .Sh DESCRIPTION |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 The file |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 .Nm |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 contains information about the system. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 .Pp |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 It is evaluated at boot time when |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 .Pa /etc/rc.init |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 is started from init and performs initialization. The file is sourced from a |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 shell script and therefore can contain shell code. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 .Pp |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 The following options are available: |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 .Bl -tag -width indent-two |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 .It Va HOSTNAME |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 Sets the machine hostname. (Default: localhost) |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 .It Va TIMEZONE |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 Sets the time zone. You can get a list of timezones in the |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 .Pa /share/zoneinfo |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 directory. The variable must be in the form |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 .Ar Area/Region . |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 (Default: empty) |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 .It Va SERVICES |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 This variable contains services to be started at boot. In Vanilla, services have |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 no dependencies and therefore user is responsible of starting them is a specific |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 order if needed. Thus, services marked in this list separated by spaces are |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 executed in order. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 .Pp |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 Services names are in the form |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 .Ar name[:N] |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 where name is the actual service file located in |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 .Pa /etc/rc.d |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 directory. The optional |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 .Ar N |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 argument is the minimal runlevel number required to start this service. For |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 example, a value of 3 means that the service will be started only if the desired |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 runlevel is 3 or higher. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 .Pp |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 Some services offer tunables to pass additional configuration to them. See the |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 service file header for more information. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 .Pp |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 Note: don't forget to mark the service file as executable or it won't be |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 executed by init process. (Default: empty) |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 .It Va FONT |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 Sets the console font. A list is available in /share/kbd/consolefonts. (Default: |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 empty). |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 .Pp |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 Note: this requires package |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 .Ar kbd |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 to be installed. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 .It Va KEYMAP |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 Sets the console keymap. A list is available in /share/kbd/keymaps. (Default: |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 empty). |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 .Pp |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 Note: this requires package |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 .Ar kbd |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 to be installed. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 .El |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 .Sh EXAMPLES |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 .Ss Starting sysklogd package |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 In this example we will start |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 .Ar sysklogd |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 from the runlevel 2 and higher. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
83 .Pp |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
84 The |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 .Ar sysklogd |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 package understand the variable |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
87 .Va SYSKLOGD_ARGS |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
88 and may be used instead. However, please note that setting this variable replace |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 the original arguments so double check the service file before setting any |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
90 variable. |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
91 .Bd -literal |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
92 SYSKLOGD_ARGS="-4" |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
93 SERVICES="sysklogd:2" |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
94 .Ed |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
95 .Sh SEE ALSO |
75c8521c9b7a
core/rc: add initial documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
96 .Xr rc 7 |