glfs/xsoft/other/rxvt-unicode.xml
Ken Moffat 193af65e56 Tags.
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23556 af4574ff-66df-0310-9fd7-8a98e5e911e0
2020-08-18 02:58:45 +00:00

328 lines
11 KiB
XML

<?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 "93782dec27494eb079467dacf6e48185">
<!ENTITY rxvt-unicode-size "910 KB">
<!ENTITY rxvt-unicode-buildsize "23 MB (plus 9 MB if gdk-pixbuf is present)">
<!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>
&lfs10_checked;
<note>
<para>
<!-- https://github.com/Perl/perl5/issues/12349 -->
Please be aware that <application>rxvt-unicode</application> is
affected by an issue in <application>perl</application> where
the SIGFPE handler is set to SIG_IGN (i.e. the signal is ignored).
If you are building an LFS system from within <command>urxvt</command>
and running the testsuites, tests in <application>bash</application> and
<application>check</application> which test raising this signal will fail.
</para>
</note>
<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">Optional</bridgehead>
<para role="optional">
<xref linkend="gdk-pixbuf"/> (for background images) and
<xref linkend="startup-notification"/>
</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> or
<filename>~/.Xdefaults</filename> files 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 left button click to open an underlined URL in the specified browser,
sets a background and foreground color and loads an Xft font (as the
<systemitem class="username">root</systemitem> user):
</para>
<screen role="root"><userinput>cat &gt;&gt; /etc/X11/app-defaults/URxvt &lt;&lt; "EOF"
<literal>! Use the specified colour as the windows background colour [default white]
URxvt*background: black
! Use the specified colour as the windows foreground colour [default black]
URxvt*foreground: yellow
! Select the fonts to be used. This is a comma separated list of font names
URxvt*font: xft:Monospace:pixelsize=18
! Comma-separated list(s) of perl extension scripts (default: "default")
URxvt*perl-ext: matcher
! Specifies the program to be started with a URL argument. Used by
URxvt*url-launcher: firefox
! When clicked with the mouse button specified in the "matcher.button" resource
! (default 2, or middle), the program specified in the "matcher.launcher"
! resource (default, the "url-launcher" resource, "sensible-browser") will be
! started with the matched text as first argument.
! Below, default modified to mouse left button.
URxvt*matcher.button: 1</literal>
EOF</userinput></screen>
<para>
In order to view the defined X resources, issue:
</para>
<screen role="nodump"><userinput>xrdb -query</userinput></screen>
<para>
In order to add the modifications of the new user configuration file,
keeping previously X configurations (of course, unless you are changing
any on previously define), issue:
</para>
<screen role="nodump"><userinput>xrdb -merge ~/.Xresources</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 role="nodump"><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>
<para>
If you use a Desktop Environment, a menu entry can be included,
issuing, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>cat &gt; /usr/share/applications/urxvt.desktop &lt;&lt; "EOF" &amp;&amp;
<literal>[Desktop Entry]
Encoding=UTF-8
Name=Rxvt-Unicode Terminal
Comment=Use the command line
GenericName=Terminal
Exec=urxvt
Terminal=false
Type=Application
Icon=utilities-terminal
Categories=GTK;Utility;TerminalEmulator;
#StartupNotify=true
Keywords=console;command line;execute;</literal>
EOF
update-desktop-database -q</userinput></screen>
<para>
For that, you need <xref linkend="desktop-file-utils"/> and at least
one of <xref linkend="gnome-icon-theme"/>, <xref linkend="oxygen-icons5"/>
and <xref linkend="lxde-icon-theme"/>. Uncomment the line with
<quote>StartupNotify=true</quote> if <xref
linkend="startup-notification"/> is installed.
</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>