chiark / gitweb /
man: document /etc/modules-load.d/
authorLennart Poettering <lennart@poettering.net>
Sun, 21 Nov 2010 19:41:00 +0000 (20:41 +0100)
committerLennart Poettering <lennart@poettering.net>
Sun, 21 Nov 2010 19:41:00 +0000 (20:41 +0100)
Makefile.am
TODO
man/modules-load.d.xml [new file with mode: 0644]
man/tmpfiles.d.xml

index 35bbc3a..4330db0 100644 (file)
@@ -509,7 +509,8 @@ MANPAGES = \
        man/hostname.5 \
        man/vconsole.conf.5 \
        man/locale.conf.5 \
-       man/os-release.5
+       man/os-release.5 \
+       man/modules-load.d.5
 
 MANPAGES_ALIAS = \
        man/reboot.8 \
diff --git a/TODO b/TODO
index 7de0ebb..b083529 100644 (file)
--- a/TODO
+++ b/TODO
@@ -53,8 +53,6 @@
 
 * readahead: btrfs/LVM SSD detection
 
-* man pages for: modules-load.d, /etc/os-release
-
 * when processes remain in a service even though the start command failed enter active
 
 * add seperate man page for [Install] settings
diff --git a/man/modules-load.d.xml b/man/modules-load.d.xml
new file mode 100644 (file)
index 0000000..47acc08
--- /dev/null
@@ -0,0 +1,95 @@
+<?xml version="1.0"?>
+<!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!--
+  This file is part of systemd.
+
+  Copyright 2010 Brandon Philips
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  systemd is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+<refentry id="modules-load.d">
+
+        <refentryinfo>
+                <title>modules-load.d</title>
+                <productname>systemd</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Lennart</firstname>
+                                <surname>Poettering</surname>
+                                <email>lennart@poettering.net</email>
+                        </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>modules-load.d</refentrytitle>
+                <manvolnum>5</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>modules-load.d</refname>
+                <refpurpose>Configure kernel modules to load at boot</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>/etc/modules-load.d/*.conf</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+               <para><command>systemd</command> uses
+               <filename>/etc/modules-load.d/</filename> to configure
+               kernel modules to load during boot in a static list.
+               Each configuration file is named in the style of
+               <filename>/etc/modules-load.d/&lt;program&gt;.conf</filename>. Note
+               that it is usally a better idea to use the automatic
+               module loading by PCI ID, by DMI ID or similar
+               triggers configured in the kernel modules themselves
+               instead of relying on static configuration like
+               this.</para>
+        </refsect1>
+
+        <refsect1>
+               <title>Configuration Format</title>
+
+               <para>The configuration files should simply contain a
+               list of kernel modul names to load, seperated by
+               newlines. Empty lines and lines whose first
+               non-whitespace character is # or ; are ignored.</para>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Example</title>
+                <example>
+                        <title>/etc/modules-load.d/uinput.conf example:</title>
+
+                        <programlisting># Load uinput.ko at boot
+uinput</programlisting>
+                </example>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>
index 7bdb6de..1df4a04 100644 (file)
 
         <refnamediv>
                 <refname>tmpfiles.d</refname>
-                <refpurpose>configuration for creation, deletion and cleaning of tmpfiles</refpurpose>
+                <refpurpose>Configuration for creation, deletion and cleaning of temporary and volatile files</refpurpose>
         </refnamediv>
 
+        <refsynopsisdiv>
+                <para><filename>/etc/tmpfiles.d/*.conf</filename></para>
+        </refsynopsisdiv>
+
         <refsect1>
                 <title>Description</title>
 
@@ -55,7 +59,7 @@
                <filename>/var/run</filename> or
                <filename>/tmp</filename>).  Each configuration file
                is named in the style of
-               <filename>/etc/tmpfiles.d/&lt;program&gt;.conf</filename></para>
+               <filename>/etc/tmpfiles.d/&lt;program&gt;.conf</filename>.</para>
         </refsect1>
 
         <refsect1>
@@ -73,37 +77,37 @@ d    /var/run/user 0755 root root 10d</programlisting>
                         <variablelist>
                                 <varlistentry>
                                         <term><varname>f</varname></term>
-                                        <listitem><para>create a file if it doesn't exist yet</para></listitem>
+                                        <listitem><para>Create a file if it doesn't exist yet</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>F</varname></term>
-                                        <listitem><para>create or truncate a file</para></listitem>
+                                        <listitem><para>Create or truncate a file</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>d</varname></term>
-                                        <listitem><para>create a directory if it doesn't exist yet</para></listitem>
+                                        <listitem><para>Create a directory if it doesn't exist yet</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>D</varname></term>
-                                        <listitem><para>create or empty a directory</para></listitem>
+                                        <listitem><para>Create or empty a directory</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>x</varname></term>
-                                        <listitem><para>ignore a path</para></listitem>
+                                        <listitem><para>Ignore a path</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>r</varname></term>
-                                        <listitem><para>remove a path</para></listitem>
+                                        <listitem><para>Remove a path</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>R</varname></term>
-                                        <listitem><para>recursively remove a path</para></listitem>
+                                        <listitem><para>Recursively remove a path</para></listitem>
                                 </varlistentry>
                         </variablelist>
                 </refsect2>