summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2018-12-15 22:49:45 -0600
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2018-12-15 22:49:45 -0600
commite77801f236925a24b1974016a36a9033ecd84e33 (patch)
tree087ab43f36f2bf4cfa3b9ac7675722c8268b723e
parent67cf44b673798295db4d9e9c6c2a1af9dc77bb36 (diff)
downloaddocs-e77801f236925a24b1974016a36a9033ecd84e33.tar.gz
docs-e77801f236925a24b1974016a36a9033ecd84e33.tar.bz2
docs-e77801f236925a24b1974016a36a9033ecd84e33.tar.xz
docs-e77801f236925a24b1974016a36a9033ecd84e33.zip
Admin: ch07: finish (?!)
-rw-r--r--src/admin/5_networking.xml2
-rw-r--r--src/admin/7_config.xml202
-rw-r--r--src/admin/adminbook.xml2
3 files changed, 203 insertions, 3 deletions
diff --git a/src/admin/5_networking.xml b/src/admin/5_networking.xml
index 06bd313..a195c3c 100644
--- a/src/admin/5_networking.xml
+++ b/src/admin/5_networking.xml
@@ -129,7 +129,7 @@ ip tuntap del name $1
<title>Advanced: Using "predictable" network interface names</title>
<para></para>
</section>
- <section>
+ <section id="multi_if">
<title>Advanced: Multiple interfaces</title>
<para></para>
<para>Note that by default, all interfaces must be active before the rest of the system will consider the network to be active. This will cause network services to delay start-up until all interfaces are active. If this is not desired, you may set <varname>rc_depend_strict</varname> to <literal>NO</literal> in <filename>/etc/rc.conf</filename>.</para>
diff --git a/src/admin/7_config.xml b/src/admin/7_config.xml
index d971448..7bedb96 100644
--- a/src/admin/7_config.xml
+++ b/src/admin/7_config.xml
@@ -221,7 +221,7 @@
</table>
</section>
</section>
- <section>
+ <section id="e-c-gettys">
<title><filename>/etc/conf.d/gettys</filename>: System console configuration</title>
<section role="NotInToc">
<title>Purpose</title>
@@ -412,4 +412,204 @@
<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>
+ <title><filename>/etc/issue</filename>: System identification configuration</title>
+ <section role="NotInToc">
+ <title>Purpose</title>
+ <para>The <filename>/etc/issue</filename> file determines the message that will be displayed on virtual terminals and consoles before the login prompt.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Syntax</title>
+ <para>Text file. Escape sequences are supported.</para>
+ </section>
+ <section role="NotInToc">
+ <title>External References</title>
+ <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>
+ <title><filename>/etc/ld-musl-<replaceable>ARCH</replaceable>.path</filename>: Dynamic linker configuration</title>
+ <section role="NotInToc">
+ <title>Purpose</title>
+ <para>The <filename>/etc/ld-musl-<replaceable>ARCH</replaceable>.path</filename> file determines the paths that will be used by the dynamic linker to resolve shared libraries.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Syntax</title>
+ <para>One directory per line. Comments are not allowed.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Detailed Information</title>
+ <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>
+ <title><filename>/etc/localtime</filename>: Time zone configuration</title>
+ <section role="NotInToc">
+ <title>Purpose</title>
+ <para>The <filename>/etc/localtime</filename> file determines the system's time zone. The system time zone is shown in <command>date</command>(1), file modification times, log files, and other functions. It is important to ensure this file is correct.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Syntax</title>
+ <para>Binary time zone file. Please do not edit the file directly in an editor.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Detailed Information</title>
+ <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>
+ <title><filename>/etc/login.defs</filename>: Login configuration</title>
+ <section role="NotInToc">
+ <title>Purpose</title>
+ <para>The <filename>/etc/login.defs</filename> file determines the configuration for the <package>shadow</package> package, which is responsible for all logins and the <command>su</command> command on the Adélie Linux system.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Syntax</title>
+ <para>Each line describes a configuration value; the name and value are separated by whitespace. Blank lines and comment lines are ignored. Comments may not appear anywhere other than the beginning of a line.</para>
+ </section>
+ <section role="NotInToc">
+ <title>External References</title>
+ <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>
+ <title><filename>/etc/motd</filename>: Login message configuration</title>
+ <section role="NotInToc">
+ <title>Purpose</title>
+ <para>The <filename>/etc/motd</filename> file determines the message that will be displayed to users when they log in to the system.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Syntax</title>
+ <para>Plain text.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Detailed Information</title>
+ <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>
+ <title><filename class="directory">/etc/profile.d/</filename>: Shell startup configuration</title>
+ <section role="NotInToc">
+ <title>Purpose</title>
+ <para>The <filename class="directory">/etc/profile.d</filename> directory contains files that determine the shell environment for all users on the system.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Syntax</title>
+ <para>Shell scripts.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Detailed Information</title>
+ <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>
+ <title><filename>/etc/rc.conf</filename>: Service manager configuration</title>
+ <section role="NotInToc">
+ <title>Purpose</title>
+ <para>The <filename>/etc/rc.conf</filename> file determines the behaviour of the service manager, which is partially responsible for system initialisation.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Syntax</title>
+ <para>Shell script. Variables are in lowercase. Booleans may be set as <literal>YES</literal> or <literal>NO</literal>.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Detailed Information</title>
+ <para>The <filename>/etc/rc.conf</filename> file defines the following configuration variables:</para>
+ <table frame="none">
+ <title>Configurable variables in <filename>/etc/rc.conf</filename></title>
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <thead>
+ <row>
+ <entry>Variable</entry>
+ <entry>Meaning</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><varname>rc_parallel</varname></entry>
+ <entry>
+ Determines whether the system should attempt to start multiple services at the same time.
+ <warning><title>Danger</title><para>This option may harm the stability of your system or render it inoperable. Take extreme caution before changing the default.</para></warning>
+ </entry>
+ <entry><literal>NO</literal></entry>
+ </row>
+ <row>
+ <entry><varname>rc_interactive</varname></entry>
+ <entry>Determines whether the system should allow a user to hold the "I" key during system initialisation to choose which services to start.</entry>
+ <entry><literal>NO</literal></entry>
+ </row>
+ <row>
+ <entry><varname>rc_shell</varname></entry>
+ <entry>Determines the shell to spawn if the system fails to initialise correctly.</entry>
+ <entry><literal>/bin/sh</literal></entry>
+ </row>
+ <row>
+ <entry><varname>rc_depend_strict</varname></entry>
+ <entry>Determines whether all providers of a dependency are required to start before dependent services are started. For an example, refer to <xref linkend="multi_if" />.</entry>
+ <entry><literal>YES</literal></entry>
+ </row>
+ <row>
+ <entry><varname>rc_logger</varname></entry>
+ <entry>Determines whether system initialisation activity is logged to disk for review by the system administrator.</entry>
+ <entry><literal>YES</literal></entry>
+ </row>
+ <row>
+ <entry><varname>rc_log_path</varname></entry>
+ <entry>Determines the path in which to write the system initialisation activity log, if <varname>rc_logger</varname> is set to <literal>YES</literal>.</entry>
+ <entry><literal>/var/log/rc.log</literal></entry>
+ </row>
+ <row>
+ <entry><varname>rc_verbose</varname></entry>
+ <entry>Determines if the service manager should output extra messages, which can be useful for debugging an issue with services.</entry>
+ <entry><literal>NO</literal></entry>
+ </row>
+ <row>
+ <entry><varname>rc_nocolor</varname></entry>
+ <entry>Determines if colourful output should be suppressed.</entry>
+ <entry><literal>NO</literal></entry>
+ </row>
+ <row>
+ <entry><varname>unicode</varname></entry>
+ <entry>
+ Determines if the system terminal supports Unicode.
+ <warning><title>Warning</title><para>Disabling Unicode support may cause some applications to work improperly.</para></warning>
+ </entry>
+ <entry><literal>YES</literal></entry>
+ </row>
+ <row>
+ <entry><varname>rc_sys</varname></entry>
+ <entry>Determines the system environment. This may be autodetected. Only set this option if autodetection does not work. Valid options are "<literal></literal>" for a typical Adélie Linux system; "<literal>docker</literal>" for a Docker container; "<literal>lxc</literal>" for a LXC container; "<literal>openvz</literal>" for an OpenVZ container; "<literal>xen0</literal>" for a Xen domain 0 instance; and "<literal>xenU</literal>" for a Xen guest domain instance.</entry>
+ <entry><literal></literal></entry>
+ </row>
+ <row>
+ <entry><varname>rc_tty_number</varname></entry>
+ <entry>Determines how many TTYs the service manager should allow services to configure. This does not impact the number of TTYs actually allocated; refer to <xref linkend="e-c-gettys" /> for this option.</entry>
+ <entry><literal>12</literal></entry>
+ </row>
+ <row>
+ <entry><varname>rc_controller_cgroups</varname></entry>
+ <entry>Determines whether cgroups should be used for services. Refer to the kernel documentation on cgroups for more information.</entry>
+ <entry><literal>NO</literal></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ </section>
+ <section>
+ <title><filename>/etc/resolv.conf</filename>: Network name resolution configuration</title>
+ <section role="NotInToc">
+ <title>Purpose</title>
+ <para>The <filename>/etc/resolv.conf</filename> file determines how names are resolved on the network. This includes the domain suffix that should be searched when the system searches for a host name on the network. This additionally includes the nameservers used to resolve names into IP addresses (typically via DNS).</para>
+ </section>
+ <section role="NotInToc">
+ <title>Syntax</title>
+ <para>Each line describes a configuration value; the name and value are separated by whitespace. Blank lines and comment lines are ignored.</para>
+ </section>
+ <section role="NotInToc">
+ <title>Detailed Information</title>
+ <para>For more information about configuring name resolution, refer to <xref linkend="how2dns" />.</para>
+ </section>
+ </section>
</chapter>
diff --git a/src/admin/adminbook.xml b/src/admin/adminbook.xml
index c91a91f..0c94bd2 100644
--- a/src/admin/adminbook.xml
+++ b/src/admin/adminbook.xml
@@ -35,7 +35,7 @@
</bookinfo>
<preface>
<title>Preface</title>
- <para>This Administrator's Handbook is the official comprehensive manual to administrating systems running the Adélie Linux 1.0 operating environment. It includes differences between Adélie Linux and other Linux and Unix&reg; environments, and detailed information on the design and implementation of Adélie Linux 1.0.</para>
+ <para>This Administrator's Handbook is the official comprehensive manual for the day-to-day use and administration of systems running the Adélie Linux 1.0 operating environment. It additionally includes differences between Adélie Linux and other Linux and Unix&reg; environments, and detailed information on the design and implementation of Adélie Linux 1.0.</para>
<para>Many contributed to the final version of this handbook. This includes <personname><firstname>Marcus</firstname><surname>Comstedt</surname></personname>, <personname><firstname>Michael</firstname><surname>Siegel</surname></personname>, and <personname><firstname>Tambra</firstname><surname>Wilcox</surname></personname>.</para>
<para>It is assumed that you, the reader, are familiar with using a terminal or command line interface, and the use of Unix commands. If you are not yet familiar with these concepts, start with our User's Handbook, which will assist you in learning them.</para>
<para>Please also ensure that you are comfortable and properly rested before reading this handbook. This will allow you to learn quicker, and be able to recall the information you have learned easier.</para>