glfs/postlfs/editors/emacs.xml

265 lines
8.7 KiB
XML

<?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;
<!-- Inserted as a reminder to do this. The mention of a test suite
is usually right before the root user installation commands. Please
delete these 12 (including one blank) lines after you are done.-->
<!-- Use one of the two mentions below about a test suite,
delete the line that is not applicable. Of course, if the
test suite uses syntax other than "make check", revise the
line to reflect the actual syntax to run the test suite -->
<!-- <para>This package does not come with a test suite.</para> -->
<!-- <para>To test the results, issue: <command>make check</command>.</para> -->
<!ENTITY emacs-download-http "http://ftp.gnu.org/pub/gnu/emacs/emacs-&emacs-version;.tar.gz">
<!ENTITY emacs-download-ftp "ftp://ftp.gnu.org/pub/gnu/emacs/emacs-&emacs-version;.tar.gz">
<!ENTITY emacs-md5sum "8f9d97cbd126121bd5d97e5e31168a87">
<!ENTITY emacs-size "20.4 MB">
<!ENTITY emacs-buildsize "96.8 MB">
<!ENTITY emacs-time "4.2 SBU">
]>
<sect1 id="emacs" xreflabel="Emacs-&emacs-version;">
<?dbhtml filename="emacs.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>Emacs-&emacs-version;</title>
<indexterm zone="emacs">
<primary sortas="a-Emacs">Emacs</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to Emacs</title>
<para>The <application>Emacs</application> package contains an extensible,
customizable, self-documenting real-time display editor.</para>
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&emacs-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&emacs-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &emacs-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &emacs-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &emacs-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &emacs-time;</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Emacs Dependencies</bridgehead>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="x-window-system"/>,
<xref linkend="libjpeg"/>,
<xref linkend="libpng"/>,
<xref linkend="libtiff"/>, and
<!-- <xref linkend="libungif"/> or -->
<ulink
url="http://sourceforge.net/projects/libungif">libungif</ulink></para>
<!-- <xref linkend="giflib"/></para> -->
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/emacs"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of Emacs</title>
<para>Install <application>Emacs</application> by running the following
commands:</para>
<screen><userinput>./configure --prefix=/usr --libexecdir=/usr/lib &amp;&amp;
make bootstrap</userinput></screen>
<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><option>--libexecdir=/usr/lib</option>: Place library
executables in a Filesystem Hierarchy Standard (FHS) location.</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>b2m, ctags, ebrowse, emacs, emacsclient, etags, grep-changelog,
and rcs-checkin</seg>
<seg>None</seg>
<seg>/usr/sbin/emacs and /usr/share/emacs</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="b2m">
<term><command>b2m</command></term>
<listitem>
<para>is a program to convert mail files from RMAIL
format to Unix <quote>mbox</quote> format.</para>
<indexterm zone="emacs b2m">
<primary sortas="b-b2m">b2m</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="ctags">
<term><command>ctags</command></term>
<listitem>
<para>creates cross-reference tagfile database files
for source code.</para>
<indexterm zone="emacs ctags">
<primary sortas="b-ctags">ctags</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="ebrowse">
<term><command>ebrowse</command></term>
<listitem>
<para>permits browsing of C++ class hierarchies from
within <command>emacs</command>.</para>
<indexterm zone="emacs ebrowse">
<primary sortas="b-ebrowse">ebrowse</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="emacs-prog">
<term><command>emacs</command></term>
<listitem>
<para>is an editor.</para>
<indexterm zone="emacs emacs-prog">
<primary sortas="b-emacs">emacs</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="emacsclient">
<term><command>emacsclient</command></term>
<listitem>
<para>attaches an <command>emacs</command> session to an already
running <command>emacsserver</command> instance.</para>
<indexterm zone="emacs emacsclient">
<primary sortas="b-emacsclient">emacsclient</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="etags">
<term><command>etags</command></term>
<listitem>
<para>is another program to generate source code
cross-reference tagfiles.</para>
<indexterm zone="emacs etags">
<primary sortas="b-etags">etags</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="grep-changelog">
<term><command>grep-changelog</command></term>
<listitem>
<para>prints entries in Change Logs matching
various criteria.</para>
<indexterm zone="emacs grep-changelog">
<primary sortas="b-grep-changelog">grep-changelog</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="rcs-checkin">
<term><command>rcs-checkin</command></term>
<listitem>
<para>is a shell script used to check files into RCS.</para>
<indexterm zone="emacs rcs-checkin">
<primary sortas="b-rcs-checkin">rcs-checkin</primary>
</indexterm>
</listitem>
</varlistentry>
<!--
<sect3><title>cvt-mail</title>
<para><command>cvt-mail</command> converts old style goslings emacs mail
directories into gnu-rmail format.</para></sect3>
<sect3><title>digest-doc</title>
<para><command>digest-doc</command> is a filter to create nroff output for man
pages.</para></sect3>
<sect3><title>emacsserver</title>
<para><command>emacserver</command> allows other applications/shells to access
an already running emacs instance and share buffers with it.</para></sect3>
<sect3><title>fakemail</title>
<para><command>fakemail</command> is a sendmail-like interface to
<filename>/bin/mail</filename>.</para></sect3>
<sect3><title>hexl</title>
<para><command>hexl</command> converts files for editing with emacs hexl-mode
binary file editing mode.</para></sect3>
<sect3><title>movemail</title>
<para><command>movemail</command> provides access to
POP3 mailboxes.</para></sect3>
<sect3><title>profile</title>
<para><command>profile</command> generates periodic events for profiling of
Emacs Lisp code.</para></sect3>
<sect3><title>rcs2log</title>
<para><command>rcs2log</command> generates change log prefixes from
RCS files.</para></sect3>
<sect3><title>sorted-doc</title>
<para><command>sorted-doc</command> is a filter to generate texinfo
files.</para></sect3>
<sect3><title>vcdiff</title>
<para><command>vcdiff</command> compares SCCS
files.</para></sect3>
<sect3><title>yow</title>
<para><command>yow</command> prints a quotation from Zippy the
Pinhead.</para></sect3> -->
</variablelist>
</sect2>
</sect1>