source: postlfs/editors/emacs.xml@ 14891a90

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 14891a90 was 14891a90, checked in by Xi Ruoyao <xry111@…>, 12 months ago

treewide: More "User Notes" clean up

Remove links to pages w/o real contents.
  • Property mode set to 100644
File size: 9.3 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 "cb799cdfc3092272ff6d35223fc6bfef">
11 <!ENTITY emacs-size "46 MB">
12 <!ENTITY emacs-buildsize "466 MB">
13 <!ENTITY emacs-time "0.5 SBU (Using parallelism=4)">
14]>
15
16<sect1 id="emacs" xreflabel="Emacs-&emacs-version;">
17 <?dbhtml filename="emacs.html"?>
18
19
20 <title>Emacs-&emacs-version;</title>
21
22 <indexterm zone="emacs">
23 <primary sortas="a-Emacs">Emacs</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to Emacs</title>
28
29 <para>
30 The <application>Emacs</application> package contains an extensible,
31 customizable, self-documenting real-time display editor.
32 </para>
33
34 &lfs113_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&emacs-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&emacs-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &emacs-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &emacs-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &emacs-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &emacs-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70 <bridgehead renderas="sect3">Emacs Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Recommended</bridgehead>
73 <para role="recommended">
74 <xref linkend="harfbuzz"/>,
75 <xref linkend="giflib"/>,
76 <xref linkend="gnutls"/>,
77 <xref linkend="jansson"/>, and
78 <xref linkend="libtiff"/>
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <xref linkend="x-window-system"/>,
84 <xref linkend="alsa-lib"/>,
85 <xref linkend="cairo"/>,
86 <xref linkend="dbus"/>,
87 <xref linkend="GConf"/>,
88 <xref linkend="gobject-introspection"/>,
89 <xref linkend="gsettings-desktop-schemas"/>,
90 <xref linkend="gpm"/>,
91 <xref role="nodep" linkend="gtk2"/> or <xref linkend="gtk3"/>,
92 <xref linkend="imagemagick"/>,
93 <xref linkend="lcms2"/>,
94 <xref linkend="libjpeg"/>,
95 <xref linkend="libpng"/>,
96 <xref linkend="librsvg"/>,
97 <xref linkend="libxml2"/>,
98 <xref linkend="mitkrb"/>,
99 <xref linkend="valgrind"/>,
100 <ulink url="&gnu-http;/intlfonts/">intlfonts</ulink>,
101 <ulink url="https://directory.fsf.org/wiki/Libungif">libungif</ulink>,
102 <ulink url="https://www.nongnu.org/m17n/">libotf</ulink>, and
103 <ulink url="https://www.nongnu.org/m17n/">m17n-lib</ulink> - to correctly
104 display such complex scripts as Indic and Khmer, and also for scripts
105 that require Arabic shaping support (Arabic and Farsi),
106 <ulink url="https://mailutils.org/">mailutils</ulink>, and
107 <ulink url="&xorg-download-http;/lib/">libXaw3d</ulink>
108 </para>
109
110 </sect2>
111
112 <sect2 role="installation">
113 <title>Installation of Emacs</title>
114
115 <para>
116 Install <application>Emacs</application> by running the following
117 commands:
118 </para>
119
120<screen><userinput>./configure --prefix=/usr &amp;&amp;
121make</userinput></screen>
122
123 <para>
124 This package does not come with a test suite. If make succeeds, you can
125 test the result by running <command>src/emacs -Q</command>, which is the
126 program that will be installed, with its auxiliary files. This should
127 start and display the application opening screen.
128 </para>
129
130 <para>
131 Now, as the <systemitem class="username">root</systemitem> user:
132 </para>
133
134<screen role="root" revision="systemd"><userinput>make install &amp;&amp;
135chown -v -R root:root /usr/share/emacs/&emacs-version;</userinput></screen>
136
137<screen role="root" revision="sysv"><userinput>make install &amp;&amp;
138chown -v -R root:root /usr/share/emacs/&emacs-version; &amp;&amp;
139rm -vf /usr/lib/systemd/user/emacs.service</userinput></screen>
140
141 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
142 href="../../xincludes/gtk-update-icon-cache.xml"/>
143
144 </sect2>
145
146 <sect2 role="commands">
147 <title>Command Explanations</title>
148
149 <!-- With 27.2, it writes scores to ~/.emacs.d/games
150 <para>
151 <parameter>- -localstatedir=/var</parameter>: Create game score files
152 in <filename class='directory'>/var/games/emacs</filename> instead
153 of <filename class='directory'>/usr/var/games/emacs</filename>.
154 </para>
155 -->
156
157 <para>
158 <option>--with-imagemagick</option>: Use this if you have installed
159 <xref linkend="imagemagick"/> and wish to link against it.
160 </para>
161
162 <para>
163 <option>--with-gif=no</option>: Use this if you have not installed
164 <xref linkend="giflib"/> or
165 <ulink url="https://directory.fsf.org/wiki/Libungif">libungif</ulink>.
166 </para>
167
168 <para>
169 <option>--with-tiff=no</option>: Use this if you have not installed
170 <xref linkend="libtiff"/>.
171 </para>
172
173 <para>
174 <option>--with-gnutls=no</option>: Use this if you have not installed
175 <xref linkend="gnutls"/>.
176 </para>
177
178 <para>
179 <option>--without-harfbuzz</option>: Use this if you have not installed
180 <xref linkend="harfbuzz"/>.
181 </para>
182
183 <para>
184 <option>--with-json=no</option>: Use this if you have not installed
185 <xref linkend="jansson"/>.
186 </para>
187
188 </sect2>
189
190 <sect2 role="content">
191 <title>Contents</title>
192
193 <segmentedlist>
194 <segtitle>Installed Programs</segtitle>
195 <segtitle>Installed Libraries</segtitle>
196 <segtitle>Installed Directories</segtitle>
197
198 <seglistitem>
199 <seg>ctags,
200 ebrowse,
201 emacs (symlink),
202 emacs-&emacs-version;,
203 emacsclient, and
204 etags</seg>
205 <seg>None</seg>
206 <seg>/usr/libexec/emacs and
207 /usr/share/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<!-- Not seen with 27.2
281 <varlistentry id="grep-changelog">
282 <term><command>grep-changelog</command></term>
283 <listitem>
284 <para>
285 prints entries in Change Logs matching
286 various criteria
287 </para>
288 <indexterm zone="emacs grep-changelog">
289 <primary sortas="b-grep-changelog">grep-changelog</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293-->
294<!--
295 <varlistentry id="rcs-checkin">
296 <term><command>rcs-checkin</command></term>
297 <listitem>
298 <para>
299 is a shell script used to check files into RCS.
300 </para>
301 <indexterm zone="emacs rcs-checkin">
302 <primary sortas="b-rcs-checkin">rcs-checkin</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>-->
306
307 </variablelist>
308
309 </sect2>
310
311</sect1>
Note: See TracBrowser for help on using the repository browser.