1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
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">
|
---|
8 | <!ENTITY emacs-download-ftp "ftp://ftp.gnu.org/pub/gnu/emacs/emacs-&emacs-version;.tar.gz">
|
---|
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">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="emacs" xreflabel="Emacs-&emacs-version;">
|
---|
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 |
|
---|
32 | <para>The <application>Emacs</application> package contains an extensible,
|
---|
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 |
|
---|
57 | <bridgehead renderas="sect3">Emacs Dependencies</bridgehead>
|
---|
58 |
|
---|
59 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
60 | <para role="optional"><xref linkend="x-window-system"/>,
|
---|
61 | <xref linkend="libjpeg"/>,
|
---|
62 | <xref linkend="libpng"/>,
|
---|
63 | <xref linkend="libtiff"/>, and
|
---|
64 | <ulink url="http://sourceforge.net/projects/libungif">libungif</ulink></para>
|
---|
65 | <!-- <xref linkend="giflib"/></para> -->
|
---|
66 |
|
---|
67 | <para condition="html" role="usernotes">User Notes:
|
---|
68 | <ulink url="&blfs-wiki;/emacs"/></para>
|
---|
69 |
|
---|
70 | </sect2>
|
---|
71 |
|
---|
72 | <sect2 role="installation">
|
---|
73 | <title>Installation of Emacs</title>
|
---|
74 |
|
---|
75 | <para>Install <application>Emacs</application> by running the following
|
---|
76 | commands:</para>
|
---|
77 |
|
---|
78 | <screen><userinput>./configure --prefix=/usr \
|
---|
79 | --libexecdir=/usr/lib \
|
---|
80 | --localstatedir=/var &&
|
---|
81 | make bootstrap</userinput></screen>
|
---|
82 |
|
---|
83 | <para>This package does not come with a test suite.</para>
|
---|
84 |
|
---|
85 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
86 |
|
---|
87 | <screen role="root"><userinput>make install &&
|
---|
88 | chown -v -R root:root /usr/share/emacs/&emacs-version;</userinput></screen>
|
---|
89 |
|
---|
90 | </sect2>
|
---|
91 |
|
---|
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 |
|
---|
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 |
|
---|
102 | </sect2>
|
---|
103 |
|
---|
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>
|
---|
116 | <seg>/usr/lib/emacs, /usr/share/emacs and /var/games/emacs</seg>
|
---|
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">
|
---|
137 | <term><command>ctags</command></term>
|
---|
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>
|
---|
171 | <para>attaches an <command>emacs</command> session to an already
|
---|
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>
|
---|
210 |
|
---|
211 | <!--
|
---|
212 | <sect3><title>cvt-mail</title>
|
---|
213 | <para><command>cvt-mail</command> converts old style goslings emacs mail
|
---|
214 | directories into gnu-rmail format.</para></sect3>
|
---|
215 |
|
---|
216 | <sect3><title>digest-doc</title>
|
---|
217 | <para><command>digest-doc</command> is a filter to create nroff output for man
|
---|
218 | pages.</para></sect3>
|
---|
219 |
|
---|
220 | <sect3><title>emacsserver</title>
|
---|
221 | <para><command>emacserver</command> allows other applications/shells to access
|
---|
222 | an already running emacs instance and share buffers with it.</para></sect3>
|
---|
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>
|
---|
229 | <para><command>hexl</command> converts files for editing with emacs hexl-mode
|
---|
230 | binary file editing mode.</para></sect3>
|
---|
231 |
|
---|
232 | <sect3><title>movemail</title>
|
---|
233 | <para><command>movemail</command> provides access to
|
---|
234 | POP3 mailboxes.</para></sect3>
|
---|
235 |
|
---|
236 | <sect3><title>profile</title>
|
---|
237 | <para><command>profile</command> generates periodic events for profiling of
|
---|
238 | Emacs Lisp code.</para></sect3>
|
---|
239 |
|
---|
240 | <sect3><title>rcs2log</title>
|
---|
241 | <para><command>rcs2log</command> generates change log prefixes from
|
---|
242 | RCS files.</para></sect3>
|
---|
243 |
|
---|
244 | <sect3><title>sorted-doc</title>
|
---|
245 | <para><command>sorted-doc</command> is a filter to generate texinfo
|
---|
246 | files.</para></sect3>
|
---|
247 |
|
---|
248 | <sect3><title>vcdiff</title>
|
---|
249 | <para><command>vcdiff</command> compares SCCS
|
---|
250 | files.</para></sect3>
|
---|
251 |
|
---|
252 | <sect3><title>yow</title>
|
---|
253 | <para><command>yow</command> prints a quotation from Zippy the
|
---|
254 | Pinhead.</para></sect3> -->
|
---|
255 | </variablelist>
|
---|
256 |
|
---|
257 | </sect2>
|
---|
258 |
|
---|
259 | </sect1>
|
---|