From 43fe779f802207d3b59ba5e17c5ef4a585c11748 Mon Sep 17 00:00:00 2001 From: Tom Gundersen Date: Mon, 26 Dec 2011 14:58:19 +0100 Subject: rc.conf: move most of the comments from the standard file to the manpage Having the documentation in the config file means users have to merge the config file every time we update the documentation. Also, repeating the documentation in two places means it will eventually go out of sync. Signed-off-by: Tom Gundersen --- rc.conf | 71 ----------------------------------------------------------- rc.conf.5.txt | 16 +++++++++++++- 2 files changed, 15 insertions(+), 72 deletions(-) diff --git a/rc.conf b/rc.conf index 414c535..f4c9e21 100644 --- a/rc.conf +++ b/rc.conf @@ -6,21 +6,6 @@ # LOCALIZATION # ----------------------------------------------------------------------- # -# HARDWARECLOCK: set to "", "UTC" or "localtime", any other value will result -# in the hardware clock being left untouched (useful for virtualization) -# Note: Using "localtime" is discouraged, using "" makes hwclock fall back -# to the value in /var/lib/hwclock/adjfile -# TIMEZONE: timezones are found in /usr/share/zoneinfo -# Note: if unset, the value in /etc/localtime is used unchanged -# KEYMAP: keymaps are found in /usr/share/kbd/keymaps -# CONSOLEFONT: found in /usr/share/kbd/consolefonts (only needed for non-US) -# CONSOLEMAP: found in /usr/share/kbd/consoletrans -# LOCALE: available languages can be listed with the 'locale -a' command -# LANG in /etc/locale.conf takes precedence -# DAEMON_LOCALE: If set to 'yes', use $LOCALE as the locale during daemon -# startup and during the boot process. If set to 'no', the C locale is used. -# USECOLOR: use ANSI color sequences in startup messages -# HARDWARECLOCK="UTC" TIMEZONE="Canada/Pacific" KEYMAP= @@ -34,56 +19,22 @@ USECOLOR="yes" # HARDWARE # ----------------------------------------------------------------------- # -# MODULES: Modules to load at boot-up. Blacklisting is no longer supported. -# Replace every !module by an entry as on the following line in a file in -# /etc/modprobe.d: -# blacklist module -# See "man modprobe.conf" for details. -# MODULES=() -# Udev settle timeout (default to 30) UDEV_TIMEOUT=30 -# Scan for FakeRAID (dmraid) Volumes at startup USEDMRAID="no" -# Scan for BTRFS volumes at startup USEBTRFS="no" -# Scan for LVM volume groups at startup, required if you use LVM USELVM="no" # ----------------------------------------------------------------------- # NETWORKING # ----------------------------------------------------------------------- # -# HOSTNAME: Hostname of machine. Should also be put in /etc/hosts -# HOSTNAME="myhost" -# Use 'ip addr' or 'ls /sys/class/net/' to see all available interfaces. -# -# Wired network setup -# - interface: name of device (required) -# - address: IP address (leave blank for DHCP) -# - netmask: subnet mask (ignored for DHCP) (optional, defaults to 255.255.255.0) -# - broadcast: broadcast address (ignored for DHCP) (optional) -# - gateway: default route (ignored for DHCP) -# -# Static IP example -# interface=eth0 -# address=192.168.0.2 -# netmask=255.255.255.0 -# broadcast=192.168.0.255 -# gateway=192.168.0.1 -# -# DHCP example -# interface=eth0 -# address= -# netmask= -# gateway= - interface= address= netmask= @@ -94,30 +45,8 @@ gateway= # This is required if your root device is on NFS. NETWORK_PERSIST="no" -# Enable these netcfg profiles at boot-up. These are useful if you happen to -# need more advanced network features than the simple network service -# supports, such as multiple network configurations (ie, laptop users) -# - set to 'menu' to present a menu during boot-up (dialog package required) -# - prefix an entry with a ! to disable it -# -# Network profiles are found in /etc/network.d -# -# This requires the netcfg package -# -#NETWORKS=(main) - # ----------------------------------------------------------------------- # DAEMONS # ----------------------------------------------------------------------- # -# Daemons to start at boot-up (in this order) -# - prefix a daemon with a ! to disable it -# - prefix a daemon with a @ to start it up in the background -# -# If you are sure nothing else touches your hardware clock (such as ntpd or -# a dual-boot), you might want to enable 'hwclock'. Note that this will only -# make a difference if the hwclock program has been calibrated correctly. -# -# If you use a network filesystem you should enable 'netfs'. -# DAEMONS=(syslog-ng network crond) diff --git a/rc.conf.5.txt b/rc.conf.5.txt index 56a163f..05cf74f 100644 --- a/rc.conf.5.txt +++ b/rc.conf.5.txt @@ -132,6 +132,20 @@ The following settings help you setting up a wired network. Default: empty Required for manual configuration, ignored for DHCP. +*Static IP example*:: + interface=eth0 + address=192.168.0.2 + netmask=255.255.255.0 + broadcast=192.168.0.255 + gateway=192.168.0.1 + +*DHCP example*:: + interface=eth0 + address= + netmask= + gateway= + +The following options might be needed for advanced use-cases. *NETWORK_PERSIST*:: Setting this to "yes" will skip network shutdown. @@ -165,4 +179,4 @@ Daemons[[D]] Authors ------- - Written by Dieter Plaetinck and others. + Written by Tom Gundersen, Dieter Plaetinck and others. -- cgit v1.2.3