man/systemd-pty-forward.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="systemd-pty-forward"
   7     xmlns:xi="http://www.w3.org/2001/XInclude">
   8   <refentryinfo>
   9     <title>systemd-pty-forward</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>systemd-pty-forward</refentrytitle>
  15     <manvolnum>1</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>systemd-pty-forward</refname>
  20     <refpurpose>Run a command with a custom terminal background color or title</refpurpose>
  21   </refnamediv>
  22
  23   <refsynopsisdiv>
  24     <cmdsynopsis>
  25       <command>systemd-pty-forward</command>
  26       <arg choice="opt" rep="repeat">OPTIONS</arg>
  27       <arg choice="req">COMMAND</arg>
  28     </cmdsynopsis>
  29   </refsynopsisdiv>
  30
  31   <refsect1>
  32     <title>Description</title>
  33
  34     <para><command>systemd-pty-forward</command> can be used to run a command with a custom terminal
  35     background color or title.</para>
  36   </refsect1>
  37
  38   <refsect1>
  39     <title>Options</title>
  40     <para>The following options are understood:</para>
  41
  42     <variablelist>
  43       <varlistentry>
  44         <term><option>--background=<replaceable>COLOR</replaceable></option></term>
  45
  46         <listitem><para>Change the terminal background color to the specified ANSI color as long as the
  47         command runs. The color specified should be an ANSI X3.64 SGR background color, i.e. strings such as
  48         <literal>40</literal>, <literal>41</literal>, …, <literal>47</literal>, <literal>48;2;…</literal>,
  49         <literal>48;5;…</literal>. See <ulink
  50         url="https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters">ANSI
  51         Escape Code (Wikipedia)</ulink> for details.</para>
  52
  53         <para>Example: <literal>--background=44</literal> for a blue background.</para>
  54
  55         <xi:include href="version-info.xml" xpointer="v258"/>
  56         </listitem>
  57       </varlistentry>
  58
  59       <varlistentry>
  60         <term><option>--title=<replaceable>TITLE</replaceable></option></term>
  61
  62         <listitem><para>Change the terminal title to the specified string as long as the command runs.</para>
  63
  64         <xi:include href="version-info.xml" xpointer="v258"/>
  65         </listitem>
  66       </varlistentry>
  67
  68       <varlistentry>
  69         <term><option>--quiet</option></term>
  70         <term><option>-q</option></term>
  71
  72         <listitem><para>Suppresses additional informational output while running.</para>
  73
  74         <xi:include href="version-info.xml" xpointer="v258"/></listitem>
  75       </varlistentry>
  76
  77       <varlistentry>
  78         <term><option>--read-only</option></term>
  79
  80         <listitem><para>Do not accept any user input on standard input.</para>
  81
  82         <xi:include href="version-info.xml" xpointer="v258"/></listitem>
  83       </varlistentry>
  84
  85       <xi:include href="standard-options.xml" xpointer="help"/>
  86       <xi:include href="standard-options.xml" xpointer="version"/>
  87     </variablelist>
  88   </refsect1>
  89 </refentry>