source: postlfs/editors/emacs.xml@ eede1a3

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 eede1a3 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 years ago

more SVN prop clean up

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