NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | SEE ALSO | COLOPHON

SYSTEMD-ESCAPE(1)              systemd-escape              SYSTEMD-ESCAPE(1)

NAME         top

       systemd-escape - Escape strings for usage in system unit names

SYNOPSIS         top

       systemd-escape [OPTIONS...] [STRING...]

DESCRIPTION         top

       systemd-escape may be used to escape strings for inclusion in systemd
       unit names. The command may be used to escape and to undo escaping of
       strings.

       The command takes any number of strings on the command line, and will
       process them individually, one after another. It will output them
       separated by spaces to stdout.

       By default, this command will escape the strings passed, unless
       --unescape is passed which results in the inverse operation being
       applied. If --mangle is given, a special mode of escaping is applied
       instead, which assumes the string is already escaped but will escape
       everything that appears obviously non-escaped.

OPTIONS         top

       The following options are understood:

       --suffix=
           Appends the specified unit type suffix to the escaped string.
           Takes one of the unit types supported by systemd, such as
           "service" or "mount". May not be used in conjunction with
           --template=, --unescape or --mangle.

       --template=
           Inserts the escaped strings in a unit name template. Takes a unit
           name template such as foobar@.service. May not be used in
           conjunction with --suffix=, --unescape or --mangle.

       --path, -p
           When escaping or unescaping a string, assume it refers to a file
           system path. This eliminates leading, trailing or duplicate "/"
           characters and rejects "."  and ".."  path components.

       --unescape
           Instead of escaping the specified strings, undo the escaping,
           reversing the operation. May not be used in conjunction with
           --suffix=, --template= or --mangle.

       --mangle
           Like --escape, but only escape characters that are obviously not
           escaped yet, and possibly automatically append an appropriate
           unit type suffix to the string. May not be used in conjunction
           with --suffix=, --template= or --unescape.

       -h, --help
           Print a short help text and exit.

       --version
           Print a short version string and exit.

EXAMPLES         top

       To escape a single string:

           $ systemd-escape 'Hallöchen, Meister'
           Hall\xc3\xb6chen\x2c\x20Meister

       To undo escaping on a single string:

           $ systemd-escape -u 'Hall\xc3\xb6chen\x2c\x20Meister'
           Hallöchen, Meister

       To generate the mount unit for a path:

           $ systemd-escape -p --suffix=mount "/tmp//waldi/foobar/"
           tmp-waldi-foobar.mount

       To generate instance names of three strings:

           $ systemd-escape --template=systemd-nspawn@.service 'My Container 1' 'containerb' 'container/III'
           systemd-nspawn@My\x20Container\x201.service systemd-nspawn@containerb.service systemd-nspawn@container-III.service

EXIT STATUS         top

       On success, 0 is returned, a non-zero failure code otherwise.

SEE ALSO         top

       systemd(1), systemctl(1)

COLOPHON         top

       This page is part of the systemd (systemd system and service manager)
       project.  Information about the project can be found at 
       ⟨http://www.freedesktop.org/wiki/Software/systemd⟩.  If you have a bug
       report for this manual page, see 
       ⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩.  This
       page was obtained from the project's upstream Git repository 
       ⟨https://github.com/systemd/systemd.git⟩ on 2017-07-05.  If you dis‐
       cover any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page, or
       you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail
       to man-pages@man7.org

systemd 234                                                SYSTEMD-ESCAPE(1)

Pages that refer to this page: systemd.unit(5)systemd.directives(7)systemd.index(7)