man: clarify path escaping and reference systemd-escape

This patch adds more detail to the description of how path escaping
operates and provides a pointer to the systemd-escape program. Either
would serve to answer the question raised in the bug report, so
hopefully this will allow it to be closed.

https://bugs.freedesktop.org/show_bug.cgi?id=87688
(cherry picked from commit 995084c7b4)
This commit is contained in:
Chris Atkinson
2015-01-16 00:56:58 -05:00
committed by Zbigniew Jędrzejewski-Szmek
parent 16bf8f4096
commit 14d8078ce6
+11 -6
View File
@@ -225,12 +225,17 @@
the file system namespace. If this applies, a special
way to escape the path name is used, so that the
result is usable as part of a filename. Basically,
given a path, "/" is replaced by "-", and all
unprintable characters and the "-" are replaced by
C-style "\x2d" escapes. The root directory "/" is
encoded as single dash, while otherwise the initial
and ending "/" is removed from all paths during
transformation. This escaping is reversible.</para>
given a path, "/" is replaced by "-" and all other
characters which are not ASCII alphanumerics are
replaced by C-style "\x2d" escapes (except that "_"
is never replaced and "." is only replaced when it
would be the first character in the escaped path).
The root directory "/" is encoded as single dash,
while otherwise the initial and ending "/" are removed
from all paths during transformation. This escaping
is reversible. Properly escaped paths can be generated
using the <citerefentry><refentrytitle>systemd-escape</refentrytitle><manvolnum>1</manvolnum></citerefentry>
command.</para>
<para>Optionally, units may be instantiated from a
template file at runtime. This allows creation of