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
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2020-09-15 17:56:32 +02:00
parent 452d2dfd52
commit c2ee27a5e7
2 changed files with 18 additions and 14 deletions

View File

@ -10,3 +10,4 @@
<!ENTITY MEMORY_ACCOUNTING_DEFAULT @MEMORY_ACCOUNTING_DEFAULT_YES_NO@> <!ENTITY MEMORY_ACCOUNTING_DEFAULT @MEMORY_ACCOUNTING_DEFAULT_YES_NO@>
<!ENTITY KILL_USER_PROCESSES @KILL_USER_PROCESSES_YES_NO@> <!ENTITY KILL_USER_PROCESSES @KILL_USER_PROCESSES_YES_NO@>
<!ENTITY DEBUGTTY @DEBUGTTY@> <!ENTITY DEBUGTTY @DEBUGTTY@>
<!ENTITY RC_LOCAL_PATH @RC_LOCAL_PATH@>

View File

@ -1,8 +1,11 @@
<?xml version="1.0"?> <?xml version='1.0'?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" <!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+ --> <!-- SPDX-License-Identifier: LGPL-2.1+ -->
<refentry id="systemd-rc-local-generator" conditional='HAVE_SYSV_COMPAT'> <refentry id="systemd-rc-local-generator" conditional='HAVE_SYSV_COMPAT'>
<refentryinfo> <refentryinfo>
<title>systemd-rc-local-generator</title> <title>systemd-rc-local-generator</title>
@ -16,7 +19,7 @@
<refnamediv> <refnamediv>
<refname>systemd-rc-local-generator</refname> <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> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
@ -27,17 +30,17 @@
<title>Description</title> <title>Description</title>
<para><filename>systemd-rc-local-generator</filename> is a generator that checks whether <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_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 <filename>rc-local.service</filename> unit into the boot process. This unit is responsible for running
during late boot. Note that the script will be run with slightly different semantics than the original System V this script during late boot. Note that the script will be run with slightly different semantics than the
version, which was run "last" in the boot process, which is a concept that does not translate to systemd. The original System V version, which was run "last" in the boot process, which is a concept that does not
script is run after <filename>network.target</filename>, but in parallel with most other regular system translate to systemd. The script is run after <filename>network.target</filename>, but in parallel with
services.</para> most other regular system services.</para>
<para>Support for <filename>/etc/rc.local</filename> is provided <para>Support for <filename>&RC_LOCAL_PATH;</filename> is provided for compatibility with specific System
for compatibility with specific System V systems only. However, it is strongly recommended to avoid making use of V systems only. However, it is strongly recommended to avoid making use of this script today, and instead
this script today, and instead provide proper unit files with appropriate dependencies for any scripts to run provide proper unit files with appropriate dependencies for any scripts to run during the boot process.
during the boot process.</para> 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 <para><filename>systemd-rc-local-generator</filename> implements
<citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>