1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 " ">
|
---|
9 | <!ENTITY emacs-md5sum "b9cc42f7d8066152535cf267418b8ced">
|
---|
10 | <!ENTITY emacs-size "50 MB">
|
---|
11 | <!ENTITY emacs-buildsize "525 MB">
|
---|
12 | <!ENTITY emacs-time "0.7 SBU (Using parallelism=4)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="emacs" xreflabel="Emacs-&emacs-version;">
|
---|
16 | <?dbhtml filename="emacs.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>Emacs-&emacs-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="emacs">
|
---|
22 | <primary sortas="a-Emacs">Emacs</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to Emacs</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>Emacs</application> package contains an extensible,
|
---|
30 | customizable, self-documenting real-time display editor.
|
---|
31 | </para>
|
---|
32 |
|
---|
33 | &lfs122_checked;
|
---|
34 |
|
---|
35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem>
|
---|
38 | <para>
|
---|
39 | Download (HTTP): <ulink url="&emacs-download-http;"/>
|
---|
40 | </para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (FTP): <ulink url="&emacs-download-ftp;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download MD5 sum: &emacs-md5sum;
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download size: &emacs-size;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Estimated disk space required: &emacs-buildsize;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated build time: &emacs-time;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | </itemizedlist>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect3">Emacs Dependencies</bridgehead>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
72 | <para role="recommended">
|
---|
73 | <xref linkend="harfbuzz"/>,
|
---|
74 | <xref linkend="giflib"/>,
|
---|
75 | <xref linkend="gnutls"/>,
|
---|
76 | <xref linkend="jansson"/>, and
|
---|
77 | <xref linkend="libtiff"/>
|
---|
78 | </para>
|
---|
79 |
|
---|
80 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
81 | <para role="optional">
|
---|
82 | <xref linkend="x-window-system"/>,
|
---|
83 | <xref linkend="alsa-lib"/>,
|
---|
84 | <xref linkend="cairo"/>,
|
---|
85 | <xref linkend="dbus"/>,
|
---|
86 | &gobject-introspection;,
|
---|
87 | <xref linkend="gsettings-desktop-schemas"/>,
|
---|
88 | <xref linkend="gpm"/>,
|
---|
89 | <xref linkend="gtk3"/>,
|
---|
90 | <xref linkend="imagemagick"/>,
|
---|
91 | <xref linkend="lcms2"/>,
|
---|
92 | <xref linkend="libjpeg"/>,
|
---|
93 | <xref linkend="libpng"/>,
|
---|
94 | <xref linkend="librsvg"/>,
|
---|
95 | <xref linkend="libseccomp"/>,
|
---|
96 | <xref linkend="libwebp"/>,
|
---|
97 | <xref linkend="libxml2"/>,
|
---|
98 | <xref linkend="mitkrb"/>,
|
---|
99 | <xref linkend="sqlite"/>,
|
---|
100 | <xref linkend="valgrind"/>,
|
---|
101 | <ulink url="&gnu-http;/intlfonts/">intlfonts</ulink>,
|
---|
102 | <ulink url="https://directory.fsf.org/wiki/Libungif">libungif</ulink>,
|
---|
103 | <ulink url="https://www.nongnu.org/m17n/">libotf</ulink>, and
|
---|
104 | <ulink url="https://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),
|
---|
107 | <ulink url="https://mailutils.org/">mailutils</ulink>, and
|
---|
108 | <ulink url="&xorg-download-http;/lib/">libXaw3d</ulink>
|
---|
109 | </para>
|
---|
110 |
|
---|
111 | </sect2>
|
---|
112 |
|
---|
113 | <sect2 role="installation">
|
---|
114 | <title>Installation of Emacs</title>
|
---|
115 |
|
---|
116 | <para>
|
---|
117 | Install <application>Emacs</application> by running the following
|
---|
118 | commands:
|
---|
119 | </para>
|
---|
120 |
|
---|
121 | <screen><userinput>./configure --prefix=/usr &&
|
---|
122 | make</userinput></screen>
|
---|
123 |
|
---|
124 | <para>
|
---|
125 | This package does not come with a test suite. If make succeeds, you can
|
---|
126 | test the result by running <command>src/emacs -Q</command>, which is the
|
---|
127 | program that will be installed, with its auxiliary files. This should
|
---|
128 | start and display the application opening screen.
|
---|
129 | </para>
|
---|
130 |
|
---|
131 | <para>
|
---|
132 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
133 | </para>
|
---|
134 |
|
---|
135 | <screen role="root" revision="systemd"><userinput>make install &&
|
---|
136 | chown -v -R root:root /usr/share/emacs/&emacs-version;</userinput></screen>
|
---|
137 |
|
---|
138 | <screen role="root" revision="sysv"><userinput>make install &&
|
---|
139 | chown -v -R root:root /usr/share/emacs/&emacs-version; &&
|
---|
140 | rm -vf /usr/lib/systemd/user/emacs.service</userinput></screen>
|
---|
141 |
|
---|
142 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
143 | href="../../xincludes/gtk-update-icon-cache.xml"/>
|
---|
144 |
|
---|
145 | </sect2>
|
---|
146 |
|
---|
147 | <sect2 role="commands">
|
---|
148 | <title>Command Explanations</title>
|
---|
149 |
|
---|
150 | <!-- With 27.2, it writes scores to ~/.emacs.d/games
|
---|
151 | <para>
|
---|
152 | <parameter>- -localstatedir=/var</parameter>: Create game score files
|
---|
153 | in <filename class='directory'>/var/games/emacs</filename> instead
|
---|
154 | of <filename class='directory'>/usr/var/games/emacs</filename>.
|
---|
155 | </para>
|
---|
156 | -->
|
---|
157 |
|
---|
158 | <para>
|
---|
159 | <option>--with-imagemagick</option>: Use this if you have installed
|
---|
160 | <xref linkend="imagemagick"/> and wish to link against it.
|
---|
161 | </para>
|
---|
162 |
|
---|
163 | <para>
|
---|
164 | <option>--with-gif=no</option>: Use this if you have not installed
|
---|
165 | <xref linkend="giflib"/> or
|
---|
166 | <ulink url="https://directory.fsf.org/wiki/Libungif">libungif</ulink>.
|
---|
167 | </para>
|
---|
168 |
|
---|
169 | <para>
|
---|
170 | <option>--with-tiff=no</option>: Use this if you have not installed
|
---|
171 | <xref linkend="libtiff"/>.
|
---|
172 | </para>
|
---|
173 |
|
---|
174 | <para>
|
---|
175 | <option>--with-gnutls=no</option>: Use this if you have not installed
|
---|
176 | <xref linkend="gnutls"/>.
|
---|
177 | </para>
|
---|
178 |
|
---|
179 | <para>
|
---|
180 | <option>--without-harfbuzz</option>: Use this if you have not installed
|
---|
181 | <xref linkend="harfbuzz"/>.
|
---|
182 | </para>
|
---|
183 |
|
---|
184 | <para>
|
---|
185 | <option>--with-json=no</option>: Use this if you have not installed
|
---|
186 | <xref linkend="jansson"/>.
|
---|
187 | </para>
|
---|
188 |
|
---|
189 | </sect2>
|
---|
190 |
|
---|
191 | <sect2 role="content">
|
---|
192 | <title>Contents</title>
|
---|
193 |
|
---|
194 | <segmentedlist>
|
---|
195 | <segtitle>Installed Programs</segtitle>
|
---|
196 | <segtitle>Installed Libraries</segtitle>
|
---|
197 | <segtitle>Installed Directories</segtitle>
|
---|
198 |
|
---|
199 | <seglistitem>
|
---|
200 | <seg>ctags,
|
---|
201 | ebrowse,
|
---|
202 | emacs (symlink),
|
---|
203 | emacs-&emacs-version;,
|
---|
204 | emacsclient, and
|
---|
205 | etags</seg>
|
---|
206 | <seg>None</seg>
|
---|
207 | <seg>/usr/libexec/emacs and
|
---|
208 | /usr/share/emacs</seg>
|
---|
209 | </seglistitem>
|
---|
210 | </segmentedlist>
|
---|
211 |
|
---|
212 | <variablelist>
|
---|
213 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
214 | <?dbfo list-presentation="list"?>
|
---|
215 | <?dbhtml list-presentation="table"?>
|
---|
216 |
|
---|
217 | <varlistentry id="ctags">
|
---|
218 | <term><command>ctags</command></term>
|
---|
219 | <listitem>
|
---|
220 | <para>
|
---|
221 | creates cross-reference tagfile database files
|
---|
222 | for source code
|
---|
223 | </para>
|
---|
224 | <indexterm zone="emacs ctags">
|
---|
225 | <primary sortas="b-ctags">ctags</primary>
|
---|
226 | </indexterm>
|
---|
227 | </listitem>
|
---|
228 | </varlistentry>
|
---|
229 |
|
---|
230 | <varlistentry id="ebrowse">
|
---|
231 | <term><command>ebrowse</command></term>
|
---|
232 | <listitem>
|
---|
233 | <para>
|
---|
234 | permits browsing of C++ class hierarchies from
|
---|
235 | within <command>emacs</command>
|
---|
236 | </para>
|
---|
237 | <indexterm zone="emacs ebrowse">
|
---|
238 | <primary sortas="b-ebrowse">ebrowse</primary>
|
---|
239 | </indexterm>
|
---|
240 | </listitem>
|
---|
241 | </varlistentry>
|
---|
242 |
|
---|
243 | <varlistentry id="emacs-prog">
|
---|
244 | <term><command>emacs</command></term>
|
---|
245 | <listitem>
|
---|
246 | <para>
|
---|
247 | is an editor
|
---|
248 | </para>
|
---|
249 | <indexterm zone="emacs emacs-prog">
|
---|
250 | <primary sortas="b-emacs">emacs</primary>
|
---|
251 | </indexterm>
|
---|
252 | </listitem>
|
---|
253 | </varlistentry>
|
---|
254 |
|
---|
255 | <varlistentry id="emacsclient">
|
---|
256 | <term><command>emacsclient</command></term>
|
---|
257 | <listitem>
|
---|
258 | <para>
|
---|
259 | attaches an <command>emacs</command> session to an already
|
---|
260 | running <command>emacsserver</command> instance
|
---|
261 | </para>
|
---|
262 | <indexterm zone="emacs emacsclient">
|
---|
263 | <primary sortas="b-emacsclient">emacsclient</primary>
|
---|
264 | </indexterm>
|
---|
265 | </listitem>
|
---|
266 | </varlistentry>
|
---|
267 |
|
---|
268 | <varlistentry id="etags">
|
---|
269 | <term><command>etags</command></term>
|
---|
270 | <listitem>
|
---|
271 | <para>
|
---|
272 | is another program to generate source code
|
---|
273 | cross-reference tagfiles
|
---|
274 | </para>
|
---|
275 | <indexterm zone="emacs etags">
|
---|
276 | <primary sortas="b-etags">etags</primary>
|
---|
277 | </indexterm>
|
---|
278 | </listitem>
|
---|
279 | </varlistentry>
|
---|
280 |
|
---|
281 | </variablelist>
|
---|
282 |
|
---|
283 | </sect2>
|
---|
284 |
|
---|
285 | </sect1>
|
---|