1
1
mirror of https://github.com/systemd/systemd-stable.git synced 2024-12-24 21:34:08 +03:00
systemd-stable/man/standard-conf.xml
Filipe Brandenburger 681eb9cf2b man: generate configured paths in manpages
In particular, use /lib/systemd instead of /usr/lib/systemd in distributions
like Debian which still have not adopted a /usr merge setup.

Use XML entities from man/custom-entities.ent to replace configured paths while
doing XSLT processing of the original XML files. There was precedent of some
files (such as systemd.generator.xml) which were already using this approach.

This addresses most of the (manual) fixes from this patch:
http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/patches/Fix-paths-in-man-pages.patch?h=experimental-220

The idea of using generic XML entities was presented here:
http://lists.freedesktop.org/archives/systemd-devel/2015-May/032240.html

This patch solves almost all the issues, with the exception of:
- Path to /bin/mount and /bin/umount.
- Generic statements about preference of /lib over /etc.

These will be handled separately by follow up patches.

Tested:
- With default configure settings, ran "make install" to two separate
  directories and compared the output to confirm they matched exactly.
- Used a set of configure flags including $CONFFLAGS from Debian:
  http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/rules
  Installed the tree and confirmed the paths use /lib/systemd instead of
  /usr/lib/systemd and that no other unexpected differences exist.
- Confirmed that `make distcheck` still passes.
2015-05-28 19:28:19 +02:00

75 lines
3.8 KiB
XML

<?xml version="1.0"?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
<!DOCTYPE refsection PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
<refsection>
<refsection id='confd'>
<title>Configuration Directories and Precedence</title>
<para>Configuration files are read from directories in
<filename>/etc/</filename>, <filename>/run/</filename>, and
<filename>/usr/lib/</filename>, in order of precedence.
Each configuration file in these configuration directories shall be named in
the style of <filename><replaceable>filename</replaceable>.conf</filename>.
Files in <filename>/etc/</filename> override files with the same name in
<filename>/run/</filename> and <filename>/usr/lib/</filename>. Files in
<filename>/run/</filename> override files with the same name in
<filename>/usr/lib/</filename>.</para>
<para>Packages should install their configuration files in
<filename>/usr/lib/</filename>. Files in <filename>/etc/</filename> are
reserved for the local administrator, who may use this logic to override the
configuration files installed by vendor packages. All configuration files
are sorted by their filename in lexicographic order, regardless of which of
the directories they reside in. If multiple files specify the same option,
the entry in the file with the lexicographically latest name will take
precedence. It is recommended to prefix all filenames with a two-digit number
and a dash, to simplify the ordering of the files.</para>
<para>If the administrator wants to disable a configuration file supplied by
the vendor, the recommended way is to place a symlink to
<filename>/dev/null</filename> in the configuration directory in
<filename>/etc/</filename>, with the same filename as the vendor
configuration file.</para>
</refsection>
<refsection id='main-conf'>
<title>Configuration Directories and Precedence</title>
<para>Default configuration is defined during compilation, so a
configuration file is only needed when it is necessary to deviate
from those defaults. By default the configuration file in
<filename>&pkgsysconfdir;/</filename> contains commented out entries
showing the defaults as a guide to the administrator. This file
can be edited to create local overrides.
</para>
<para>When packages need to customize the configuration, they can
install configuration snippets in
<filename>&rootlibexecdir;/*.conf.d/</filename>. Files in
<filename>/etc/</filename> are reserved for the local
administrator, who may use this logic to override the
configuration files installed by vendor packages. The main
configuration file is read before any of the configuration
directories, and has the lowest precedence; entries in a file in
any configuration directory override entries in the single
configuration file. Files in the
<filename>*.conf.d/</filename> configuration subdirectories
are sorted by their filename in lexicographic order, regardless of
which of the subdirectories they reside in. If multiple files
specify the same option, the entry in the file with the
lexicographically latest name takes precedence. It is recommended
to prefix all filenames in those subdirectories with a two-digit
number and a dash, to simplify the ordering of the files.</para>
<para>To disable a configuration file supplied by the vendor, the
recommended way is to place a symlink to
<filename>/dev/null</filename> in the configuration directory in
<filename>/etc/</filename>, with the same filename as the vendor
configuration file.</para>
</refsection>
</refsection>