summaryrefslogtreecommitdiff
path: root/src/admin/7_config.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/admin/7_config.xml')
-rw-r--r--src/admin/7_config.xml52
1 files changed, 26 insertions, 26 deletions
diff --git a/src/admin/7_config.xml b/src/admin/7_config.xml
index 7bedb96..deaaad1 100644
--- a/src/admin/7_config.xml
+++ b/src/admin/7_config.xml
@@ -2,7 +2,7 @@
<chapter label="7" id="config">
<title>System Configuration</title>
<highlights><para>In this chapter, we will overview the main configuration files present in the Adélie Linux system.</para></highlights>
- <section>
+ <section id="introduction7">
<title>Introduction</title>
<para>This chapter will cover the main configuration files that are commonly referenced in the daily administration of Adélie Linux systems. This list is not exhaustive, and is not a list of every configuration file in the Adélie Linux system. Some configuration files are only present when a specific system option (such as audio, graphics, or networking) is installed.</para>
<para>Each section in this chapter has the following subsections:</para>
@@ -12,7 +12,7 @@
<listitem><para>either <firstterm>Detailed Information</firstterm> for information on configuration files specific to the Adélie Linux system, or <firstterm>External References</firstterm> for either manual pages or online links to more information about configuration files from packages.</para></listitem>
</itemizedlist>
</section>
- <section>
+ <section id="e-abuild">
<title><filename>/etc/abuild.conf</filename>: Package build configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -43,7 +43,7 @@
<para>If a repository is invalid, does not have a recognised signing key, or does not exist, it will not be considered by APK. Depending on the parameters passed to APK and the operation being performed, this may be a warning or a fatal error.</para>
</section>
</section>
- <section>
+ <section id="e-asound">
<title><filename>/etc/asound.conf</filename>: System audio configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -58,7 +58,7 @@
<para>For more information on configuring system audio hardware, refer to <ulink url="https://www.alsa-project.org/main/index.php/Asoundrc">the official documentation at the ALSA Project Web site</ulink> on the Internet. <!-- If you do not have an internet connection, XXX TODO help! does anyone know if asoundrc(5) exists? can't find it in any of our packages --></para>
</section>
</section>
- <section>
+ <section id="e-b-b">
<title><filename>/etc/bash/bashrc</filename>: Bash shell startup configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -73,7 +73,7 @@
<para>For more information, refer to the bash(1) manpage. If this manpage is not present on your system, it may be installed via the <package>bash-doc</package> package.</para>
</section>
</section>
- <section>
+ <section id="e-c-alsa">
<title><filename>/etc/conf.d/alsa</filename>: Mixer level configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -88,7 +88,7 @@
<para>For more information, refer to the comments in the <filename>/etc/conf.d/alsa</filename> file.</para>
</section>
</section>
- <section>
+ <section id="e-c-bootmisc">
<title><filename>/etc/conf.d/bootmisc</filename>: Boot behaviour configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -137,7 +137,7 @@
</table>
</section>
</section>
- <section>
+ <section id="e-c-devfs">
<title><filename>/etc/conf.d/devfs</filename>: <filename class="directory">/dev</filename> configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -152,7 +152,7 @@
<para>The <varname>skip_mount_dev</varname> variable may be set to <literal>YES</literal> to prevent the system from automatically attempting to mount <filename class="directory">/dev</filename> during system initialisation. The default setting of the <varname>skip_mount_dev</varname> variable is <literal>NO</literal>.</para>
</section>
</section>
- <section>
+ <section id="e-c-dmesg">
<title><filename>/etc/conf.d/dmesg</filename>: <literal>dmesg</literal> configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -167,7 +167,7 @@
<para>The <varname>dmesg_level</varname> controls the "console level", or the severity required for a message to be printed to the system console. The default value is <literal>1</literal>, which corresponds to the <literal>emerg</literal> log level. This prevents all messages from being written to the console except kernel panics.</para>
</section>
</section>
- <section>
+ <section id="e-c-fsck">
<title><filename>/etc/conf.d/fsck</filename>: Startup file system check configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -264,7 +264,7 @@
<para></para>
</section>
</section> -->
- <section>
+ <section id="e-c-modules">
<title><filename>/etc/conf.d/modules</filename>: Kernel module configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -281,7 +281,7 @@
<para>For each module specified, an additional variable, <varname>module_<replaceable>MODNAME</replaceable>_args</varname>, is defined, where <replaceable>MODNAME</replaceable> is the name of the module. The <varname>module_<replaceable>MODNAME</replaceable>_args</varname> variable controls the arguments passed to the module. Refer to the documentation for each module for a list of arguments it supports.</para>
</section>
</section>
- <section>
+ <section id="e-c-net">
<title><filename>/etc/conf.d/net</filename>: Network configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -296,7 +296,7 @@
<para>Refer to <xref linkend="networking" /> for information on configuring networks using the Adélie Linux system.</para>
</section>
</section>
- <section>
+ <section id="e-c-urandom">
<title><filename>/etc/conf.d/urandom</filename>: Random number configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -311,7 +311,7 @@
<para>The <filename>/etc/conf.d/urandom</filename> file defines a single configuration variable, <varname>urandom_seed</varname>, which specifies the path in which to save the random number seed when the system is shut down. The default is <filename>/var/lib/misc/random-seed</filename>. This variable must point to a path that is on the root filesystem; if <filename class="directory">/var</filename> is a separate filesystem, you must configure this variable to use a different path.</para>
</section>
</section>
- <section>
+ <section id="e-d-console-setup">
<title><filename>/etc/default/console-setup</filename>: Virtual terminal configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -326,7 +326,7 @@
<para>For more information, consult the official manual page for console-setup(5). This manual page is available in the <package>console-setup-doc</package> package. If your computer has an Internet connection, you may also read it <ulink url="https://manpages.debian.org/stable/console-setup/console-setup.5.en.html">on the Web</ulink>.</para>
</section>
</section>
- <section>
+ <section id="e-d-keyboard">
<title><filename>/etc/default/keyboard</filename>: Console keyboard configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -346,7 +346,7 @@
<para>For more information, consult the official manual page for keyboard(5). This manual page is available in the <package>console-setup-doc</package> package. If your computer has an Internet connection, you may also read it <ulink url="https://manpages.debian.org/stable/console-setup/keyboard.5.en.html">on the Web</ulink>.</para>
</section>
</section>
- <section>
+ <section id="e-dracut">
<title><filename class="directory">/etc/dracut.conf.d/</filename>: Early system initialisation configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -361,7 +361,7 @@
<para>For more information, consult the dracut.conf(5) manual page. This manual page is available in the <package>dracut-doc</package> package.</para>
</section>
</section>
- <section>
+ <section id="e-fstab">
<title><filename>/etc/fstab</filename>: Filesystem mount point configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -382,7 +382,7 @@
<para>For more information, consult the fstab(5) manual page. This manual page is available in the <package>util-linux-doc</package> package.</para>
</section>
</section>
- <section>
+ <section id="e-hostname">
<title><filename>/etc/hostname</filename>: Host name configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -397,7 +397,7 @@
<para>The <filename>/etc/hostname</filename> is read during system initialisation. The system host name is set to the contents of this file. If the <filename>/etc/hostname</filename> file is missing or corrupt, the system will retain the kernel's default host name &mdash; with the default Adélie Linux kernel, this is "<literal>adelie</literal>".</para>
</section>
</section>
- <section>
+ <section id="e-inputrc">
<title><filename>/etc/inputrc</filename>: Bash shell keyboard configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -412,7 +412,7 @@
<para>There are a few comments in the <filename>/etc/inputrc</filename> file. Since the GNU readline library is not packaged for the Adélie Linux system, it is not possible to read the manual page.</para>
</section>
</section>
- <section>
+ <section id="e-issue">
<title><filename>/etc/issue</filename>: System identification configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -427,7 +427,7 @@
<para>For more information, refer to the Issue Files section of the agetty(8) manual page. The agetty(8) manual page is available in the <package>util-linux-doc</package> package.</para>
</section>
</section>
- <!-- <section>
+ <!-- <section id="e-ld-musl">
<title><filename>/etc/ld-musl-<replaceable>ARCH</replaceable>.path</filename>: Dynamic linker configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -442,7 +442,7 @@
<para>We really should write how musl works internally and publish it as a chapter in this book for the 2.0 cycle. After all, the front matter refers to this as not only a handbook for day-to-day utilisation and administration of Adélie, but also an introduction to the "design and implementation of the system". Perhaps we should take Kiyoshi's idea and split this into two or more parts, to accomplish that. (It may stop being a handbook and become a book, then, though.)</para>
</section>
</section> -->
- <section>
+ <section id="e-localtime">
<title><filename>/etc/localtime</filename>: Time zone configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -457,7 +457,7 @@
<para>The <package>tzdata</package> package provides a number of time zone files in the <filename class="directory">/usr/share/zoneinfo</filename> directory. When configuring the system time zone, you should make a symbolic link from your time zone to <filename>/etc/localtime</filename>. Alternatively, if you are using a split <filename class="directory">/usr</filename> (not common), you may copy the file directly. For example, to set the system time zone to American Central Time, you would run <command>ln -s /usr/share/zoneinfo/America/Chicago /etc/localtime</command>; or, if you are using a split <filename class="directory">/usr</filename> (not common), you would run <command>cp /usr/share/zoneinfo/America/Chicago /etc/localtime</command>. For a full list of time zones available, run <command>find /usr/share/zoneinfo</command>.</para>
</section>
</section>
- <section>
+ <section id="e-login-defs">
<title><filename>/etc/login.defs</filename>: Login configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -472,7 +472,7 @@
<para>For more information, refer to the login.defs(5) manual page. The login.defs(5) manual page is available in the <package>shadow-doc</package> package.</para>
</section>
</section>
- <section>
+ <section id="e-motd">
<title><filename>/etc/motd</filename>: Login message configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -487,7 +487,7 @@
<para>The entire contents of the <filename>/etc/motd</filename> file are displayed to a user when they log in to the system. No command substitution or escape sequences are recognised; the file is entirely plain text. The default login message provides pointers on where to find the documentation for the Adélie Linux system.</para>
</section>
</section>
- <section>
+ <section id="e-p-d">
<title><filename class="directory">/etc/profile.d/</filename>: Shell startup configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -502,7 +502,7 @@
<para>The <filename>/etc/profile</filename> script is sourced by most shells during interactive logins. This script enumerates all shell scripts present in <filename class="directory">/etc/profile.d</filename> and sources them. Adding an executable shell script to <filename class="directory">/etc/profile.d</filename> allows you to set environment variables or add shell functions for interactive use. Note that most shells will not source these files during non-interactive logins.</para>
</section>
</section>
- <section>
+ <section id="e-rc-conf">
<title><filename>/etc/rc.conf</filename>: Service manager configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -597,7 +597,7 @@
</table>
</section>
</section>
- <section>
+ <section id="e-resolv-conf">
<title><filename>/etc/resolv.conf</filename>: Network name resolution configuration</title>
<section role="NotInToc">
<title>Purpose</title>