[b5951ec] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/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">
|
---|
| 9 | <!ENTITY emacs-md5sum "8f9d97cbd126121bd5d97e5e31168a87">
|
---|
| 10 | <!ENTITY emacs-size "20.4 MB">
|
---|
| 11 | <!ENTITY emacs-buildsize "96.8 MB">
|
---|
[a760926] | 12 | <!ENTITY emacs-time "4.2 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 |
|
---|
[c1ac942] | 57 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 58 | <itemizedlist spacing="compact">
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>Required patch: <ulink
|
---|
| 61 | url="&patch-root;/emacs-&emacs-version;-altgr-1.patch"/></para>
|
---|
| 62 | </listitem>
|
---|
| 63 | </itemizedlist>
|
---|
| 64 |
|
---|
[c0a34eb] | 65 | <bridgehead renderas="sect3">Emacs Dependencies</bridgehead>
|
---|
[ed59474e] | 66 |
|
---|
| 67 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[e77976f] | 68 | <para role="optional"><xref linkend="x-window-system"/>,
|
---|
[3aa07d1] | 69 | <xref linkend="libjpeg"/>,
|
---|
| 70 | <xref linkend="libpng"/>,
|
---|
[13679edb] | 71 | <xref linkend="libtiff"/>, and
|
---|
[0d93d684] | 72 | <!-- <xref linkend="libungif"/> or -->
|
---|
[e77976f] | 73 | <ulink
|
---|
| 74 | url="http://sourceforge.net/projects/libungif">libungif</ulink></para>
|
---|
| 75 | <!-- <xref linkend="giflib"/></para> -->
|
---|
[ed59474e] | 76 |
|
---|
[3597eb6] | 77 | <para condition="html" role="usernotes">User Notes:
|
---|
| 78 | <ulink url="&blfs-wiki;/emacs"/></para>
|
---|
| 79 |
|
---|
[ed59474e] | 80 | </sect2>
|
---|
| 81 |
|
---|
| 82 | <sect2 role="installation">
|
---|
| 83 | <title>Installation of Emacs</title>
|
---|
| 84 |
|
---|
[c1ac942] | 85 | <para>In some circumstances, the AltGr modifier key present on some
|
---|
| 86 | keyboards is not recognized. Ensure that it is by applying the
|
---|
| 87 | following patch:</para>
|
---|
| 88 |
|
---|
| 89 | <screen><userinput>patch -Np1 -i ../emacs-&emacs-version;-altgr-1.patch</userinput></screen>
|
---|
| 90 |
|
---|
[3aa07d1] | 91 | <para>Install <application>Emacs</application> by running the following
|
---|
[ed59474e] | 92 | commands:</para>
|
---|
| 93 |
|
---|
[a760926] | 94 | <screen><userinput>./configure --prefix=/usr --libexecdir=/usr/lib &&
|
---|
[ed59474e] | 95 | make bootstrap</userinput></screen>
|
---|
| 96 |
|
---|
[c1ac942] | 97 | <para>This package does not come with a test suite.</para>
|
---|
| 98 |
|
---|
[ed59474e] | 99 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 100 |
|
---|
| 101 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 102 |
|
---|
| 103 | </sect2>
|
---|
| 104 |
|
---|
[32ccdf34] | 105 | <sect2 role="commands">
|
---|
| 106 | <title>Command Explanations</title>
|
---|
| 107 |
|
---|
| 108 | <para><option>--libexecdir=/usr/lib</option>: Place library
|
---|
| 109 | executables in a Filesystem Hierarchy Standard (FHS) location.</para>
|
---|
| 110 |
|
---|
| 111 | </sect2>
|
---|
| 112 |
|
---|
[ed59474e] | 113 | <sect2 role="content">
|
---|
| 114 | <title>Contents</title>
|
---|
| 115 |
|
---|
| 116 | <segmentedlist>
|
---|
| 117 | <segtitle>Installed Programs</segtitle>
|
---|
| 118 | <segtitle>Installed Libraries</segtitle>
|
---|
| 119 | <segtitle>Installed Directories</segtitle>
|
---|
| 120 |
|
---|
| 121 | <seglistitem>
|
---|
| 122 | <seg>b2m, ctags, ebrowse, emacs, emacsclient, etags, grep-changelog,
|
---|
| 123 | and rcs-checkin</seg>
|
---|
| 124 | <seg>None</seg>
|
---|
| 125 | <seg>/usr/sbin/emacs and /usr/share/emacs</seg>
|
---|
| 126 | </seglistitem>
|
---|
| 127 | </segmentedlist>
|
---|
| 128 |
|
---|
| 129 | <variablelist>
|
---|
| 130 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 131 | <?dbfo list-presentation="list"?>
|
---|
| 132 | <?dbhtml list-presentation="table"?>
|
---|
| 133 |
|
---|
| 134 | <varlistentry id="b2m">
|
---|
| 135 | <term><command>b2m</command></term>
|
---|
| 136 | <listitem>
|
---|
| 137 | <para>is a program to convert mail files from RMAIL
|
---|
| 138 | format to Unix <quote>mbox</quote> format.</para>
|
---|
| 139 | <indexterm zone="emacs b2m">
|
---|
| 140 | <primary sortas="b-b2m">b2m</primary>
|
---|
| 141 | </indexterm>
|
---|
| 142 | </listitem>
|
---|
| 143 | </varlistentry>
|
---|
| 144 |
|
---|
| 145 | <varlistentry id="ctags">
|
---|
[550ca80] | 146 | <term><command>ctags</command></term>
|
---|
[ed59474e] | 147 | <listitem>
|
---|
| 148 | <para>creates cross-reference tagfile database files
|
---|
| 149 | for source code.</para>
|
---|
| 150 | <indexterm zone="emacs ctags">
|
---|
| 151 | <primary sortas="b-ctags">ctags</primary>
|
---|
| 152 | </indexterm>
|
---|
| 153 | </listitem>
|
---|
| 154 | </varlistentry>
|
---|
| 155 |
|
---|
| 156 | <varlistentry id="ebrowse">
|
---|
| 157 | <term><command>ebrowse</command></term>
|
---|
| 158 | <listitem>
|
---|
| 159 | <para>permits browsing of C++ class hierarchies from
|
---|
| 160 | within <command>emacs</command>.</para>
|
---|
| 161 | <indexterm zone="emacs ebrowse">
|
---|
| 162 | <primary sortas="b-ebrowse">ebrowse</primary>
|
---|
| 163 | </indexterm>
|
---|
| 164 | </listitem>
|
---|
| 165 | </varlistentry>
|
---|
| 166 |
|
---|
| 167 | <varlistentry id="emacs-prog">
|
---|
| 168 | <term><command>emacs</command></term>
|
---|
| 169 | <listitem>
|
---|
| 170 | <para>is an editor.</para>
|
---|
| 171 | <indexterm zone="emacs emacs-prog">
|
---|
| 172 | <primary sortas="b-emacs">emacs</primary>
|
---|
| 173 | </indexterm>
|
---|
| 174 | </listitem>
|
---|
| 175 | </varlistentry>
|
---|
| 176 |
|
---|
| 177 | <varlistentry id="emacsclient">
|
---|
| 178 | <term><command>emacsclient</command></term>
|
---|
| 179 | <listitem>
|
---|
[13679edb] | 180 | <para>attaches an <command>emacs</command> session to an already
|
---|
[ed59474e] | 181 | running <command>emacsserver</command> instance.</para>
|
---|
| 182 | <indexterm zone="emacs emacsclient">
|
---|
| 183 | <primary sortas="b-emacsclient">emacsclient</primary>
|
---|
| 184 | </indexterm>
|
---|
| 185 | </listitem>
|
---|
| 186 | </varlistentry>
|
---|
| 187 |
|
---|
| 188 | <varlistentry id="etags">
|
---|
| 189 | <term><command>etags</command></term>
|
---|
| 190 | <listitem>
|
---|
| 191 | <para>is another program to generate source code
|
---|
| 192 | cross-reference tagfiles.</para>
|
---|
| 193 | <indexterm zone="emacs etags">
|
---|
| 194 | <primary sortas="b-etags">etags</primary>
|
---|
| 195 | </indexterm>
|
---|
| 196 | </listitem>
|
---|
| 197 | </varlistentry>
|
---|
| 198 |
|
---|
| 199 | <varlistentry id="grep-changelog">
|
---|
| 200 | <term><command>grep-changelog</command></term>
|
---|
| 201 | <listitem>
|
---|
| 202 | <para>prints entries in Change Logs matching
|
---|
| 203 | various criteria.</para>
|
---|
| 204 | <indexterm zone="emacs grep-changelog">
|
---|
| 205 | <primary sortas="b-grep-changelog">grep-changelog</primary>
|
---|
| 206 | </indexterm>
|
---|
| 207 | </listitem>
|
---|
| 208 | </varlistentry>
|
---|
| 209 |
|
---|
| 210 | <varlistentry id="rcs-checkin">
|
---|
| 211 | <term><command>rcs-checkin</command></term>
|
---|
| 212 | <listitem>
|
---|
| 213 | <para>is a shell script used to check files into RCS.</para>
|
---|
| 214 | <indexterm zone="emacs rcs-checkin">
|
---|
| 215 | <primary sortas="b-rcs-checkin">rcs-checkin</primary>
|
---|
| 216 | </indexterm>
|
---|
| 217 | </listitem>
|
---|
| 218 | </varlistentry>
|
---|
[a7a755a] | 219 |
|
---|
[3aa07d1] | 220 | <!--
|
---|
[b5951ec] | 221 | <sect3><title>cvt-mail</title>
|
---|
[3aa07d1] | 222 | <para><command>cvt-mail</command> converts old style goslings emacs mail
|
---|
[d4afab2] | 223 | directories into gnu-rmail format.</para></sect3>
|
---|
[b5951ec] | 224 |
|
---|
| 225 | <sect3><title>digest-doc</title>
|
---|
[3aa07d1] | 226 | <para><command>digest-doc</command> is a filter to create nroff output for man
|
---|
[d4afab2] | 227 | pages.</para></sect3>
|
---|
[b5951ec] | 228 |
|
---|
| 229 | <sect3><title>emacsserver</title>
|
---|
[3aa07d1] | 230 | <para><command>emacserver</command> allows other applications/shells to access
|
---|
[d4afab2] | 231 | an already running emacs instance and share buffers with it.</para></sect3>
|
---|
[b5951ec] | 232 |
|
---|
| 233 | <sect3><title>fakemail</title>
|
---|
| 234 | <para><command>fakemail</command> is a sendmail-like interface to
|
---|
| 235 | <filename>/bin/mail</filename>.</para></sect3>
|
---|
| 236 |
|
---|
| 237 | <sect3><title>hexl</title>
|
---|
[3aa07d1] | 238 | <para><command>hexl</command> converts files for editing with emacs hexl-mode
|
---|
[d4afab2] | 239 | binary file editing mode.</para></sect3>
|
---|
[b5951ec] | 240 |
|
---|
| 241 | <sect3><title>movemail</title>
|
---|
| 242 | <para><command>movemail</command> provides access to
|
---|
[ed59474e] | 243 | POP3 mailboxes.</para></sect3>
|
---|
[b5951ec] | 244 |
|
---|
| 245 | <sect3><title>profile</title>
|
---|
[3aa07d1] | 246 | <para><command>profile</command> generates periodic events for profiling of
|
---|
[d4afab2] | 247 | Emacs Lisp code.</para></sect3>
|
---|
[b5951ec] | 248 |
|
---|
| 249 | <sect3><title>rcs2log</title>
|
---|
| 250 | <para><command>rcs2log</command> generates change log prefixes from
|
---|
[ed59474e] | 251 | RCS files.</para></sect3>
|
---|
[b5951ec] | 252 |
|
---|
| 253 | <sect3><title>sorted-doc</title>
|
---|
[3aa07d1] | 254 | <para><command>sorted-doc</command> is a filter to generate texinfo
|
---|
[d4afab2] | 255 | files.</para></sect3>
|
---|
[b5951ec] | 256 |
|
---|
| 257 | <sect3><title>vcdiff</title>
|
---|
[3aa07d1] | 258 | <para><command>vcdiff</command> compares SCCS
|
---|
[d4afab2] | 259 | files.</para></sect3>
|
---|
[b5951ec] | 260 |
|
---|
| 261 | <sect3><title>yow</title>
|
---|
[3aa07d1] | 262 | <para><command>yow</command> prints a quotation from Zippy the
|
---|
[a7a755a] | 263 | Pinhead.</para></sect3> -->
|
---|
[ed59474e] | 264 | </variablelist>
|
---|
[b5951ec] | 265 |
|
---|
[ed59474e] | 266 | </sect2>
|
---|
[f45b1953] | 267 |
|
---|
| 268 | </sect1>
|
---|