summaryrefslogtreecommitdiff
path: root/man/systemd-escape.xml
diff options
context:
space:
mode:
authorLucas Werkmeister <mail@lucaswerkmeister.de>2016-10-30 23:49:15 +0100
committerLucas Werkmeister <mail@lucaswerkmeister.de>2018-06-25 11:17:55 +0200
commitd936cddcb560c9ff9992caed850114fb957c40f4 (patch)
tree13dbb82d93764c6a3d290aba9bb2d01f9617b7ac /man/systemd-escape.xml
parente563e2534c074f3d10cb1eb9e9bb4eb623590587 (diff)
downloadsystemd-d936cddcb560c9ff9992caed850114fb957c40f4.tar.gz
escape: add --instance option
Suggested by @keszybz in #4522.
Diffstat (limited to 'man/systemd-escape.xml')
-rw-r--r--man/systemd-escape.xml20
1 files changed, 19 insertions, 1 deletions
diff --git a/man/systemd-escape.xml b/man/systemd-escape.xml
index 8329e5d7c4..f61c07ae9d 100644
--- a/man/systemd-escape.xml
+++ b/man/systemd-escape.xml
@@ -80,7 +80,8 @@
<option>--unescape</option>, expects instantiated unit names
for this template and extracts and unescapes just the instance
part. May not be used in conjunction with
- <option>--suffix=</option> or
+ <option>--suffix=</option>,
+ <option>--instance</option> or
<option>--mangle</option>.</para></listitem>
</varlistentry>
@@ -118,6 +119,19 @@
<option>--unescape</option>.</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>--instance</option></term>
+
+ <listitem><para>With <option>--unescape</option>, unescape
+ and print only the instance part of an instantiated unit name
+ template. Results in an error for an uninstantiated template
+ like <filename>ssh@.service</filename> or a non-template name
+ like <filename>ssh.service</filename>.
+ Must be used in conjunction with <option>--unescape</option>
+ and may not be used in conjunction with
+ <option>--template</option>.</para></listitem>
+ </varlistentry>
+
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
</variablelist>
@@ -144,6 +158,10 @@ tmp-waldi-foobar.mount</programlisting>
systemd-nspawn@My\x20Container\x201.service systemd-nspawn@containerb.service systemd-nspawn@container-III.service</programlisting>
<para>To extract the instance part of an instantiated unit:</para>
+ <programlisting>$ systemd-escape -u --instance 'systemd-nspawn@My\x20Container\x201.service'
+My Container 1</programlisting>
+
+ <para>To extract the instance part of an instance of a particular template:</para>
<programlisting>$ systemd-escape -u --template=systemd-nspawn@.service 'systemd-nspawn@My\x20Container\x201.service'
My Container 1</programlisting>
</refsect1>