source: postlfs/editors/emacs.xml@ eed90c8

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since eed90c8 was eed90c8, checked in by Douglas R. Reno <renodr@…>, 16 months ago

Update to openldap-2.4.51
Update to wireshark-3.2.6
Update to udisks-2.9.1
Emacs: add optional dependency on jansson - adds JSON support
Minor nitpicks in gc and libxslt

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23515 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 9.5 KB
Line 
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 "&gnu-http;/emacs/emacs-&emacs-version;.tar.xz">
8 <!ENTITY emacs-download-ftp "&gnu-ftp;/emacs/emacs-&emacs-version;.tar.xz">
9 <!ENTITY emacs-download-ftp " ">
10 <!ENTITY emacs-md5sum "f1f25356b68ec69caccd41d95988d23d">
11 <!ENTITY emacs-size "42 MB">
12 <!ENTITY emacs-buildsize "480 MB">
13 <!ENTITY emacs-time "0.7 SBU (Using parallelism=4)">
14]>
15
16<sect1 id="emacs" xreflabel="Emacs-&emacs-version;">
17 <?dbhtml filename="emacs.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>Emacs-&emacs-version;</title>
25
26 <indexterm zone="emacs">
27 <primary sortas="a-Emacs">Emacs</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to Emacs</title>
32
33 <para>
34 The <application>Emacs</application> package contains an extensible,
35 customizable, self-documenting real-time display editor.
36 </para>
37
38 &lfs91_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&emacs-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&emacs-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &emacs-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &emacs-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &emacs-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &emacs-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">Emacs Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Recommended</bridgehead>
77 <para role="recommended">
78 <xref linkend="giflib"/>,
79 <xref linkend="gnutls"/>, and
80 <xref linkend="libtiff"/>
81 </para>
82
83 <bridgehead renderas="sect4">Optional</bridgehead>
84 <para role="optional">
85 <xref linkend="x-window-system"/>,
86 <xref linkend="alsa-lib"/>,
87 <xref linkend="dbus"/>,
88 <xref linkend="GConf"/>,
89 <xref linkend="gobject-introspection"/>,
90 <xref linkend="gsettings-desktop-schemas"/>,
91 <xref linkend="gpm"/>,
92 <xref role="nodep" linkend="gtk2"/> or <xref linkend="gtk3"/>,
93 <xref linkend="imagemagick6"/> (see command explanations),
94 <xref linkend="jansson"/>, <!-- for JSON support -->
95 <xref linkend="libjpeg"/>,
96 <xref linkend="libpng"/>,
97 <xref linkend="librsvg"/>,
98 <xref linkend="libxml2"/>,
99 <xref linkend="mitkrb"/>,
100 <xref linkend="valgrind"/>,
101 <ulink url="&gnu-http;/intlfonts/">intlfonts</ulink>,
102 <ulink url="http://directory.fsf.org/wiki/Libungif">libungif</ulink>,
103 <ulink url="http://www.nongnu.org/m17n/">libotf</ulink> and
104 <ulink url="http://www.nongnu.org/m17n/">m17n-lib</ulink> - to correctly
105 display such complex scripts as Indic and Khmer, and also for scripts
106 that require Arabic shaping support (Arabic and Farsi), and
107 <ulink url="&xorg-download-http;/lib/">libXaw3d</ulink>
108 </para>
109
110 <para condition="html" role="usernotes">User Notes:
111 <ulink url="&blfs-wiki;/emacs"/></para>
112
113 </sect2>
114
115 <sect2 role="installation">
116 <title>Installation of Emacs</title>
117
118 <para>
119 Install <application>Emacs</application> by running the following
120 commands:
121 </para>
122
123<screen><userinput>./configure --prefix=/usr --localstatedir=/var &amp;&amp;
124make</userinput></screen>
125<!-- make bootstrap only necessary for development versions obtained with git
126-->
127
128 <para>
129 This package does not come with a test suite. If make succeeds, you can
130 test the result by running <command>src/emacs -Q</command>, which is the
131 program that will be installed, with its auxiliary files. This should
132 start and display the application opening screen.
133 </para>
134
135 <para>
136 Now, as the <systemitem class="username">root</systemitem> user:
137 </para>
138
139<screen role="root" revision="systemd"><userinput>make install &amp;&amp;
140chown -v -R root:root /usr/share/emacs/&emacs-version;</userinput></screen>
141
142<screen role="root" revision="sysv"><userinput>make install &amp;&amp;
143chown -v -R root:root /usr/share/emacs/&emacs-version; &amp;&amp;
144rm -vf /usr/lib/systemd/user/emacs.service</userinput></screen>
145
146 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
147 href="../../xincludes/gtk-update-icon-cache.xml"/>
148
149 </sect2>
150
151 <sect2 role="commands">
152 <title>Command Explanations</title>
153
154 <para>
155 <parameter>--localstatedir=/var</parameter>: Create game score files
156 in <filename class='directory'>/var/games/emacs</filename> instead
157 of <filename class='directory'>/usr/var/games/emacs</filename>.
158 </para>
159
160 <para>
161 <option>IMAGEMAGICK_CFLAGS=-I/usr/include/ImageMagick-6
162 IMAGEMAGICK_LIBS="-lMagickCore-6.Q16HDRI -lMagick++-6.Q16HDRI
163 -lMagickWand-6.Q16HDRI" </option>:
164 use these when you invoke configure if you have installed <xref
165 linkend="imagemagick6"/> and wish to link to them (the normal unversioned
166 pkgconfig files collide with <xref linkend="imagemagick"/> which this
167 package cannot use).
168 </para>
169
170 <para>
171 <option>--with-gif=no</option>: Use this if you have not installed
172 <xref linkend="giflib"/> or
173 <ulink url="http://directory.fsf.org/wiki/Libungif">libungif</ulink>.
174 </para>
175
176 <para>
177 <option>--with-tiff=no</option>: Use this if you have not installed
178 <xref linkend="libtiff"/>.
179 </para>
180
181 <para>
182 <option>--with-gnutls=no</option>: Use this if you have not installed
183 <xref linkend="gnutls"/>.
184 </para>
185
186 </sect2>
187
188 <sect2 role="content">
189 <title>Contents</title>
190
191 <segmentedlist>
192 <segtitle>Installed Programs</segtitle>
193 <segtitle>Installed Libraries</segtitle>
194 <segtitle>Installed Directories</segtitle>
195
196 <seglistitem>
197 <seg>ctags,
198 ebrowse,
199 emacs (symlink),
200 emacs-&emacs-version;,
201 emacsclient,
202 etags, and
203 grep-changelog</seg>
204 <seg>None</seg>
205 <seg>/usr/libexec/emacs,
206 /usr/share/emacs, and
207 /var/games/emacs</seg>
208 </seglistitem>
209 </segmentedlist>
210
211 <variablelist>
212 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
213 <?dbfo list-presentation="list"?>
214 <?dbhtml list-presentation="table"?>
215
216 <varlistentry id="ctags">
217 <term><command>ctags</command></term>
218 <listitem>
219 <para>
220 creates cross-reference tagfile database files
221 for source code.
222 </para>
223 <indexterm zone="emacs ctags">
224 <primary sortas="b-ctags">ctags</primary>
225 </indexterm>
226 </listitem>
227 </varlistentry>
228
229 <varlistentry id="ebrowse">
230 <term><command>ebrowse</command></term>
231 <listitem>
232 <para>
233 permits browsing of C++ class hierarchies from
234 within <command>emacs</command>.
235 </para>
236 <indexterm zone="emacs ebrowse">
237 <primary sortas="b-ebrowse">ebrowse</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="emacs-prog">
243 <term><command>emacs</command></term>
244 <listitem>
245 <para>
246 is an editor.
247 </para>
248 <indexterm zone="emacs emacs-prog">
249 <primary sortas="b-emacs">emacs</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="emacsclient">
255 <term><command>emacsclient</command></term>
256 <listitem>
257 <para>
258 attaches an <command>emacs</command> session to an already
259 running <command>emacsserver</command> instance.
260 </para>
261 <indexterm zone="emacs emacsclient">
262 <primary sortas="b-emacsclient">emacsclient</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="etags">
268 <term><command>etags</command></term>
269 <listitem>
270 <para>
271 is another program to generate source code
272 cross-reference tagfiles.
273 </para>
274 <indexterm zone="emacs etags">
275 <primary sortas="b-etags">etags</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="grep-changelog">
281 <term><command>grep-changelog</command></term>
282 <listitem>
283 <para>
284 prints entries in Change Logs matching
285 various criteria.
286 </para>
287 <indexterm zone="emacs grep-changelog">
288 <primary sortas="b-grep-changelog">grep-changelog</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292<!--
293 <varlistentry id="rcs-checkin">
294 <term><command>rcs-checkin</command></term>
295 <listitem>
296 <para>
297 is a shell script used to check files into RCS.
298 </para>
299 <indexterm zone="emacs rcs-checkin">
300 <primary sortas="b-rcs-checkin">rcs-checkin</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>-->
304
305 </variablelist>
306
307 </sect2>
308
309</sect1>
Note: See TracBrowser for help on using the repository browser.