source: postlfs/editors/emacs.xml@ e7d893b

elogind
Last change on this file since e7d893b was e7d893b, checked in by DJ Lucas <dj@…>, 5 years ago

Merge to HEAD 21602.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/BOOK-elogind@21603 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • 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 "02ba7003f14957529bcd05cfc3ebb754">
11 <!ENTITY emacs-size "42 MB">
12 <!ENTITY emacs-buildsize "434 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 <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>The <application>Emacs</application> package contains an extensible,
34 customizable, self-documenting real-time display editor.</para>
35
36 &lfs84_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>Download (HTTP): <ulink url="&emacs-download-http;"/></para>
42 </listitem>
43 <listitem>
44 <para>Download (FTP): <ulink url="&emacs-download-ftp;"/></para>
45 </listitem>
46 <listitem>
47 <para>Download MD5 sum: &emacs-md5sum;</para>
48 </listitem>
49 <listitem>
50 <para>Download size: &emacs-size;</para>
51 </listitem>
52 <listitem>
53 <para>Estimated disk space required: &emacs-buildsize;</para>
54 </listitem>
55 <listitem>
56 <para>Estimated build time: &emacs-time;</para>
57 </listitem>
58 </itemizedlist>
59
60 <bridgehead renderas="sect3">Emacs Dependencies</bridgehead>
61
62 <bridgehead renderas="sect4">Recommended</bridgehead>
63 <para role="recommended">
64 <xref linkend="giflib"/>,
65 <xref linkend="gnutls"/>, and
66 <xref linkend="libtiff"/>
67 </para>
68
69 <bridgehead renderas="sect4">Optional</bridgehead>
70 <para role="optional">
71 <xref linkend="x-window-system"/>,
72 <xref linkend="alsa-lib"/>,
73 <xref linkend="dbus"/>,
74 <xref linkend="GConf"/>,
75 <xref linkend="gobject-introspection"/>,
76 <xref linkend="gsettings-desktop-schemas"/>,
77 <xref linkend="gpm"/>,
78 <xref linkend="gtk2"/> or <xref linkend="gtk3"/>,
79 <xref linkend="imagemagick6"/> (see command explanations),
80 <xref linkend="libjpeg"/>,
81 <xref linkend="libpng"/>,
82 <xref linkend="librsvg"/>,
83 <xref linkend="libxml2"/>,
84 <xref linkend="mitkrb"/>,
85 <xref linkend="valgrind"/>,
86 <ulink url="&gnu-http;/intlfonts/">intlfonts</ulink>,
87 <ulink url="http://directory.fsf.org/wiki/Libungif">libungif</ulink>,
88 <ulink url="http://www.nongnu.org/m17n/">libotf</ulink> and
89 <ulink url="http://www.nongnu.org/m17n/">m17n-lib</ulink> - to correctly
90 display such complex scripts as Indic and Khmer, and also for scripts
91 that require Arabic shaping support (Arabic and Farsi), and
92 <ulink url="&xorg-download-http;/lib/">libXaw3d</ulink>
93 </para>
94
95 <para condition="html" role="usernotes">User Notes:
96 <ulink url="&blfs-wiki;/emacs"/></para>
97
98 </sect2>
99
100 <sect2 role="installation">
101 <title>Installation of Emacs</title>
102
103 <para>Install <application>Emacs</application> by running the following
104 commands:</para>
105
106<screen><userinput>./configure --prefix=/usr --localstatedir=/var &amp;&amp;
107make</userinput></screen>
108<!-- make bootstrap only necessary for development versions obtained with git
109-->
110
111 <para>
112 This package does not come with a test suite. If make succeeds, you can
113 test the result by running <command>src/emacs -Q</command>, which is the
114 program that will be installed, with its auxiliary files. This should
115 start and display the application opening screen.
116 </para>
117
118 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
119
120<screen role="root"><userinput>make install &amp;&amp;
121chown -v -R root:root /usr/share/emacs/&emacs-version;</userinput></screen>
122
123 <para>
124
125 This package installs icon files into the <filename
126 class="directory">/usr/share/icons/hicolor</filename> hierarchy and
127 desktop files into the <filename
128 class="directory">/usr/share/applications</filename> hierarchy. You
129 can improve system performance and memory usage by updating
130 <filename>/usr/share/icons/hicolor/icon-theme.cache</filename> and
131 <filename>/usr/share/applications/mimeinfo.cache</filename>. To
132 perform the update you must have <xref linkend="gtk2"/> or <xref
133 linkend="gtk3"/> installed (for the icon cache) and <xref
134 linkend="desktop-file-utils"/> (for the desktop cache) and issue
135 the following commands as the <systemitem
136 class="username">root</systemitem> user:
137
138 </para>
139
140<screen role="root"><userinput>gtk-update-icon-cache -t -f --include-image-data /usr/share/icons/hicolor &amp;&amp;
141update-desktop-database</userinput></screen>
142
143 </sect2>
144
145 <sect2 role="commands">
146 <title>Command Explanations</title>
147
148 <para><parameter>--localstatedir=/var</parameter>: Create game score files
149 in <filename class='directory'>/var/games/emacs</filename> instead
150 of <filename class='directory'>/usr/var/games/emacs</filename>.</para>
151
152 <para><option>IMAGEMAGICK_CFLAGS=-I/usr/include/ImageMagick-6
153 IMAGEMAGICK_LIBS="-lMagickCore-6.Q16HDRI -lMagick++-6.Q16HDRI
154 -lMagickWand-6.Q16HDRI" </option>:
155 use these when you invoke configure if you have installed <xref
156 linkend="imagemagick6"/> and wish to link to them (the normal unversioned
157 pkgconfig files collide with <xref linkend="imagemagick"/> which this
158 package cannot use).</para>
159
160 <para><option>--with-gif=no</option>: Use this if you have not installed
161 <xref linkend="giflib"/> or
162 <ulink url="http://directory.fsf.org/wiki/Libungif">libungif</ulink>.</para>
163
164 <para><option>--with-tiff=no</option>: Use this if you have not installed
165 <xref linkend="libtiff"/>.</para>
166
167 <para><option>--with-gnutls=no</option>: Use this if you have not installed
168 <xref linkend="gnutls"/>.</para>
169
170 </sect2>
171
172 <sect2 role="content">
173 <title>Contents</title>
174
175 <segmentedlist>
176 <segtitle>Installed Programs</segtitle>
177 <segtitle>Installed Libraries</segtitle>
178 <segtitle>Installed Directories</segtitle>
179
180 <seglistitem>
181 <seg>ctags,
182 ebrowse,
183 emacs (symlink),
184 emacs-&emacs-version;,
185 emacsclient,
186 etags, and
187 grep-changelog</seg>
188 <seg>None</seg>
189 <seg>/usr/libexec/emacs,
190 /usr/share/emacs, and
191 /var/games/emacs</seg>
192 </seglistitem>
193 </segmentedlist>
194
195 <variablelist>
196 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
197 <?dbfo list-presentation="list"?>
198 <?dbhtml list-presentation="table"?>
199
200 <varlistentry id="ctags">
201 <term><command>ctags</command></term>
202 <listitem>
203 <para>creates cross-reference tagfile database files
204 for source code.</para>
205 <indexterm zone="emacs ctags">
206 <primary sortas="b-ctags">ctags</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="ebrowse">
212 <term><command>ebrowse</command></term>
213 <listitem>
214 <para>permits browsing of C++ class hierarchies from
215 within <command>emacs</command>.</para>
216 <indexterm zone="emacs ebrowse">
217 <primary sortas="b-ebrowse">ebrowse</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="emacs-prog">
223 <term><command>emacs</command></term>
224 <listitem>
225 <para>is an editor.</para>
226 <indexterm zone="emacs emacs-prog">
227 <primary sortas="b-emacs">emacs</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="emacsclient">
233 <term><command>emacsclient</command></term>
234 <listitem>
235 <para>attaches an <command>emacs</command> session to an already
236 running <command>emacsserver</command> instance.</para>
237 <indexterm zone="emacs emacsclient">
238 <primary sortas="b-emacsclient">emacsclient</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="etags">
244 <term><command>etags</command></term>
245 <listitem>
246 <para>is another program to generate source code
247 cross-reference tagfiles.</para>
248 <indexterm zone="emacs etags">
249 <primary sortas="b-etags">etags</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="grep-changelog">
255 <term><command>grep-changelog</command></term>
256 <listitem>
257 <para>prints entries in Change Logs matching
258 various criteria.</para>
259 <indexterm zone="emacs grep-changelog">
260 <primary sortas="b-grep-changelog">grep-changelog</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264<!--
265 <varlistentry id="rcs-checkin">
266 <term><command>rcs-checkin</command></term>
267 <listitem>
268 <para>is a shell script used to check files into RCS.</para>
269 <indexterm zone="emacs rcs-checkin">
270 <primary sortas="b-rcs-checkin">rcs-checkin</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>-->
274
275 </variablelist>
276
277 </sect2>
278
279</sect1>
Note: See TracBrowser for help on using the repository browser.