summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-09-15 17:56:32 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-09-20 12:13:12 +0200
commit65c005a4c2ec5b4f138fc4c477bd8ce6c5d86ffe (patch)
tree400b6801dbe20859ec0ac831db8c0b89ad6a4db4
parent709ab94e68c04937337ab8b4a25ceaa80b35c732 (diff)
downloadsystemd-65c005a4c2ec5b4f138fc4c477bd8ce6c5d86ffe.tar.gz
man: substitute path to rc.local in the man page
Different systems use different paths for it and users are confused when the man page has a path different than the one on the local system. https://bugzilla.redhat.com/show_bug.cgi?id=1876905 (cherry picked from commit c2ee27a5e7fa1c6a71341579baa2d941c6e3e6e6) (cherry picked from commit 9353607ef3cff4902296268bab0ccc82dc8b04c2)
-rw-r--r--man/custom-entities.ent.in1
-rw-r--r--man/systemd-rc-local-generator.xml32
2 files changed, 18 insertions, 15 deletions
diff --git a/man/custom-entities.ent.in b/man/custom-entities.ent.in
index 85805777a0..050af82320 100644
--- a/man/custom-entities.ent.in
+++ b/man/custom-entities.ent.in
@@ -9,3 +9,4 @@
<!ENTITY MEMORY_ACCOUNTING_DEFAULT @MEMORY_ACCOUNTING_DEFAULT_YES_NO@>
<!ENTITY KILL_USER_PROCESSES @KILL_USER_PROCESSES_YES_NO@>
<!ENTITY DEBUGTTY @DEBUGTTY@>
+<!ENTITY RC_LOCAL_PATH @RC_LOCAL_PATH@>
diff --git a/man/systemd-rc-local-generator.xml b/man/systemd-rc-local-generator.xml
index 81744c2025..dabde6d116 100644
--- a/man/systemd-rc-local-generator.xml
+++ b/man/systemd-rc-local-generator.xml
@@ -1,7 +1,9 @@
-<?xml version="1.0"?>
-<!--*-nxml-*-->
+<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//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;
+]>
<!-- SPDX-License-Identifier: LGPL-2.1+ -->
<refentry id="systemd-rc-local-generator">
@@ -17,7 +19,7 @@
<refnamediv>
<refname>systemd-rc-local-generator</refname>
- <refpurpose>Compatibility generator for starting <filename>/etc/rc.local</filename> during boot</refpurpose>
+ <refpurpose>Compatibility generator for starting <filename>&RC_LOCAL_PATH;</filename> during boot</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -28,17 +30,17 @@
<title>Description</title>
<para><filename>systemd-rc-local-generator</filename> is a generator that checks whether
- <filename>/etc/rc.local</filename> exists and is executable, and if it is pulls the
- <filename>rc-local.service</filename> unit into the boot process. This unit is responsible for running this script
- during late boot. Note that the script will be run with slightly different semantics than the original System V
- version, which was run "last" in the boot process, which is a concept that does not translate to systemd. The
- script is run after <filename>network.target</filename>, but in parallel with most other regular system
- services.</para>
-
- <para>Support for <filename>/etc/rc.local</filename> is provided
- for compatibility with specific System V systems only. However, it is strongly recommended to avoid making use of
- this script today, and instead provide proper unit files with appropriate dependencies for any scripts to run
- during the boot process.</para>
+ <filename>&RC_LOCAL_PATH;</filename> exists and is executable, and if it is pulls the
+ <filename>rc-local.service</filename> unit into the boot process. This unit is responsible for running
+ this script during late boot. Note that the script will be run with slightly different semantics than the
+ original System V version, which was run "last" in the boot process, which is a concept that does not
+ translate to systemd. The script is run after <filename>network.target</filename>, but in parallel with
+ most other regular system services.</para>
+
+ <para>Support for <filename>&RC_LOCAL_PATH;</filename> is provided for compatibility with specific System
+ V systems only. However, it is strongly recommended to avoid making use of this script today, and instead
+ provide proper unit files with appropriate dependencies for any scripts to run during the boot process.
+ Note that the path to the script is set a compile time and varies between distributions.</para>
<para><filename>systemd-rc-local-generator</filename> implements
<citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>