man: improve systemd-escape --path description
authorLucas Werkmeister <mail@lucaswerkmeister.de>
Sun, 30 Oct 2016 00:42:22 +0000 (02:42 +0200)
committerLucas Werkmeister <mail@lucaswerkmeister.de>
Sun, 30 Oct 2016 00:42:22 +0000 (02:42 +0200)
The option does more than the documentation gave it credit for.

man/systemd-escape.xml

index dbb3869..acf8e0a 100644 (file)
         <term><option>-p</option></term>
 
         <listitem><para>When escaping or unescaping a string, assume
-        it refers to a file system path. This enables special
-        processing of the initial <literal>/</literal> of the
-        path.</para></listitem>
+        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>
       </varlistentry>
 
       <varlistentry>