source: postlfs/editors/emacs.xml@ d7444dee

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

  <!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    "0a68ea5b29bb2f081ba8dd85d37bb9bc">
  <!ENTITY emacs-size      "20 MB">
  <!ENTITY emacs-buildsize "96.8 MB">
  <!ENTITY emacs-time      "4.20 SBU">
]>

<sect1 id="emacs" xreflabel="Emacs-&emacs-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="emacs.html"?>
<title>Emacs-&emacs-version;</title>
<indexterm zone="emacs"><primary
sortas="a-Emacs">Emacs</primary></indexterm>

<sect2>
<title>Introduction to <application>Emacs</application></title>

<para>The <application>Emacs</application> package contains the extensible, 
customizable, self-documenting real-time display editor.</para>

<sect3><title>Package information</title>
<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>
</sect3>

<sect3><title><application>Emacs</application> dependencies</title>
<sect4><title>Optional</title>
<para>X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>), 
<xref linkend="libjpeg"/>, 
<xref linkend="libpng"/>, 
<xref linkend="libtiff"/> and 
<xref linkend="libungif"/> or <xref linkend="giflib"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Emacs</application></title>

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

<screen><userinput><command>./configure --prefix=/usr \
   --libexecdir=/usr/sbin &amp;&amp;
make bootstrap</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>b2m, ctags, ebrowse, emacs, emacsclient, etags, grep-changelog and rcs-checkin</seg>
<seg>/usr/sbin/emacs and /usr/share/emacs</seg>
</seglistitem>
</segmentedlist>

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

<varlistentry id="b2m">
<term><filename>b2m</filename></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><filename>b2m</filename></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><filename>ebrowse</filename></term>
<listitem><para>permits browsing of C++ class hierarchies from
within emacs.</para>
<indexterm zone="emacs ebrowse">
<primary sortas="b-ebrowse">ebrowse</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="emacs-prog">
<term><filename>emacs</filename></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><filename>emacsclient</filename></term>
<listitem><para>attaches an emacs session to an already
running emacsserver instance.</para>
<indexterm zone="emacs emacsclient">
<primary sortas="b-emacsclient">emacsclient</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="etags">
<term><filename>etags</filename></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><filename>grep-changelog</filename></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><filename>rcs-checkin</filename></term>
<listitem><para>is a shell script used to check
files into <acronym>RCS</acronym>.</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
<acronym>POP</acronym>3 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
<acronym>RCS</acronym> 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 <acronym>SCCS</acronym> 
files.</para></sect3>

<sect3><title>yow</title>
<para><command>yow</command> prints a quotation from Zippy the 
Pinhead.</para></sect3>  -->
</variablelist>

</sect2>

</sect1>