X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-escape.xml;h=0c3b2305264bf279c11e8477a8213d9743b7187d;hp=b2a4a9ce8c43fa3a534c12380a984a78a74373f6;hb=56fd6bf795926409b087bce406ea851ad89f9fe8;hpb=9869e75929acd9377aa460074334d8523cf8e822 diff --git a/man/systemd-escape.xml b/man/systemd-escape.xml index b2a4a9ce8..0c3b23052 100644 --- a/man/systemd-escape.xml +++ b/man/systemd-escape.xml @@ -1,6 +1,6 @@ + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - - - 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' + xmlns:xi="http://www.w3.org/2001/XInclude"> + + + 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' + 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/" + 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' + 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 - - + + + + Exit status + + On success, 0 is returned, a non-zero failure code + otherwise. + + + + See Also + + systemd1, + systemctl1 + +