From 9045c9cedb155255e4dd55b988a39093364efbac Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 7 Jul 2014 22:48:25 +0200 Subject: [PATCH] man: document systemd-escape(1) (cherry picked from commit 9869e75929acd9377aa460074334d8523cf8e822) Conflicts: Makefile-man.am --- Makefile-man.am | 2 + man/systemd-escape.xml | 193 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 195 insertions(+) create mode 100644 man/systemd-escape.xml diff --git a/Makefile-man.am b/Makefile-man.am index 5c289dda2a..4238c21710 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -63,6 +63,7 @@ MANPAGES += \ man/systemd-delta.1 \ man/systemd-detect-virt.1 \ man/systemd-efi-boot-generator.8 \ + man/systemd-escape.1 \ man/systemd-fsck@.service.8 \ man/systemd-fstab-generator.8 \ man/systemd-getty-generator.8 \ @@ -1600,6 +1601,7 @@ EXTRA_DIST += \ man/systemd-delta.xml \ man/systemd-detect-virt.xml \ man/systemd-efi-boot-generator.xml \ + man/systemd-escape.xml \ man/systemd-fsck@.service.xml \ man/systemd-fstab-generator.xml \ man/systemd-getty-generator.xml \ diff --git a/man/systemd-escape.xml b/man/systemd-escape.xml new file mode 100644 index 0000000000..b2a4a9ce8c --- /dev/null +++ b/man/systemd-escape.xml @@ -0,0 +1,193 @@ + + + + + + + + + systemd-escape + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-escape + 1 + + + + systemd-escape + Escape strings for usage in system unit names + + + + + systemd-escape OPTIONS STRING + + + + + Description + + 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 the other. It will output them separated by + spaces to stdout. + + By default this command will escape the strings + passed, unless is passed + which results in the inverse operation being + applied. If a special mode + of escaping is applied instead, which assumes a string + to be already escaped but will escape everything that + appears obviously non-escaped. + + + + Options + + The following options are understood: + + + + + + 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 + , + or + . + + + + + + 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 + , + or + . + + + + + + + When escaping or + unescaping a string, assume it refers + to a file system path. This enables + special processing of the initial + / of the + path. + + + + + + Instead of escaping + the specified strings, undo the + escaping, reversing the operation. May + not be used in conjunction with + , + or + . + + + + + + Like + , 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 + , + or + . + + + + + + + + + + Examples + + 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 + + On success, 0 is returned, a non-zero failure + code otherwise. + + + + See Also + + systemd1, + systemctl1 + + + +