source: postlfs/editors/emacs.xml@ b5951ec

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

<sect1 id="postlfs-editors-emacs" xreflabel="Emacs-&emacs-version;">
<?dbhtml filename="emacs.html"?>
<title>Emacs-&emacs-version;</title>

<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 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"/></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 &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>Emacs</application> package contains <command>emacs</command>,
<command>b2m</command>, <command>ctags</command>,
<command>ebrowse</command>, <command>emacsclient</command>,
<command>etags</command>, <command>grep-changelog</command>,
<command>rcs-checkin</command>, <command>cvt-mail</command>,
<command>digest-doc</command>, <command>emacsserver</command>,
<command>fakemail</command>, <command>hexl</command>,
<command>movemail</command>, <command>profile</command>,
<command>rcs2log</command>, <command>sorted-doc</command>,
<command>vcdiff</command> and <command>yow</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>emacs</title>
<para>The editor proper.</para></sect3>

<sect3><title>b2m</title>
<para><command>b2m</command> is a program to convert mail files from RMAIL format to Unix
<quote>mbox</quote> format.</para></sect3>

<sect3><title>ctags</title>
<para><command>ctags</command> creates cross-reference tagfile database files for source
code.</para></sect3>

<sect3><title>ebrowse</title>

<para><command>ebrowse</command> permits browsing of C++ class hierarchies from
within emacs.</para></sect3>

<sect3><title>emacsclient</title>
<para><command>emacsclient</command> attaches an emacs session to an already running
emacsserver instance.</para></sect3>

<sect3><title>etags</title>
<para><command>etags</command> is another program to generate source code cross-reference
tagfiles.</para></sect3>

<sect3><title>grep-changelog</title>
<para><command>grep-changelog</command> prints entries in Change Logs matching 
various criteria.</para></sect3>

<sect3><title>rcs-checkin</title>
<para><command>rcs-checkin</command> is a shell script used to check
files into <acronym>RCS</acronym>.</para></sect3>

<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>

</sect2>

</sect1>