source: postlfs/editors/emacs.xml@ cd29bc9

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 xry111/llvm18 xry111/soup3 xry111/xf86-video-removal
Last change on this file since cd29bc9 was cd29bc9, checked in by Xi Ruoyao <xry111@…>, 20 months ago

postlfs: URL updates
  • 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 "a74841c74a3b2b8a1af2a504799a6a93">
11 <!ENTITY emacs-size "46 MB">
12 <!ENTITY emacs-buildsize "507 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 &lfs112_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="https://directory.fsf.org/wiki/Libungif">libungif</ulink>,
105 <ulink url="https://www.nongnu.org/m17n/">libotf</ulink>, and
106 <ulink url="https://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 Install <application>Emacs</application> by running the following
123 commands:
124 </para>
125
126<screen><userinput>./configure --prefix=/usr &amp;&amp;
127make</userinput></screen>
128
129 <para>
130 This package does not come with a test suite. If make succeeds, you can
131 test the result by running <command>src/emacs -Q</command>, which is the
132 program that will be installed, with its auxiliary files. This should
133 start and display the application opening screen.
134 </para>
135
136 <para>
137 Now, as the <systemitem class="username">root</systemitem> user:
138 </para>
139
140<screen role="root" revision="systemd"><userinput>make install &amp;&amp;
141chown -v -R root:root /usr/share/emacs/&emacs-version;</userinput></screen>
142
143<screen role="root" revision="sysv"><userinput>make install &amp;&amp;
144chown -v -R root:root /usr/share/emacs/&emacs-version; &amp;&amp;
145rm -vf /usr/lib/systemd/user/emacs.service</userinput></screen>
146
147 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
148 href="../../xincludes/gtk-update-icon-cache.xml"/>
149
150 </sect2>
151
152 <sect2 role="commands">
153 <title>Command Explanations</title>
154
155 <!-- With 27.2, it writes scores to ~/.emacs.d/games
156 <para>
157 <parameter>- -localstatedir=/var</parameter>: Create game score files
158 in <filename class='directory'>/var/games/emacs</filename> instead
159 of <filename class='directory'>/usr/var/games/emacs</filename>.
160 </para>
161 -->
162
163 <para>
164 <option>--with-imagemagick</option>: Use this if you have installed
165 <xref linkend="imagemagick"/> and wish to link against it.
166 </para>
167
168 <para>
169 <option>--with-gif=no</option>: Use this if you have not installed
170 <xref linkend="giflib"/> or
171 <ulink url="https://directory.fsf.org/wiki/Libungif">libungif</ulink>.
172 </para>
173
174 <para>
175 <option>--with-tiff=no</option>: Use this if you have not installed
176 <xref linkend="libtiff"/>.
177 </para>
178
179 <para>
180 <option>--with-gnutls=no</option>: Use this if you have not installed
181 <xref linkend="gnutls"/>.
182 </para>
183
184 <para>
185 <option>--without-harfbuzz</option>: Use this if you have not installed
186 <xref linkend="harfbuzz"/>.
187 </para>
188
189 <para>
190 <option>--with-json=no</option>: Use this if you have not installed
191 <xref linkend="jansson"/>.
192 </para>
193
194 </sect2>
195
196 <sect2 role="content">
197 <title>Contents</title>
198
199 <segmentedlist>
200 <segtitle>Installed Programs</segtitle>
201 <segtitle>Installed Libraries</segtitle>
202 <segtitle>Installed Directories</segtitle>
203
204 <seglistitem>
205 <seg>ctags,
206 ebrowse,
207 emacs (symlink),
208 emacs-&emacs-version;,
209 emacsclient, and
210 etags</seg>
211 <seg>None</seg>
212 <seg>/usr/libexec/emacs and
213 /usr/share/emacs</seg>
214 </seglistitem>
215 </segmentedlist>
216
217 <variablelist>
218 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
219 <?dbfo list-presentation="list"?>
220 <?dbhtml list-presentation="table"?>
221
222 <varlistentry id="ctags">
223 <term><command>ctags</command></term>
224 <listitem>
225 <para>
226 creates cross-reference tagfile database files
227 for source code
228 </para>
229 <indexterm zone="emacs ctags">
230 <primary sortas="b-ctags">ctags</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry id="ebrowse">
236 <term><command>ebrowse</command></term>
237 <listitem>
238 <para>
239 permits browsing of C++ class hierarchies from
240 within <command>emacs</command>
241 </para>
242 <indexterm zone="emacs ebrowse">
243 <primary sortas="b-ebrowse">ebrowse</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="emacs-prog">
249 <term><command>emacs</command></term>
250 <listitem>
251 <para>
252 is an editor
253 </para>
254 <indexterm zone="emacs emacs-prog">
255 <primary sortas="b-emacs">emacs</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="emacsclient">
261 <term><command>emacsclient</command></term>
262 <listitem>
263 <para>
264 attaches an <command>emacs</command> session to an already
265 running <command>emacsserver</command> instance
266 </para>
267 <indexterm zone="emacs emacsclient">
268 <primary sortas="b-emacsclient">emacsclient</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="etags">
274 <term><command>etags</command></term>
275 <listitem>
276 <para>
277 is another program to generate source code
278 cross-reference tagfiles
279 </para>
280 <indexterm zone="emacs etags">
281 <primary sortas="b-etags">etags</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286<!-- Not seen with 27.2
287 <varlistentry id="grep-changelog">
288 <term><command>grep-changelog</command></term>
289 <listitem>
290 <para>
291 prints entries in Change Logs matching
292 various criteria
293 </para>
294 <indexterm zone="emacs grep-changelog">
295 <primary sortas="b-grep-changelog">grep-changelog</primary>
296 </indexterm>
297 </listitem>
298 </varlistentry>
299-->
300<!--
301 <varlistentry id="rcs-checkin">
302 <term><command>rcs-checkin</command></term>
303 <listitem>
304 <para>
305 is a shell script used to check files into RCS.
306 </para>
307 <indexterm zone="emacs rcs-checkin">
308 <primary sortas="b-rcs-checkin">rcs-checkin</primary>
309 </indexterm>
310 </listitem>
311 </varlistentry>-->
312
313 </variablelist>
314
315 </sect2>
316
317</sect1>
Note: See TracBrowser for help on using the repository browser.