man: use readable names for entities

Let's use the same names as in the jinja2 substitutions.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2021-05-16 18:54:04 +02:00 committed by Yu Watanabe
parent fd3a3e31b3
commit 23b8071d47
4 changed files with 15 additions and 15 deletions

View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8" ?>
<!ENTITY MOUNT_PATH "{{MOUNT_PATH}}">
<!ENTITY UMOUNT_PATH "{{UMOUNT_PATH}}">
<!ENTITY systemgeneratordir "{{SYSTEM_GENERATOR_DIR}}">
<!ENTITY usergeneratordir "{{USER_GENERATOR_DIR}}">
<!ENTITY systemenvgeneratordir "{{SYSTEM_ENV_GENERATOR_DIR}}">
<!ENTITY userenvgeneratordir "{{USER_ENV_GENERATOR_DIR}}">
<!ENTITY SYSTEM_GENERATOR_DIR "{{SYSTEM_GENERATOR_DIR}}">
<!ENTITY USER_GENERATOR_DIR "{{USER_GENERATOR_DIR}}">
<!ENTITY SYSTEM_ENV_GENERATOR_DIR "{{SYSTEM_ENV_GENERATOR_DIR}}">
<!ENTITY USER_ENV_GENERATOR_DIR "{{USER_ENV_GENERATOR_DIR}}">
<!ENTITY CERTIFICATE_ROOT "{{CERTIFICATE_ROOT}}">
<!ENTITY FALLBACK_HOSTNAME "{{FALLBACK_HOSTNAME}}">
<!ENTITY MEMORY_ACCOUNTING_DEFAULT "{{ 'yes' if MEMORY_ACCOUNTING_DEFAULT else 'no' }}">

View file

@ -25,7 +25,7 @@
</refnamediv>
<refsynopsisdiv>
<para><filename>&userenvgeneratordir;/30-systemd-environment-d-generator</filename></para>
<para><filename>&USER_ENV_GENERATOR_DIR;/30-systemd-environment-d-generator</filename></para>
</refsynopsisdiv>
<refsect1>

View file

@ -25,31 +25,31 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>&systemenvgeneratordir;/some-generator</command>
<command>&SYSTEM_ENV_GENERATOR_DIR;/some-generator</command>
</cmdsynopsis>
<cmdsynopsis>
<command>&userenvgeneratordir;/some-generator</command>
<command>&USER_ENV_GENERATOR_DIR;/some-generator</command>
</cmdsynopsis>
<para>
<literallayout><filename>/run/systemd/system-environment-generators/*</filename>
<filename>/etc/systemd/system-environment-generators/*</filename>
<filename>/usr/local/lib/systemd/system-environment-generators/*</filename>
<filename>&systemenvgeneratordir;/*</filename></literallayout>
<filename>&SYSTEM_ENV_GENERATOR_DIR;/*</filename></literallayout>
</para>
<para>
<literallayout><filename>/run/systemd/user-environment-generators/*</filename>
<filename>/etc/systemd/user-environment-generators/*</filename>
<filename>/usr/local/lib/systemd/user-environment-generators/*</filename>
<filename>&userenvgeneratordir;/*</filename></literallayout>
<filename>&USER_ENV_GENERATOR_DIR;/*</filename></literallayout>
</para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>Generators are small executables that live in
<filename>&systemenvgeneratordir;/</filename> and other directories listed above.
<filename>&SYSTEM_ENV_GENERATOR_DIR;/</filename> and other directories listed above.
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> will
execute those binaries very early at the startup of each manager and at configuration
reload time, before running the generators described in
@ -116,7 +116,7 @@
<title>Debugging a generator</title>
<programlisting>SYSTEMD_LOG_LEVEL=debug VAR_A=something VAR_B="something else" \
&systemenvgeneratordir;/path-to-generator
&SYSTEM_ENV_GENERATOR_DIR;/path-to-generator
</programlisting>
</example>
</refsect1>

View file

@ -34,20 +34,20 @@
<literallayout><filename>/run/systemd/system-generators/*</filename>
<filename>/etc/systemd/system-generators/*</filename>
<filename>/usr/local/lib/systemd/system-generators/*</filename>
<filename>&systemgeneratordir;/*</filename></literallayout>
<filename>&SYSTEM_GENERATOR_DIR;/*</filename></literallayout>
</para>
<para>
<literallayout><filename>/run/systemd/user-generators/*</filename>
<filename>/etc/systemd/user-generators/*</filename>
<filename>/usr/local/lib/systemd/user-generators/*</filename>
<filename>&usergeneratordir;/*</filename></literallayout>
<filename>&USER_GENERATOR_DIR;/*</filename></literallayout>
</para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>Generators are small executables placed in <filename>&systemgeneratordir;/</filename> and other
<para>Generators are small executables placed in <filename>&SYSTEM_GENERATOR_DIR;/</filename> and other
directories listed above.
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> will execute
these binaries very early at bootup and at configuration reload time — before unit files are
@ -294,7 +294,7 @@
<title>Debugging a generator</title>
<programlisting>dir=$(mktemp -d)
SYSTEMD_LOG_LEVEL=debug &systemgeneratordir;/systemd-fstab-generator \
SYSTEMD_LOG_LEVEL=debug &SYSTEM_GENERATOR_DIR;/systemd-fstab-generator \
"$dir" "$dir" "$dir"
find $dir</programlisting>
</example>