46a556f
From a32aaed144e387ab9464134ee95469174b33d5fd Mon Sep 17 00:00:00 2001
e3e6fc8
From: Lennart Poettering <lennart@poettering.net>
e3e6fc8
Date: Mon, 29 Apr 2013 20:55:34 -0300
e3e6fc8
Subject: [PATCH] man: improve documentation for specifiers (cherry picked from
e3e6fc8
 commit 0df2d38abfc787f40149072340d79b4f7b682a24)
e3e6fc8
e3e6fc8
---
e3e6fc8
 man/systemd.unit.xml | 19 ++++++-------------
e3e6fc8
 1 file changed, 6 insertions(+), 13 deletions(-)
e3e6fc8
e3e6fc8
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
e3e6fc8
index 47c5031..0dccb97 100644
e3e6fc8
--- a/man/systemd.unit.xml
e3e6fc8
+++ b/man/systemd.unit.xml
e3e6fc8
@@ -1233,7 +1233,7 @@
e3e6fc8
                       <row>
e3e6fc8
                         <entry><literal>%f</literal></entry>
e3e6fc8
                         <entry>Unescaped file name</entry>
e3e6fc8
-                        <entry>This is either the unescaped instance name (if applicable) with / prepended (if applicable), or the prefix name similarly prepended with /.</entry>
e3e6fc8
+                        <entry>This is either the unescaped instance name (if applicable) with <filename>/</filename> prepended (if applicable), or the prefix name similarly prepended with <filename>/</filename>.</entry>
e3e6fc8
                       </row>
e3e6fc8
                       <row>
e3e6fc8
                         <entry><literal>%c</literal></entry>
e3e6fc8
@@ -1242,13 +1242,13 @@
e3e6fc8
                       </row>
e3e6fc8
                       <row>
e3e6fc8
                         <entry><literal>%r</literal></entry>
e3e6fc8
-                        <entry>Root control group path of systemd</entry>
e3e6fc8
-                        <entry></entry>
e3e6fc8
+                        <entry>Root control group path where units are placed.</entry>
e3e6fc8
+                        <entry>For system instances this usually resolves to <filename>/system</filename>, except in containers, where the path might be prefixed with the container's root control group.</entry>
e3e6fc8
                       </row>
e3e6fc8
                       <row>
e3e6fc8
                         <entry><literal>%R</literal></entry>
e3e6fc8
-                        <entry>Parent directory of the root control group path of systemd</entry>
e3e6fc8
-                        <entry></entry>
e3e6fc8
+                        <entry>Parent directory of the control group path where units are placed.</entry>
e3e6fc8
+                        <entry>For system instances this usually resolves to <filename>/</filename>, except in containers, where this resolves to the container's root directory. This specifier is particularly useful in the <varname>ControlGroup=</varname> setting (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</entry>
e3e6fc8
                       </row>
e3e6fc8
                       <row>
e3e6fc8
                         <entry><literal>%t</literal></entry>
e3e6fc8
@@ -1273,14 +1273,7 @@
e3e6fc8
                       <row>
e3e6fc8
                         <entry><literal>%s</literal></entry>
e3e6fc8
                         <entry>User shell</entry>
e3e6fc8
-                        <entry>This is the shell of the configured
e3e6fc8
-                        user of the unit, or (if none is set) the user
e3e6fc8
-                        running the systemd instance.  If the user is
e3e6fc8
-                        <literal>root</literal> (UID equal to 0), the
e3e6fc8
-                        shell configured in account database is
e3e6fc8
-                        ignored and <filename>/bin/sh</filename> is
e3e6fc8
-                        always used.
e3e6fc8
-                        </entry>
e3e6fc8
+                        <entry>This is the shell of the configured user of the unit, or (if none is set) the user running the systemd instance.  If the user is <literal>root</literal> (UID equal to 0), the shell configured in account database is ignored and <filename>/bin/sh</filename> is always used.</entry>
e3e6fc8
                       </row>
e3e6fc8
                       <row>
e3e6fc8
                         <entry><literal>%m</literal></entry>