aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Gundersen <teg@jklm.no>2012-07-26 22:00:14 (GMT)
committerTom Gundersen <teg@jklm.no>2012-07-26 22:12:56 (GMT)
commit4a84b51830467ee192cd6bddc0857ad08f6e7ae4 (patch)
treed2dcf3d790ba1ca0ee5b6e7c423eeb0308368942
parent98baa63c2008aa70c9e95f5fe46a79cec87aad31 (diff)
downloadinitscripts-4a84b51830467ee192cd6bddc0857ad08f6e7ae4.tar.xz
man: add ArchLinux(7)
This outlines what files needs to be configured to get a well-behaved system. For now it is extremely terse, but the main point is to work as a check-list, and to point people to the correct manpages to learn more. I'll be happy to take patches to extend this in the future. One might argue that this sholud not be part of initscripts, and we might indeed move it to 'filesystem' or something like that in the future. For the time being I'll keep it here for convenience. Suggested-by: Thomas B├Ąchler <thomas@archlinux.org> Signed-off-by: Tom Gundersen <teg@jklm.no>
-rw-r--r--ArchLinux.7.txt80
-rw-r--r--Makefile9
-rw-r--r--rc.conf9
3 files changed, 91 insertions, 7 deletions
diff --git a/ArchLinux.7.txt b/ArchLinux.7.txt
new file mode 100644
index 0000000..2a2c837
--- /dev/null
+++ b/ArchLinux.7.txt
@@ -0,0 +1,80 @@
+/////
+vim:set ts=4 sw=4 syntax=asciidoc noet:
+/////
+archlinux(7)
+============
+
+NAME
+----
+ArchLinux - basic configuration
+
+SYNOPSIS
+--------
+Overview of the basic configuartion of Arch Linux.
+
+DESCRIPTION
+-----------
+Arch Linux exposes the user to the system without hiding any details. This manpage gives a
+brief overview of the configuration files that should be set up on a fresh install.
+
+INITSCRIPTS[[I]]
+----------------
+The initscripts are configured in rc.conf. Here you configure what daemons to start on boot, what storage
+technologies should be enabled and, optionally, a basic network setup.
+
+HOSTNAME[[H]]
+-------------
+The hostname of the machine should be set in /etc/hostname. Additionally, either /etc/hosts should be
+configured accordingly, or nss-myhostname should be used. This is needed so the hostname can always
+be resolved to the current machine, which is required by some programs.
+
+LOCALIZATION[[L]]
+-----------------
+Various locales may be enabled in /etc/locale-gen, and generated by locale-gen. The system-wide locale to be used
+can be configured in /etc/locale.conf
+
+VIRTUAL CONSOLE[[V]]
+--------------------
+The virtual console is configured in /etc/vconsole.conf. It allows you to set a font and a keyboard layout, among
+other things. Note that these settings only apply to the console, and not if you use X.
+
+TIME[[T]]
+---------
+The local timezone is configured by symlinking /etc/localtime to the correct zoneinfo file under
+/usr/share/zoneinfo/. E.g.,
+
+ /etc/localtime -> /usr/share/zoneinfo/Europe/Paris
+
+The real-time clock, which keeps track of time when the computer is off, can be configured to either
+be in UTC or in localtime in /etc/adjtime. The default is UTC.
+
+FILESYSTEMS[[F]]
+----------------
+Filesystems are configured in /etc/fstab, and encryption mappings are configured in /etc/crypttab.
+
+INITRAMFS[[R]]
+--------------
+The initramfs is generated by mkinitcpio, and can be configured in /etc/mkinitcpio.conf.
+
+PACKAGE MANAGER[[P]]
+--------------------
+The package manager, pacman, is configured in /etc/pacman.conf.
+
+BOOTLOADER[[B]]
+---------------
+GRUB's configuration is generated from /etc/default/grub by grub-mkconfig. Syslinux is configured in /boot/syslinux/syslinux.conf
+
+MODULES[[M]]
+------------
+Most modules should be loaded on-demand. Modules to be unconditioanlly loaded at boot can be specified in /etc/modules-load.d/,
+and modules to be blacklisted from auto-loading can be configured in /etc/modprobe.d/.
+
+SEE ALSO
+--------
+
+rc.conf(5), hostname(5), hosts(5), nsswitch.conf(5), locale.conf(5), vconsole(5), timezone(3), hwclock(8), fstab(5), crypttab(5),
+mkinitcpio(8), pacman(8), pacman.conf(5), grub-mkconfig(8), syslinux(1), modules-load.d(5), modprobe.d(5)
+
+AUTHORS
+-------
+Written by Tom Gundersen.
diff --git a/Makefile b/Makefile
index 5ac71da..1a3fa14 100644
--- a/Makefile
+++ b/Makefile
@@ -10,6 +10,7 @@ DIRS := \
/usr/share/bash-completion/completions \
/usr/share/zsh/site-functions \
/usr/share/man/man5 \
+ /usr/share/man/man7 \
/usr/share/man/man8
all: doc
@@ -26,6 +27,7 @@ install: installdirs doc
install -m755 -t $(DESTDIR)/etc/profile.d locale.sh
install -m755 -t $(DESTDIR)/usr/sbin rc.d
install -m644 -t $(DESTDIR)/usr/share/man/man5 rc.conf.5
+ install -m644 -t $(DESTDIR)/usr/share/man/man7 ArchLinux.7
install -m644 -t $(DESTDIR)/usr/share/man/man8 rc.d.8
install -m644 tmpfiles.conf $(DESTDIR)/usr/lib/tmpfiles.d/initscripts.conf
install -m644 -T bash-completion $(DESTDIR)/usr/share/bash-completion/completions/rc.d
@@ -34,13 +36,16 @@ install: installdirs doc
%.5: %.5.txt
a2x -d manpage -f manpage $<
+%.7: %.7.txt
+ a2x -d manpage -f manpage $<
+
%.8: %.8.txt
a2x -d manpage -f manpage $<
-doc: rc.conf.5 rc.d.8
+doc: rc.conf.5 ArchLinux.7 rc.d.8
clean:
- rm -f rc.conf.5 rc.d.8
+ rm -f rc.conf.5 ArchLinux.7 rc.d.8
tar:
git archive HEAD --prefix=initscripts-$(VER)/ | xz > initscripts-$(VER).tar.xz
diff --git a/rc.conf b/rc.conf
index bf6a9e4..597e9a8 100644
--- a/rc.conf
+++ b/rc.conf
@@ -1,11 +1,10 @@
#
-# /etc/rc.conf - Main Configuration for Arch Linux
+# /etc/rc.conf - configuration file for initscripts
#
-# Most of rc.conf has been replaced by hostname(5),
-# vconsole.conf(5), locale.conf(5) and
-# modules-load.d(5).
+# Most of rc.conf has been replaced by various other configuration
+# files. See archrlinux(7) for details.
#
-# For more details see rc.conf(5).
+# For more details on rc.conf see rc.conf(5).
#
DAEMONS=(syslog-ng network crond)