source: postlfs/editors/emacs.xml@ 85a581fd

11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 85a581fd was 85a581fd, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

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