source: postlfs/editors/emacs.xml@ d5cc78a

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 d5cc78a was f3d413ca, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Tags for editors and typesetting

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