[b5951ec] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[b5951ec] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY emacs-download-http "http://ftp.gnu.org/pub/gnu/emacs/emacs-&emacs-version;.tar.gz">
|
---|
[3d38064] | 8 | <!ENTITY emacs-download-ftp "ftp://ftp.gnu.org/pub/gnu/emacs/emacs-&emacs-version;.tar.gz">
|
---|
[755379cb] | 9 | <!ENTITY emacs-md5sum "6949df37caec2d7a2e0eee3f1b422726">
|
---|
| 10 | <!ENTITY emacs-size "36.4 MB">
|
---|
| 11 | <!ENTITY emacs-buildsize "260 MB">
|
---|
| 12 | <!ENTITY emacs-time "3.3 SBU">
|
---|
[b5951ec] | 13 | ]>
|
---|
| 14 |
|
---|
[a7a755a] | 15 | <sect1 id="emacs" xreflabel="Emacs-&emacs-version;">
|
---|
[ed59474e] | 16 | <?dbhtml filename="emacs.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Emacs-&emacs-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="emacs">
|
---|
| 26 | <primary sortas="a-Emacs">Emacs</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Emacs</title>
|
---|
| 31 |
|
---|
[13679edb] | 32 | <para>The <application>Emacs</application> package contains an extensible,
|
---|
[ed59474e] | 33 | customizable, self-documenting real-time display editor.</para>
|
---|
| 34 |
|
---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>Download (HTTP): <ulink url="&emacs-download-http;"/></para>
|
---|
| 39 | </listitem>
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>Download (FTP): <ulink url="&emacs-download-ftp;"/></para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>Download MD5 sum: &emacs-md5sum;</para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download size: &emacs-size;</para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Estimated disk space required: &emacs-buildsize;</para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Estimated build time: &emacs-time;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | </itemizedlist>
|
---|
| 56 |
|
---|
[c0a34eb] | 57 | <bridgehead renderas="sect3">Emacs Dependencies</bridgehead>
|
---|
[ed59474e] | 58 |
|
---|
| 59 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[e77976f] | 60 | <para role="optional"><xref linkend="x-window-system"/>,
|
---|
[3aa07d1] | 61 | <xref linkend="libjpeg"/>,
|
---|
| 62 | <xref linkend="libpng"/>,
|
---|
[13679edb] | 63 | <xref linkend="libtiff"/>, and
|
---|
[755379cb] | 64 | <ulink url="http://sourceforge.net/projects/libungif">libungif</ulink></para>
|
---|
[e77976f] | 65 | <!-- <xref linkend="giflib"/></para> -->
|
---|
[ed59474e] | 66 |
|
---|
[3597eb6] | 67 | <para condition="html" role="usernotes">User Notes:
|
---|
| 68 | <ulink url="&blfs-wiki;/emacs"/></para>
|
---|
| 69 |
|
---|
[ed59474e] | 70 | </sect2>
|
---|
| 71 |
|
---|
| 72 | <sect2 role="installation">
|
---|
| 73 | <title>Installation of Emacs</title>
|
---|
| 74 |
|
---|
[3aa07d1] | 75 | <para>Install <application>Emacs</application> by running the following
|
---|
[ed59474e] | 76 | commands:</para>
|
---|
| 77 |
|
---|
[755379cb] | 78 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 79 | --libexecdir=/usr/lib \
|
---|
| 80 | --localstatedir=/var &&
|
---|
[ed59474e] | 81 | make bootstrap</userinput></screen>
|
---|
| 82 |
|
---|
[c1ac942] | 83 | <para>This package does not come with a test suite.</para>
|
---|
| 84 |
|
---|
[ed59474e] | 85 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 86 |
|
---|
[755379cb] | 87 | <screen role="root"><userinput>make install &&
|
---|
| 88 | chown -v -R root:root /usr/share/emacs/&emacs-version;</userinput></screen>
|
---|
[ed59474e] | 89 |
|
---|
| 90 | </sect2>
|
---|
| 91 |
|
---|
[32ccdf34] | 92 | <sect2 role="commands">
|
---|
| 93 | <title>Command Explanations</title>
|
---|
| 94 |
|
---|
| 95 | <para><option>--libexecdir=/usr/lib</option>: Place library
|
---|
| 96 | executables in a Filesystem Hierarchy Standard (FHS) location.</para>
|
---|
| 97 |
|
---|
[755379cb] | 98 | <para><option>--localstatedir=/var</option>: Create game score files
|
---|
| 99 | in <filename class='directory'>/var/games/emacs</filename> instead
|
---|
| 100 | of <filename class='directory'>/usr/var/games/emacs</filename>.</para>
|
---|
| 101 |
|
---|
[32ccdf34] | 102 | </sect2>
|
---|
| 103 |
|
---|
[ed59474e] | 104 | <sect2 role="content">
|
---|
| 105 | <title>Contents</title>
|
---|
| 106 |
|
---|
| 107 | <segmentedlist>
|
---|
| 108 | <segtitle>Installed Programs</segtitle>
|
---|
| 109 | <segtitle>Installed Libraries</segtitle>
|
---|
| 110 | <segtitle>Installed Directories</segtitle>
|
---|
| 111 |
|
---|
| 112 | <seglistitem>
|
---|
| 113 | <seg>b2m, ctags, ebrowse, emacs, emacsclient, etags, grep-changelog,
|
---|
| 114 | and rcs-checkin</seg>
|
---|
| 115 | <seg>None</seg>
|
---|
[755379cb] | 116 | <seg>/usr/lib/emacs, /usr/share/emacs and /var/games/emacs</seg>
|
---|
[ed59474e] | 117 | </seglistitem>
|
---|
| 118 | </segmentedlist>
|
---|
| 119 |
|
---|
| 120 | <variablelist>
|
---|
| 121 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 122 | <?dbfo list-presentation="list"?>
|
---|
| 123 | <?dbhtml list-presentation="table"?>
|
---|
| 124 |
|
---|
| 125 | <varlistentry id="b2m">
|
---|
| 126 | <term><command>b2m</command></term>
|
---|
| 127 | <listitem>
|
---|
| 128 | <para>is a program to convert mail files from RMAIL
|
---|
| 129 | format to Unix <quote>mbox</quote> format.</para>
|
---|
| 130 | <indexterm zone="emacs b2m">
|
---|
| 131 | <primary sortas="b-b2m">b2m</primary>
|
---|
| 132 | </indexterm>
|
---|
| 133 | </listitem>
|
---|
| 134 | </varlistentry>
|
---|
| 135 |
|
---|
| 136 | <varlistentry id="ctags">
|
---|
[550ca80] | 137 | <term><command>ctags</command></term>
|
---|
[ed59474e] | 138 | <listitem>
|
---|
| 139 | <para>creates cross-reference tagfile database files
|
---|
| 140 | for source code.</para>
|
---|
| 141 | <indexterm zone="emacs ctags">
|
---|
| 142 | <primary sortas="b-ctags">ctags</primary>
|
---|
| 143 | </indexterm>
|
---|
| 144 | </listitem>
|
---|
| 145 | </varlistentry>
|
---|
| 146 |
|
---|
| 147 | <varlistentry id="ebrowse">
|
---|
| 148 | <term><command>ebrowse</command></term>
|
---|
| 149 | <listitem>
|
---|
| 150 | <para>permits browsing of C++ class hierarchies from
|
---|
| 151 | within <command>emacs</command>.</para>
|
---|
| 152 | <indexterm zone="emacs ebrowse">
|
---|
| 153 | <primary sortas="b-ebrowse">ebrowse</primary>
|
---|
| 154 | </indexterm>
|
---|
| 155 | </listitem>
|
---|
| 156 | </varlistentry>
|
---|
| 157 |
|
---|
| 158 | <varlistentry id="emacs-prog">
|
---|
| 159 | <term><command>emacs</command></term>
|
---|
| 160 | <listitem>
|
---|
| 161 | <para>is an editor.</para>
|
---|
| 162 | <indexterm zone="emacs emacs-prog">
|
---|
| 163 | <primary sortas="b-emacs">emacs</primary>
|
---|
| 164 | </indexterm>
|
---|
| 165 | </listitem>
|
---|
| 166 | </varlistentry>
|
---|
| 167 |
|
---|
| 168 | <varlistentry id="emacsclient">
|
---|
| 169 | <term><command>emacsclient</command></term>
|
---|
| 170 | <listitem>
|
---|
[13679edb] | 171 | <para>attaches an <command>emacs</command> session to an already
|
---|
[ed59474e] | 172 | running <command>emacsserver</command> instance.</para>
|
---|
| 173 | <indexterm zone="emacs emacsclient">
|
---|
| 174 | <primary sortas="b-emacsclient">emacsclient</primary>
|
---|
| 175 | </indexterm>
|
---|
| 176 | </listitem>
|
---|
| 177 | </varlistentry>
|
---|
| 178 |
|
---|
| 179 | <varlistentry id="etags">
|
---|
| 180 | <term><command>etags</command></term>
|
---|
| 181 | <listitem>
|
---|
| 182 | <para>is another program to generate source code
|
---|
| 183 | cross-reference tagfiles.</para>
|
---|
| 184 | <indexterm zone="emacs etags">
|
---|
| 185 | <primary sortas="b-etags">etags</primary>
|
---|
| 186 | </indexterm>
|
---|
| 187 | </listitem>
|
---|
| 188 | </varlistentry>
|
---|
| 189 |
|
---|
| 190 | <varlistentry id="grep-changelog">
|
---|
| 191 | <term><command>grep-changelog</command></term>
|
---|
| 192 | <listitem>
|
---|
| 193 | <para>prints entries in Change Logs matching
|
---|
| 194 | various criteria.</para>
|
---|
| 195 | <indexterm zone="emacs grep-changelog">
|
---|
| 196 | <primary sortas="b-grep-changelog">grep-changelog</primary>
|
---|
| 197 | </indexterm>
|
---|
| 198 | </listitem>
|
---|
| 199 | </varlistentry>
|
---|
| 200 |
|
---|
| 201 | <varlistentry id="rcs-checkin">
|
---|
| 202 | <term><command>rcs-checkin</command></term>
|
---|
| 203 | <listitem>
|
---|
| 204 | <para>is a shell script used to check files into RCS.</para>
|
---|
| 205 | <indexterm zone="emacs rcs-checkin">
|
---|
| 206 | <primary sortas="b-rcs-checkin">rcs-checkin</primary>
|
---|
| 207 | </indexterm>
|
---|
| 208 | </listitem>
|
---|
| 209 | </varlistentry>
|
---|
[a7a755a] | 210 |
|
---|
[3aa07d1] | 211 | <!--
|
---|
[b5951ec] | 212 | <sect3><title>cvt-mail</title>
|
---|
[3aa07d1] | 213 | <para><command>cvt-mail</command> converts old style goslings emacs mail
|
---|
[d4afab2] | 214 | directories into gnu-rmail format.</para></sect3>
|
---|
[b5951ec] | 215 |
|
---|
| 216 | <sect3><title>digest-doc</title>
|
---|
[3aa07d1] | 217 | <para><command>digest-doc</command> is a filter to create nroff output for man
|
---|
[d4afab2] | 218 | pages.</para></sect3>
|
---|
[b5951ec] | 219 |
|
---|
| 220 | <sect3><title>emacsserver</title>
|
---|
[3aa07d1] | 221 | <para><command>emacserver</command> allows other applications/shells to access
|
---|
[d4afab2] | 222 | an already running emacs instance and share buffers with it.</para></sect3>
|
---|
[b5951ec] | 223 |
|
---|
| 224 | <sect3><title>fakemail</title>
|
---|
| 225 | <para><command>fakemail</command> is a sendmail-like interface to
|
---|
| 226 | <filename>/bin/mail</filename>.</para></sect3>
|
---|
| 227 |
|
---|
| 228 | <sect3><title>hexl</title>
|
---|
[3aa07d1] | 229 | <para><command>hexl</command> converts files for editing with emacs hexl-mode
|
---|
[d4afab2] | 230 | binary file editing mode.</para></sect3>
|
---|
[b5951ec] | 231 |
|
---|
| 232 | <sect3><title>movemail</title>
|
---|
| 233 | <para><command>movemail</command> provides access to
|
---|
[ed59474e] | 234 | POP3 mailboxes.</para></sect3>
|
---|
[b5951ec] | 235 |
|
---|
| 236 | <sect3><title>profile</title>
|
---|
[3aa07d1] | 237 | <para><command>profile</command> generates periodic events for profiling of
|
---|
[d4afab2] | 238 | Emacs Lisp code.</para></sect3>
|
---|
[b5951ec] | 239 |
|
---|
| 240 | <sect3><title>rcs2log</title>
|
---|
| 241 | <para><command>rcs2log</command> generates change log prefixes from
|
---|
[ed59474e] | 242 | RCS files.</para></sect3>
|
---|
[b5951ec] | 243 |
|
---|
| 244 | <sect3><title>sorted-doc</title>
|
---|
[3aa07d1] | 245 | <para><command>sorted-doc</command> is a filter to generate texinfo
|
---|
[d4afab2] | 246 | files.</para></sect3>
|
---|
[b5951ec] | 247 |
|
---|
| 248 | <sect3><title>vcdiff</title>
|
---|
[3aa07d1] | 249 | <para><command>vcdiff</command> compares SCCS
|
---|
[d4afab2] | 250 | files.</para></sect3>
|
---|
[b5951ec] | 251 |
|
---|
| 252 | <sect3><title>yow</title>
|
---|
[3aa07d1] | 253 | <para><command>yow</command> prints a quotation from Zippy the
|
---|
[a7a755a] | 254 | Pinhead.</para></sect3> -->
|
---|
[ed59474e] | 255 | </variablelist>
|
---|
[b5951ec] | 256 |
|
---|
[ed59474e] | 257 | </sect2>
|
---|
[f45b1953] | 258 |
|
---|
| 259 | </sect1>
|
---|