source: general/genutils/screen.xml@ 1fcdfae

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY screen-download-http "http://ftp.gnu.org/pub/gnu/screen/screen-&screen-version;.tar.gz">
  <!ENTITY screen-download-ftp "ftp://ftp.gnu.org/pub/gnu/screen/screen-&screen-version;.tar.gz">
  <!ENTITY screen-md5sum "ed68ea9b43d9fba0972cb017a24940a1">
  <!ENTITY screen-size "825 KB">
  <!ENTITY screen-buildsize "5.8 MB">
  <!ENTITY screen-time "0.2 SBU">
]>

<sect1 id="screen" xreflabel="Screen-&screen-version;">
  <?dbhtml filename="screen.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">screen-&screen-version;.tar</keyword>
      <keyword role="ftpdir">screen</keyword>
    </keywordset>
  </sect1info>

  <title>Screen-&screen-version;</title>

  <indexterm zone="screen">
    <primary sortas="a-Screen">Screen</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Screen</title>

    <para><application>Screen</application> is a terminal multiplexor that
    runs several separate processes, typically interactive shells, on a single
    physical character-based terminal. Each virtual terminal emulates a DEC
    VT100 plus several ANSI X3.64 and ISO 2022 functions and also supports
    configurable input and output translation, serial port support, configurable
    logging, multi-user support, and UTF-8 character encoding support (currently
    not supported by LFS). Screen sessions can be detached and resumed
    later on a different terminal.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&screen-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&screen-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &screen-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &screen-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &screen-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &screen-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Screen Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="linux-pam"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Screen</title>

    <para>Install <application>Screen</application> by running the
    following commands:</para>

<screen><userinput>./configure --prefix=/usr --with-socket-dir=/var/run/screen \
    --with-sys-screenrc=/etc/screenrc &amp;&amp;
sed -i -e "s%/usr/local/etc/screenrc%/etc/screenrc%" {etc,doc}/* &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
install -m 644 etc/etcscreenrc /etc/screenrc</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--with-socket-dir=/var/run/screen</parameter>: This option
    places the per-user sockets in a standard location.</para>

    <para><parameter>--with-sys-screenrc=/etc/screenrc</parameter>: This option
    places the global screenrc file in <filename
    class='directory'>/etc</filename>.  </para>

    <para><command>sed -i -e "s%/usr/local/etc/screenrc%/etc/screenrc%"
    {etc,doc}/*</command>: This command corrects the configuration and
    documention files to the location that is used here for the global
    screenrc file.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Screen</title>

    <sect3 id ="screen-config">
      <title>Config Files</title>

      <para><filename>/etc/screenrc</filename> and
      <filename>~/.screenrc</filename></para>

      <indexterm zone="screen screen-config">
        <primary sortas="e-AA.screenrc">~/.screenrc</primary>
      </indexterm>

      <indexterm zone="screen screen-config">
        <primary sortas="e-etc-screenrc">/etc/screenrc</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>You may want to look at the example configuration file that was
      installed and customize it for your needs.</para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>screen</seg>
        <seg>None</seg>
        <seg>/var/run/screen</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="screen-prog">
        <term><command>screen</command></term>
        <listitem>
          <para>is a terminal multiplexor with VT100/ANSI
          terminal emulation.</para>
          <indexterm zone="screen screen-prog">
            <primary sortas="b-screen">screen</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>