diff options
| author | Lennart Poettering <lennart@poettering.net> | 2017-10-26 12:22:38 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2017-11-10 19:45:29 +0100 |
| commit | 2651d037518bbcfab06d6d070b86fcf667942e97 (patch) | |
| tree | b304b2445faa53332b41b1605a24809d718743c1 /man/systemd-escape.xml | |
| parent | 40b1a32ca854b5ce29029d358c924e1b18f4a1d0 (diff) | |
| download | systemd-2651d037518bbcfab06d6d070b86fcf667942e97.tar.gz | |
man: extend documentation on the unit name escaping logic
Diffstat (limited to 'man/systemd-escape.xml')
| -rw-r--r-- | man/systemd-escape.xml | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/man/systemd-escape.xml b/man/systemd-escape.xml index fb20d2d94f..a2f2b9242f 100644 --- a/man/systemd-escape.xml +++ b/man/systemd-escape.xml @@ -73,6 +73,9 @@ special mode of escaping is applied instead, which assumes the string is already escaped but will escape everything that appears obviously non-escaped.</para> + + <para>For details on the escaping and unescaping algorithms see the relevant section in + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> </refsect1> <refsect1> @@ -107,11 +110,12 @@ <term><option>--path</option></term> <term><option>-p</option></term> - <listitem><para>When escaping or unescaping a string, assume - it refers to a file system path. This eliminates leading, - trailing or duplicate <literal>/</literal> characters - and rejects <literal>.</literal> and <literal>..</literal> - path components.</para></listitem> + <listitem><para>When escaping or unescaping a string, assume it refers to a file system path. This eliminates + leading, trailing or duplicate <literal>/</literal> characters and rejects <literal>.</literal> and + <literal>..</literal> path components. This is particularly useful for generating strings suitable for + unescaping with the <literal>%f</literal> specifier in unit files, see + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + </para></listitem> </varlistentry> <varlistentry> @@ -172,6 +176,7 @@ systemd-nspawn@My\x20Container\x201.service systemd-nspawn@containerb.service sy <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> |