Admin handbook: Add FS Layout chapter

1 files changed, 124 insertions, 3 deletions

diff --git a/src/admin/8_fslayout.xml b/src/admin/8_fslayout.xml
index 44286bb..76f658f 100644
--- a/src/admin/8_fslayout.xml
+++ b/src/admin/8_fslayout.xml
@@ -1,9 +1,130 @@
 <?xml version="1.0" encoding="utf-8"?>
 <chapter label="8" id="fslayout">
     <title>File System Layout</title>
-    <para></para>
+    <highlights><para>In this chapter, we will review directories and files common to all Adélie Linux systems.  Adélie Linux is based on the Filesystem Hierarchy Standard (FHS) 3.0 specification; directories and files specified in FHS are not covered here.</para></highlights>
     <section>
-        <title></title>
-        <para></para>
+        <title>/etc: Host-specific system configuration</title>
+        <section>
+            <title>Purpose</title>
+            <para>As in FHS, the /etc hierarchy contains configuration files specific to a single host.</para>
+        </section>
+        <section>
+            <title>Requirements</title>
+            <para>The following directories, or symbolic links to directories, must be present in <filename class="directory">/etc</filename>:</para>
+            <table frame="all">
+                <title>Directories required in <filename class="directory">/etc</filename></title>
+                <tgroup cols="2" align="left" colsep="1" rowsep="1">
+                <thead>
+                    <row>
+                        <entry>Directory</entry>
+                        <entry>Description</entry>
+                    </row>
+                </thead>
+                <tbody>
+                    <row>
+                        <entry><filename class="directory">apk</filename></entry>
+                        <entry>Configuration for the package manager</entry>
+                    </row>
+                </tbody>
+                </tgroup>
+            </table>
+            <para>The following files, or symbolic links to files, must be present in <filename class="directory">/etc</filename>:</para>
+            <table frame="all">
+                <title>Files required in <filename class="directory">/etc</filename></title>
+                <tgroup cols="2" align="left" colsep="1" rowsep="1">
+                <thead>
+                    <row>
+                        <entry>File</entry>
+                        <entry>Description</entry>
+                    </row>
+                </thead>
+                <tbody>
+                    <row>
+                        <entry><filename>adelie-release</filename></entry>
+                        <entry>Version and release information about the currently installed system software</entry>
+                    </row>
+                </tbody>
+                </tgroup>
+            </table>
+        </section>
+        <section>
+            <title>Specific Options</title>
+            <para>The following files, or symbolic links to files, must be present in <filename class="directory">/etc</filename>, if the corresponding subsystem is installed:</para>
+            <table frame="all">
+                <title>Files required in <filename class="directory">/etc</filename></title>
+                <tgroup cols="2" align="left" colsep="1" rowsep="1">
+                <thead>
+                    <row>
+                        <entry>File</entry>
+                        <entry>Description</entry>
+                    </row>
+                </thead>
+                <tbody>
+                    <row>
+                        <entry><filename>abuild.conf</filename></entry>
+                        <entry>Configuration for building packages (optional)</entry>
+                    </row>
+                    <row>
+                        <entry><filename>inputrc</filename></entry>
+                        <entry>Configuration for Bash shell (optional)</entry>
+                    </row>
+                    <row>
+                        <entry><filename>ld-musl-<envar>$ARCH</envar>.path</filename></entry>
+                        <entry>Additional search paths for the dynamic linker (optional)</entry>
+                    </row>
+                </tbody>
+                </tgroup>
+            </table>
+        </section>
+        <section>
+            <title>/etc/apk: Configuration files for the package manager</title>
+            <section>
+                <title>Purpose</title>
+                <para><filename class="directory">/etc/apk</filename> is used for configuring the Adélie Linux package manager, as described in <xref linkend="packages"/>.</para>
+            </section>
+            <section>
+                <title>Requirements</title>
+                <para>The following directories, or symbolic links to directories, must be present in <filename class="directory">/etc/apk</filename>:</para>
+                <table frame="all">
+                    <title>Directories required in <filename class="directory">/etc/apk</filename></title>
+                    <tgroup cols="2" align="left" colsep="1" rowsep="1">
+                    <thead>
+                        <row>
+                            <entry>Directory</entry>
+                            <entry>Description</entry>
+                        </row>
+                    </thead>
+                    <tbody>
+                        <row>
+                            <entry><filename class="directory">keys</filename></entry>
+                            <entry>Public keys for the repositories listed in <filename>repositories</filename> to ensure package integrity</entry>
+                        </row>
+                    </tbody>
+                    </tgroup>
+                </table>
+                <para>The following files, or symbolic links to files, must be present in <filename class="directory">/etc/apk</filename>:</para>
+                <table frame="all">
+                    <title>Files required in <filename class="directory">/etc/apk</filename></title>
+                    <tgroup cols="2" align="left" colsep="1" rowsep="1">
+                    <thead>
+                        <row>
+                            <entry>File</entry>
+                            <entry>Description</entry>
+                        </row>
+                    </thead>
+                    <tbody>
+                        <row>
+                            <entry><filename>repositories</filename></entry>
+                            <entry>A list of repositories for search and retrieval of packages</entry>
+                        </row>
+                        <row>
+                            <entry><filename>world</filename></entry>
+                            <entry>A list of packages currently required for the host</entry>
+                        </row>
+                    </tbody>
+                    </tgroup>
+                </table>
+            </section>
+        </section>
     </section>
 </chapter>