summaryrefslogtreecommitdiff
path: root/man/systemd-suspend.service.xml
diff options
context:
space:
mode:
authorFilipe Brandenburger <filbranden@google.com>2015-05-27 02:38:19 -0700
committerLennart Poettering <lennart@poettering.net>2015-05-28 19:28:19 +0200
commit681eb9cf2b831293a4f3d4c48a748d2e4a25d69e (patch)
tree9293679b667f4d0dd0c525913b5d0ede61460550 /man/systemd-suspend.service.xml
parent5f529f4c97a141457301477505ae7eb4c28cf610 (diff)
downloadsystemd-681eb9cf2b831293a4f3d4c48a748d2e4a25d69e.tar.gz
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.
Diffstat (limited to 'man/systemd-suspend.service.xml')
-rw-r--r--man/systemd-suspend.service.xml13
1 files changed, 8 insertions, 5 deletions
diff --git a/man/systemd-suspend.service.xml b/man/systemd-suspend.service.xml
index a8beb86f4d..2722d1840a 100644
--- a/man/systemd-suspend.service.xml
+++ b/man/systemd-suspend.service.xml
@@ -1,6 +1,9 @@
<?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">
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % entities SYSTEM "custom-entities.ent" >
+%entities;
+]>
<!--
This file is part of systemd.
@@ -56,7 +59,7 @@
<para><filename>systemd-suspend.service</filename></para>
<para><filename>systemd-hibernate.service</filename></para>
<para><filename>systemd-hybrid-sleep.service</filename></para>
- <para><filename>/usr/lib/systemd/system-sleep</filename></para>
+ <para><filename>&rootlibexecdir;/system-sleep</filename></para>
</refsynopsisdiv>
<refsect1>
@@ -75,7 +78,7 @@
<para>Immediately before entering system suspend and/or
hibernation <filename>systemd-suspend.service</filename> (and the
other mentioned units, respectively) will run all executables in
- <filename>/usr/lib/systemd/system-sleep/</filename> and pass two
+ <filename>&rootlibexecdir;/system-sleep/</filename> and pass two
arguments to them. The first argument will be
<literal>pre</literal>, the second either
<literal>suspend</literal>, <literal>hibernate</literal>, or
@@ -87,7 +90,7 @@
until all executables have finished.</para>
<para>Note that scripts or binaries dropped in
- <filename>/usr/lib/systemd/system-sleep/</filename> are intended
+ <filename>&rootlibexecdir;/system-sleep/</filename> are intended
for local use only and should be considered hacks. If applications
want to be notified of system suspend/hibernation and resume,
there are much nicer interfaces available.</para>
@@ -104,7 +107,7 @@
<literal>mem</literal> into <filename>/sys/power/state</filename>,
to trigger the actual system suspend. What exactly is written
where can be configured in the <literal>[Sleep]</literal> section
- of <filename>/etc/systemd/sleep.conf</filename> or a
+ of <filename>&pkgsysconfdir;/sleep.conf</filename> or a
<filename>sleep.conf.d</filename> file. See
<citerefentry><refentrytitle>systemd-sleep.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>