man/systemd-escape.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2014 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd-escape"
  25     xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27   <refentryinfo>
  28     <title>systemd-escape</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Lennart</firstname>
  35         <surname>Poettering</surname>
  36         <email>lennart@poettering.net</email>
  37       </author>
  38     </authorgroup>
  39   </refentryinfo>
  40
  41   <refmeta>
  42     <refentrytitle>systemd-escape</refentrytitle>
  43     <manvolnum>1</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>systemd-escape</refname>
  48     <refpurpose>Escape strings for usage in systemd unit names</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <cmdsynopsis>
  53       <command>systemd-escape</command>
  54       <arg choice="opt" rep="repeat">OPTIONS</arg>
  55       <arg choice="opt" rep="repeat">STRING</arg>
  56     </cmdsynopsis>
  57   </refsynopsisdiv>
  58
  59   <refsect1>
  60     <title>Description</title>
  61
  62     <para><command>systemd-escape</command> may be used to escape
  63     strings for inclusion in systemd unit names. The command may be
  64     used to escape and to undo escaping of strings.</para>
  65
  66     <para>The command takes any number of strings on the command line,
  67     and will process them individually, one after another. It will
  68     output them separated by spaces to stdout.</para>
  69
  70     <para>By default, this command will escape the strings passed,
  71     unless <option>--unescape</option> is passed which results in the
  72     inverse operation being applied. If <option>--mangle</option> is given, a
  73     special mode of escaping is applied instead, which assumes the
  74     string is already escaped but will escape everything that
  75     appears obviously non-escaped.</para>
  76
  77     <para>For details on the escaping and unescaping algorithms see the relevant section in
  78     <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  79   </refsect1>
  80
  81   <refsect1>
  82     <title>Options</title>
  83
  84     <para>The following options are understood:</para>
  85
  86     <variablelist>
  87       <varlistentry>
  88         <term><option>--suffix=</option></term>
  89
  90         <listitem><para>Appends the specified unit type suffix to the
  91         escaped string. Takes one of the unit types supported by
  92         systemd, such as <literal>service</literal> or
  93         <literal>mount</literal>. May not be used in conjunction with
  94         <option>--template=</option>, <option>--unescape</option> or
  95         <option>--mangle</option>.</para></listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term><option>--template=</option></term>
 100
 101         <listitem><para>Inserts the escaped strings in a unit name
 102         template. Takes a unit name template such as
 103         <filename>foobar@.service</filename>. May not be used in
 104         conjunction with <option>--suffix=</option>,
 105         <option>--unescape</option> or
 106         <option>--mangle</option>.</para></listitem>
 107       </varlistentry>
 108
 109       <varlistentry>
 110         <term><option>--path</option></term>
 111         <term><option>-p</option></term>
 112
 113         <listitem><para>When escaping or unescaping a string, assume it refers to a file system path. This eliminates
 114         leading, trailing or duplicate <literal>/</literal> characters and rejects <literal>.</literal> and
 115         <literal>..</literal> path components. This is particularly useful for generating strings suitable for
 116         unescaping with the <literal>%f</literal> specifier in unit files, see
 117         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 118         </para></listitem>
 119       </varlistentry>
 120
 121       <varlistentry>
 122         <term><option>--unescape</option></term>
 123
 124         <listitem><para>Instead of escaping the specified strings,
 125         undo the escaping, reversing the operation. May not be used in
 126         conjunction with <option>--suffix=</option>,
 127         <option>--template=</option> or
 128         <option>--mangle</option>.</para></listitem>
 129       </varlistentry>
 130
 131       <varlistentry>
 132         <term><option>--mangle</option></term>
 133
 134         <listitem><para>Like <option>--escape</option>, but only
 135         escape characters that are obviously not escaped yet, and
 136         possibly automatically append an appropriate unit type suffix
 137         to the string. May not be used in conjunction with
 138         <option>--suffix=</option>, <option>--template=</option> or
 139         <option>--unescape</option>.</para></listitem>
 140       </varlistentry>
 141
 142       <xi:include href="standard-options.xml" xpointer="help" />
 143       <xi:include href="standard-options.xml" xpointer="version" />
 144     </variablelist>
 145
 146   </refsect1>
 147
 148   <refsect1>
 149     <title>Examples</title>
 150
 151     <para>To escape a single string:</para>
 152     <programlisting>$ systemd-escape 'Hallöchen, Meister'
 153 Hall\xc3\xb6chen\x2c\x20Meister</programlisting>
 154
 155     <para>To undo escaping on a single string:</para>
 156     <programlisting>$ systemd-escape -u 'Hall\xc3\xb6chen\x2c\x20Meister'
 157 Hallöchen, Meister</programlisting>
 158
 159     <para>To generate the mount unit for a path:</para>
 160     <programlisting>$ systemd-escape -p --suffix=mount "/tmp//waldi/foobar/"
 161 tmp-waldi-foobar.mount</programlisting>
 162
 163     <para>To generate instance names of three strings:</para>
 164     <programlisting>$ systemd-escape --template=systemd-nspawn@.service 'My Container 1' 'containerb' 'container/III'
 165 systemd-nspawn@My\x20Container\x201.service systemd-nspawn@containerb.service systemd-nspawn@container-III.service</programlisting>
 166   </refsect1>
 167
 168   <refsect1>
 169     <title>Exit status</title>
 170
 171     <para>On success, 0 is returned, a non-zero failure code
 172     otherwise.</para>
 173   </refsect1>
 174
 175   <refsect1>
 176     <title>See Also</title>
 177     <para>
 178       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 179       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 180       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 181     </para>
 182   </refsect1>
 183
 184 </refentry>