source: general/genutils/rxvt-unicode.xml@ 8aeb474

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

  <!ENTITY rxvt-unicode-download-http "http://dist.schmorp.de/rxvt-unicode/Attic/rxvt-unicode-&rxvt-unicode-version;.tar.bz2">
  <!ENTITY rxvt-unicode-download-ftp  " ">
  <!ENTITY rxvt-unicode-md5sum        "15595aa326167ac5eb68c28d95432faf">
  <!ENTITY rxvt-unicode-size          "874 KB">
  <!ENTITY rxvt-unicode-buildsize     "27 MB">
  <!ENTITY rxvt-unicode-time          "0.2 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>rxvt-unicode-&rxvt-unicode-version;</title>

  <indexterm zone="rxvt-unicode">
    <primary sortas="a-rxvt-unicode">rxvt-unicode</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to rxvt-unicode</title>

    <para><application>rxvt-unicode</application> is a clone of the terminal
    emulator <application>rxvt</application>, an X Window System terminal
    emulator which includes support for XFT and Unicode.</para>

    &lfs72_checked;

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

    <bridgehead renderas="sect3">rxvt-unicode Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="x-window-system"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="pkgconfig"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
    <xref linkend="gdk-pixbuf"/>, or <ulink
    url="http://sourceforge.net/projects/afterstep">libAfterImage</ulink>
    (these add support for background images and simulated transparency)</para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url='&blfs-wiki;/rxvt-unicode'/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of rxvt-unicode</title>

    <para>Install <application>rxvt-unicode</application> by running the
    following commands:</para>

<screen><userinput>./configure --prefix=/usr --enable-everything &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</userinput></screen>

  </sect2>

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

    <para><parameter>--enable-everything</parameter>: Add support for all
    non-multichoice options. Details about the different options can be found in
    the file <filename>README.configure</filename>.</para>

    <para><option>--disable-xft</option>: Remove support for Xft fonts.</para>

    <para><option>--disable-perl</option>: Disable the embedded
    <application>Perl</application> interpreter.</para>

    <para><option>--disable-afterimage</option>: Remove support for
    libAfterImage.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring rxvt-unicode</title>

    <para>The <application>rxvt-unicode</application> terminal emulator
    uses the resource class <classname>URxvt</classname> and the resource name
    <classname>urxvt</classname>. You can add X resource definitions to a
    user's <filename>~/.Xresources</filename> file or to the system-wide
    <filename>/etc/X11/app-defaults/URxvt</filename> file. The following
    example will load the <classname>matcher</classname>
    <application>Perl</application> extension (assuming
    <application>Perl</application> support wasn't disabled), which enables a
    middle button click to open an underlined URL in the specified browser,
    sets a background and foreground color and loads an Xft font:</para>

<screen><userinput>cat &gt;&gt; /etc/X11/app-defaults/URxvt &lt;&lt; "EOF"
<literal>URxvt*perl-ext: matcher
URxvt*urlLauncher: firefox
URxvt.background: black
URxvt.foreground: yellow
URxvt*font: xft:Monospace:pixelsize=12</literal>
EOF</userinput></screen>

    <para>The <application>rxvt-unicode</application> application can also run
    in a daemon mode, which makes it possible to open multiple terminal windows
    within the same process. The <command>urxvtc</command> client then connects
    to the <command>urxvtd</command> daemon and requests a new terminal window.
    Use this option with caution. If the daemon crashes, all the running
    processes in the terminal windows are terminated.</para>

    <para>You can start the <command>urxvtd</command> daemon in the system or
    personal startup <command>X</command> session script (e.g.,
    <filename>~/.xinitrc</filename>) by adding the following lines near the top
    of the script:</para>

<screen><userinput><literal># Start the urxvtd daemon
urxvtd -q -f -o &amp;</literal></userinput></screen>

    <para>For more information, examine the <command>urxvt</command>,
    <command>urxvtd</command>, <command>urxvtc</command>, and
    <filename>urxvtperl</filename> man pages.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>urxvt, urxvtd, and urxvtc</seg>
        <seg>Many <application>Perl</application> extensions located under
        <filename class='directory'>/usr/lib/urxvt/perl</filename></seg>
        <seg>/usr/lib/urxvt</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="urxvt-bin">
        <term><command>urxvt</command></term>
        <listitem>
          <para>is a terminal emulator for the X Window System.</para>
          <indexterm zone="rxvt-unicode urxvt-bin">
            <primary sortas="b-urxvt-bin">urxvt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="urxvtd">
        <term><command>urxvtd</command></term>
        <listitem>
          <para>is the <command>urxvt</command> terminal daemon.</para>
          <indexterm zone="rxvt-unicode urxvtd">
            <primary sortas="b-urxvtd">urxvtd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="urxvtc">
        <term><command>urxvtc</command></term>
        <listitem>
          <para>controls the <command>urxvtd</command> daemon.</para>
          <indexterm zone="rxvt-unicode urxvtc">
            <primary sortas="b-urxvtc">urxvtc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>