run: add a new "-t" mode for invoking a binary on an allocated TTY

[elogind.git] / man / systemd-run.xml

diff --git a/man/systemd-run.xml b/man/systemd-run.xml
index b9cec91d1573632d499644bcbe722c871af70633..5fb4ee28eb3191388c64fe83c6eab6010a25368a 100644 (file)
--- a/man/systemd-run.xml
+++ b/man/systemd-run.xml
@@ -225,10 +225,16 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         </listitem>
       </varlistentry>
 
-      <xi:include href="user-system-options.xml" xpointer="user" />
-      <xi:include href="user-system-options.xml" xpointer="system" />
-      <xi:include href="user-system-options.xml" xpointer="host" />
-      <xi:include href="user-system-options.xml" xpointer="machine" />
+      <varlistentry>
+        <term><option>--pty</option></term>
+        <term><option>-t</option></term>
+
+        <listitem><para>When invoking a command as service connects
+        its standard input and output to the invoking tty via a
+        pseudo TTY device. This allows invoking binaries as services
+        that expect interactive user input, such as an interactive
+        command shells.</para></listitem>
+      </varlistentry>
 
       <varlistentry>
         <term><option>--on-active=</option></term>
@@ -278,6 +284,11 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <command>set-property</command> command.</para> </listitem>
       </varlistentry>
 
+      <xi:include href="user-system-options.xml" xpointer="user" />
+      <xi:include href="user-system-options.xml" xpointer="system" />
+      <xi:include href="user-system-options.xml" xpointer="host" />
+      <xi:include href="user-system-options.xml" xpointer="machine" />
+
       <xi:include href="standard-options.xml" xpointer="help" />
       <xi:include href="standard-options.xml" xpointer="version" />
     </variablelist>
@@ -333,6 +344,13 @@ Dec 08 20:44:38 container systemd[1]: Started /bin/touch /tmp/foo.
 -- Logs begin at Fri 2014-12-05 19:09:21 KST, end at Mon 2014-12-08 20:44:54 KST. --
 Dec 08 20:44:48 container systemd[1]: Starting /bin/touch /tmp/foo...
 Dec 08 20:44:48 container systemd[1]: Started /bin/touch /tmp/foo.</programlisting>
+
+    <para>The following command invokes <filename>/bin/bash</filename>
+    as a service passing its standard input, output and error to
+    the calling TTY.</para>
+
+    <programlisting># systemd-run -t /bin/bash</programlisting>
+
   </refsect1>
 
   <refsect1>