summaryrefslogtreecommitdiff
path: root/rc.conf.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'rc.conf.5.txt')
-rw-r--r--rc.conf.5.txt245
1 files changed, 123 insertions, 122 deletions
diff --git a/rc.conf.5.txt b/rc.conf.5.txt
index 25b0f6e..556d223 100644
--- a/rc.conf.5.txt
+++ b/rc.conf.5.txt
@@ -20,210 +20,211 @@ as time zone, keymap, kernel modules, daemons to load at start-up, etc. It is
split up in a few sections to categorize configuration settings: localization,
hardware, networking, and daemons.
-LOCALIZATION[[L]]
------------------
-*TIMEZONE=*
+DAEMONS[[D]]
+------------
+*DAEMONS=*
-Specifies the time zone. The setting takes effect on boot by ensuring that /etc/localtime is a symlink
-to the correct zoneinfo file. Possible time zones are the relative path to a zoneinfo file starting
-from the directory /usr/share/zoneinfo. For example, a German time zone would be Europe/Berlin,
-which refers to the file /usr/share/zoneinfo/Europe/Berlin.
+Daemons to start at boot-up (in this order)
-Note: If empty, /etc/localtime is not changed. This is useful if /etc/localtime is maintained manually
-or by a third-party tool, or if there is no reason to change it from what was set during install.
+ - prefix a daemon with a ! to disable it
+ - prefix a daemon with a @ to start it up in the background
-Default: empty
+If you are sure nothing else touches your hardware clock (such as ntpd or
+by dual-booting), you might want to enable 'hwclock'. Note that this will only
+make a difference if the hwclock program has been calibrated correctly.
-*HARDWARECLOCK=*
+If you use a network filesystem, you should enable 'netfs'.
-How to interpret/update the hardware clock. (used by hwclock)
+ DAEMONS=('syslog-ng' 'network' 'crond')
-Options:
+STORAGE[[S]]
+------------
+*USEDMRAID=*
- - empty: fall back to the value in /var/lib/hwclock/adjtime, which defaults to UTC. This is recommended
- as other users of hwclock might change the adjtime file and hence cause rc.conf and adjtime to be out of sync.
- - "UTC": most robust, allows operating systems to abstract local time and ease DST.
- - "localtime": apply time zone (and DST) in hardwareclock: discouraged.
- Choose this if you dual-boot with an OS which cannot handle UTC BIOS times correctly, like Windows (note
- that recent Windows versions can use UTC, which is preferable).
- - any other value will result in the hardware clock being left untouched (useful for virtualization)
+Scan for FakeRAID (dmraid) volumes at start-up.
-Default: empty
+Default: 'no'
-*KEYMAP=*
+ USEDMRAID="yes"
-Defines the keymap to load with the loadkeys program on boot. Possible keymaps are
-found in /usr/share/kbd/keymaps. Please note that this setting is only valid for
-your TTYs, not any graphical window managers or X. KEYMAP in /etc/vconsole.conf takes
-precedence.
+*USELVM=*
-Default: empty
+Scan for LVM volume groups at start-up. This is required if you use LVM.
-*CONSOLEFONT=*
+Default: 'no'
-Defines the console font to load with the setfont program on boot.
-Possible fonts are found in /usr/share/kbd/consolefonts (only needed for non-US).
-FONT in /etc/vconsole.conf takes precedence.
+ USELVM="yes"
-Default: empty
+NETWORKING[[N]]
+---------------
-*CONSOLEMAP=*
+*HOSTNAME=*
-Defines the console map to load with the setfont program on boot. Possible maps are found in
-/usr/share/kbd/consoletrans. Set this to a map suitable for the appropriate locale (8859-1 for Latin1,
-for example) if you're using an UTF-8 locale and use programs that generate 8-bit output. If you're
-using X11 for everyday work, don't bother, as it only affects the output of Linux console applications.
-FONT_MAP in /etc/vconsole.conf takes precedence.
+Hostname of machine. Unless nss-myhostname is used, this should also be set in /etc/hosts.
-Default: empty
+The contents of /etc/hostname (if not empty) takes precedence (see hostname(5)), and is recommended.
-*LOCALE=*
+ HOSTNAME="arch1"
-This sets your system language, which will be used by all i18n-friendly applications and utilities.
-See `locale -a` (or locale.gen) for available options. LANG in /etc/locale.conf takes precedence.
-If unset, it falls back to the C locale.
+The following settings are used by the 'network' daemon.
-Default: empty
+*interface=*
-*DAEMON_LOCALE=*
+Name of device. Use `ip addr` or `ls /sys/class/net/` to see all available interfaces.
- - If set to 'yes', use $LOCALE as the locale during daemon start-up and during the boot process.
- - If set to 'no', the C locale is used.
+Required for manual configuration. If using DHCP, it can be left unset, see dhcpcd(5) for details.
-Default: "yes"
+*address=*
-*USECOLOR=*
+IP address.
-Use ANSI color sequences in start-up messages
+Required for manual configuration. If left empty, DHCP will be used.
-Default: "yes"
+*netmask=*
-HARDWARE[[H]]
--------------
-*MODULES=*
+Subnet mask.
-Modules to load at boot-up. To blacklist modules, see 'man 5 modprobe.d'. See also
-'man 5 modules-load.d'.
+Defaults to 255.255.255.0. Ignored when using DHCP.
-Default: ().
+*broadcast=*
-*USEDMRAID=*
+Broadcast address.
-Scan for FakeRAID (dmraid) volumes at start-up.
+Optional for manual configuration, ignored for DHCP.
-Default: "no"
+*gateway=*
-*USEBTRFS=*
+Default route.
-Scan for Btrfs volumes at start-up.
+Required for manual configuration, ignored for DHCP.
-Default: "no"
+*Static IP example*
-*USELVM=*
+ interface=eth0
+ address=192.168.0.2
+ netmask=255.255.255.0
+ broadcast=192.168.0.255
+ gateway=192.168.0.1
-Scan for LVM volume groups at start-up. This is required if you use LVM.
+*DHCP example*
-Default: "no"
+ interface=
+ address=
+ netmask=
+ gateway=
-NETWORKING[[N]]
----------------
-*HOSTNAME=*
+*NETWORK_PERSIST=*
-Hostname of machine. Should also be put in /etc/hosts. The contents of
-/etc/hostname (if not empty) takes precedence.
+Setting this to "yes" will skip network shutdown. This is required if your root device is on NFS.
-Default: empty
+Default: 'no'
-The following settings help you setting up a wired network.
+ NETWORK_PERSIST="yes"
-*interface=*
+LOCALIZATION[[L]]
+-----------------
+*TIMEZONE=*
-Name of device. Use `ip addr` or `ls /sys/class/net/` to see all available interfaces.
+Specifies the time zone. The setting takes effect on boot by ensuring that /etc/localtime is a symlink
+to the correct zoneinfo file. Possible time zones are the relative path to a zoneinfo file starting
+from the directory /usr/share/zoneinfo. For example, a German time zone would be Europe/Berlin,
+which refers to the file /usr/share/zoneinfo/Europe/Berlin.
-Default: empty
+It is recommended to leave this unset, and rather maintain the /etc/localtime symlink manually, or via
+third party tools. The reason for this is to avoid the symlink and the TIMEZONE variable to be out of sync,
+as they are only synchronized at boot. Also, most third-party applications that could maintain
+/etc/localtime do not know to also write to /etc/rc.conf.
-Required for manual configuration as well as DHCP.
+ TIMEZONE="Europe/Berlin"
-*address=*
+*HARDWARECLOCK=*
-IP address.
+How to interpret/update the hardware clock.
-Default: empty
+Options:
-Required for manual configuration, empty for DHCP.
+ - empty: fall back to the value in /etc/adjtime, which defaults to UTC.
+ - "UTC": allows the operating systems to abstract away local time and ease DST.
+ - "localtime": apply time zone (and DST) in hardwareclock: strongly discouraged.
+ Choose this if you dual-boot with an OS which cannot handle UTC BIOS times correctly, like Windows (note
+ that recent Windows versions can use UTC, which is preferable).
-*netmask=*
+It is strongly recommended to leave this unset, and rather maintain /etc/adjtime (see hwclock(8)). The reason for
+this is that calls to hwclock outside of initscripts are not aware of the HARDWARECLOCK variable and will always
+use /etc/adjtime. These two configuration sources being out-of-sync is a common source of timezone problems.
-Subnet mask.
+ HARDWARECLOCK="UTC"
-Default: empty (which means 255.255.255.0)
+*KEYMAP=*
-Optional for manual configuration, ignored for DHCP.
+Defines the keymap to load with the loadkeys program on boot. Possible keymaps are
+found in /usr/share/kbd/keymaps. Please note that this setting is only valid for
+your TTYs, not any graphical window managers or X.
-*broadcast=*
+KEYMAP in /etc/vconsole.conf takes precedence (see vconsole.conf(5)), and is recommended.
-Broadcast address.
+ KEYMAP="no-latin1"
-Default: empty
+*CONSOLEFONT=*
-Optional for manual configuration, ignored for DHCP.
+Defines the console font to load with the setfont program on boot.
+Possible fonts are found in /usr/share/kbd/consolefonts (only needed for non-US).
-*gateway=*
+FONT in /etc/vconsole.conf takes precedence (see vconsole.conf(5)), and is recommended.
-Default route.
+ CONSOLEFONT="LatArCyrHeb-16"
-Default: empty
+*CONSOLEMAP=*
-Required for manual configuration, ignored for DHCP.
+Defines the console map to load with the setfont program on boot. Possible maps are found in
+/usr/share/kbd/consoletrans. Set this to a map suitable for the appropriate locale (8859-1 for Latin1,
+for example) if you're using an UTF-8 locale and use programs that generate 8-bit output. If you're
+using X11 for everyday work, don't bother, as it only affects the output of Linux console applications.
-*Static IP example*
+FONT_MAP in /etc/vconsole.conf takes precedence (see vconsole.conf(5)), and is recommended.
- interface=eth0
- address=192.168.0.2
- netmask=255.255.255.0
- broadcast=192.168.0.255
- gateway=192.168.0.1
+ CONSOLEMAP="8859-1"
-*DHCP example*
+*LOCALE=*
- interface=eth0
- address=
- netmask=
- gateway=
+This sets your system language, which will be used by all i18n-friendly applications and utilities.
+See `locale -a` (or locale.gen) for available options.
-The following options might be needed for advanced use cases.
+LANG in /etc/locale.conf takes precedence (see locale.conf(5)), and is recommended.
-*NETWORK_PERSIST=*
+If unset, it falls back to the C locale.
-Setting this to "yes" will skip network shutdown. This is required if your root device is on NFS.
+ LOCALE="en_US.UTF-8"
-Default: "no"
+*DAEMON_LOCALE=*
-*NETWORKS=*
+ - If set to 'no', export the C locale to daemons and during the boot process.
+ - Otherwise, export LANG (or LOCALE) as configured in /etc/locale.conf (or /etc/rc.conf).
-This functionality is deprecated; please refer to 'man 8 netcfg'.
+Leave this unset, unless you have a specific reason to set it to 'no'.
-DAEMONS[[D]]
-------------
-*DAEMONS=*
+ DAEMON_LOCALE="yes"
-Daemons to start at boot-up (in this order)
+*USECOLOR=*
- - prefix a daemon with a ! to disable it
- - prefix a daemon with a @ to start it up in the background
+Use ANSI color sequences in start-up messages, unless set to 'no'.
-If you are sure nothing else touches your hardware clock (such as ntpd or
-by dual-booting), you might want to enable 'hwclock'. Note that this will only
-make a difference if the hwclock program has been calibrated correctly.
+ USECOLOR="yes"
-If you use a network filesystem, you should enable 'netfs'.
+HARDWARE[[H]]
+-------------
+*MODULES=*
+
+Modules to load at boot-up. To blacklist modules, see modprobe.d(5).
+
+Configuration files in /etc/modules-load.d/ are recommended instead (see modules-load.d(5)).
-Default: (syslog-ng network crond)
+ MODULES=('kvm')
SEE ALSO
--------
-hostname(5), vconsole.conf(5), locale.conf(5), hwclock(8)
+hostname(5), vconsole.conf(5), locale.conf(5), hwclock(8), modules-load.d(5), modprobe.d(5), ip(8), dhcpcd(8)
AUTHORS
-------