Mercurial > vanilla

comparison core/rc/rc.conf.5 @ 585:75c8521c9b7a

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