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 "https://ftp.gnu.org/pub/gnu/emacs/emacs-&emacs-version;.tar.xz">
|
---|
8 | <!ENTITY emacs-download-ftp "ftp://ftp.gnu.org/pub/gnu/emacs/emacs-&emacs-version;.tar.xz">
|
---|
9 | <!ENTITY emacs-md5sum "50560ee00bac9bb9cf0e822764cd0832">
|
---|
10 | <!ENTITY emacs-size "38 MB">
|
---|
11 | <!ENTITY emacs-buildsize "474 MB">
|
---|
12 | <!ENTITY emacs-time "1.2 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="emacs" xreflabel="Emacs-&emacs-version;">
|
---|
16 | <?dbhtml filename="emacs.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
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>The <application>Emacs</application> package contains an extensible,
|
---|
33 | customizable, self-documenting real-time display editor.</para>
|
---|
34 |
|
---|
35 | &lfs79_checked;
|
---|
36 | &gcc6_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">Optional</bridgehead>
|
---|
63 | <para role="optional">
|
---|
64 | <xref linkend="x-window-system"/>,
|
---|
65 | <xref linkend="alsa-lib"/>,
|
---|
66 | <xref linkend="dbus"/>,
|
---|
67 | <xref linkend="GConf"/>,
|
---|
68 | <xref linkend="giflib"/>,
|
---|
69 | <xref linkend="gnutls"/>,
|
---|
70 | <xref linkend="gobject-introspection"/>,
|
---|
71 | <xref linkend="gsettings-desktop-schemas"/>,
|
---|
72 | <xref linkend="gpm"/>,
|
---|
73 | <xref linkend="gtk2"/> or <xref linkend="gtk3"/>,
|
---|
74 | <xref linkend="imagemagick"/>,
|
---|
75 | <xref linkend="libjpeg"/>,
|
---|
76 | <xref linkend="libpng"/>,
|
---|
77 | <xref linkend="librsvg"/>,
|
---|
78 | <xref linkend="libtiff"/>,
|
---|
79 | <xref linkend="libxml2"/>,
|
---|
80 | <xref linkend="mitkrb"/>,
|
---|
81 | <xref linkend="valgrind"/>,
|
---|
82 | <ulink url="https://ftp.gnu.org/gnu/intlfonts/">intlfonts</ulink>,
|
---|
83 | <ulink url="http://directory.fsf.org/wiki/Libungif">libungif</ulink>,
|
---|
84 | <ulink url="http://www.nongnu.org/m17n/">libotf</ulink> and
|
---|
85 | <ulink url="http://www.nongnu.org/m17n/">m17n-lib</ulink> - to correctly
|
---|
86 | display such complex scripts as Indic and Khmer, and also for scripts
|
---|
87 | that require Arabic shaping support (Arabic and Farsi), and
|
---|
88 | <ulink url="http://ftp.x.org/pub/individual/lib/">libXaw3d</ulink>
|
---|
89 | </para>
|
---|
90 |
|
---|
91 | <para condition="html" role="usernotes">User Notes:
|
---|
92 | <ulink url="&blfs-wiki;/emacs"/></para>
|
---|
93 |
|
---|
94 | </sect2>
|
---|
95 |
|
---|
96 | <sect2 role="installation">
|
---|
97 | <title>Installation of Emacs</title>
|
---|
98 |
|
---|
99 | <para>Install <application>Emacs</application> by running the following
|
---|
100 | commands:</para>
|
---|
101 |
|
---|
102 | <screen><userinput>./configure --prefix=/usr --localstatedir=/var &&
|
---|
103 |
|
---|
104 | make</userinput></screen>
|
---|
105 | <!-- make bootstrap only necessary for development versions obtained with git
|
---|
106 | -->
|
---|
107 |
|
---|
108 | <para>
|
---|
109 | This package does not come with a test suite. If make succeeds, you can
|
---|
110 | test the result by running <command>src/emacs -Q</command>, which is the
|
---|
111 | program that will be installed, with its auxiliary files. This should
|
---|
112 | start and display the application opening screen.
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
116 |
|
---|
117 | <screen role="root"><userinput>make install &&
|
---|
118 | chown -v -R root:root /usr/share/emacs/&emacs-version;</userinput></screen>
|
---|
119 |
|
---|
120 | <para>
|
---|
121 |
|
---|
122 | This package installs icon files into the <filename
|
---|
123 | class="directory">/usr/share/icons/hicolor</filename> hierarchy and
|
---|
124 | desktop files into the <filename
|
---|
125 | class="directory">/usr/share/applications</filename> hierarchy. You
|
---|
126 | can improve system performance and memory usage by updating
|
---|
127 | <filename>/usr/share/icons/hicolor/icon-theme.cache</filename> and
|
---|
128 | <filename>/usr/share/applications/mimeinfo.cache</filename>. To
|
---|
129 | perform the update you must have <xref linkend="gtk2"/> or <xref
|
---|
130 | linkend="gtk3"/> installed (for the icon cache) and <xref
|
---|
131 | linkend="desktop-file-utils"/> (for the desktop cache) and issue
|
---|
132 | the following commands as the <systemitem
|
---|
133 | class="username">root</systemitem> user:
|
---|
134 |
|
---|
135 | </para>
|
---|
136 |
|
---|
137 | <screen role="root"><userinput>gtk-update-icon-cache -t -f --include-image-data /usr/share/icons/hicolor &&
|
---|
138 | update-desktop-database</userinput></screen>
|
---|
139 |
|
---|
140 | </sect2>
|
---|
141 |
|
---|
142 | <sect2 role="commands">
|
---|
143 | <title>Command Explanations</title>
|
---|
144 |
|
---|
145 | <para><parameter>--localstatedir=/var</parameter>: Create game score files
|
---|
146 | in <filename class='directory'>/var/games/emacs</filename> instead
|
---|
147 | of <filename class='directory'>/usr/var/games/emacs</filename>.</para>
|
---|
148 |
|
---|
149 | </sect2>
|
---|
150 |
|
---|
151 | <sect2 role="content">
|
---|
152 | <title>Contents</title>
|
---|
153 |
|
---|
154 | <segmentedlist>
|
---|
155 | <segtitle>Installed Programs</segtitle>
|
---|
156 | <segtitle>Installed Libraries</segtitle>
|
---|
157 | <segtitle>Installed Directories</segtitle>
|
---|
158 |
|
---|
159 | <seglistitem>
|
---|
160 | <seg>ctags,
|
---|
161 | ebrowse,
|
---|
162 | emacs (symlink),
|
---|
163 | emacs-&emacs-version;,
|
---|
164 | emacsclient,
|
---|
165 | etags, and
|
---|
166 | grep-changelog</seg>
|
---|
167 | <seg>None</seg>
|
---|
168 | <seg>/usr/libexec/emacs,
|
---|
169 | /usr/share/emacs, and
|
---|
170 | /var/games/emacs</seg>
|
---|
171 | </seglistitem>
|
---|
172 | </segmentedlist>
|
---|
173 |
|
---|
174 | <variablelist>
|
---|
175 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
176 | <?dbfo list-presentation="list"?>
|
---|
177 | <?dbhtml list-presentation="table"?>
|
---|
178 |
|
---|
179 | <varlistentry id="ctags">
|
---|
180 | <term><command>ctags</command></term>
|
---|
181 | <listitem>
|
---|
182 | <para>creates cross-reference tagfile database files
|
---|
183 | for source code.</para>
|
---|
184 | <indexterm zone="emacs ctags">
|
---|
185 | <primary sortas="b-ctags">ctags</primary>
|
---|
186 | </indexterm>
|
---|
187 | </listitem>
|
---|
188 | </varlistentry>
|
---|
189 |
|
---|
190 | <varlistentry id="ebrowse">
|
---|
191 | <term><command>ebrowse</command></term>
|
---|
192 | <listitem>
|
---|
193 | <para>permits browsing of C++ class hierarchies from
|
---|
194 | within <command>emacs</command>.</para>
|
---|
195 | <indexterm zone="emacs ebrowse">
|
---|
196 | <primary sortas="b-ebrowse">ebrowse</primary>
|
---|
197 | </indexterm>
|
---|
198 | </listitem>
|
---|
199 | </varlistentry>
|
---|
200 |
|
---|
201 | <varlistentry id="emacs-prog">
|
---|
202 | <term><command>emacs</command></term>
|
---|
203 | <listitem>
|
---|
204 | <para>is an editor.</para>
|
---|
205 | <indexterm zone="emacs emacs-prog">
|
---|
206 | <primary sortas="b-emacs">emacs</primary>
|
---|
207 | </indexterm>
|
---|
208 | </listitem>
|
---|
209 | </varlistentry>
|
---|
210 |
|
---|
211 | <varlistentry id="emacsclient">
|
---|
212 | <term><command>emacsclient</command></term>
|
---|
213 | <listitem>
|
---|
214 | <para>attaches an <command>emacs</command> session to an already
|
---|
215 | running <command>emacsserver</command> instance.</para>
|
---|
216 | <indexterm zone="emacs emacsclient">
|
---|
217 | <primary sortas="b-emacsclient">emacsclient</primary>
|
---|
218 | </indexterm>
|
---|
219 | </listitem>
|
---|
220 | </varlistentry>
|
---|
221 |
|
---|
222 | <varlistentry id="etags">
|
---|
223 | <term><command>etags</command></term>
|
---|
224 | <listitem>
|
---|
225 | <para>is another program to generate source code
|
---|
226 | cross-reference tagfiles.</para>
|
---|
227 | <indexterm zone="emacs etags">
|
---|
228 | <primary sortas="b-etags">etags</primary>
|
---|
229 | </indexterm>
|
---|
230 | </listitem>
|
---|
231 | </varlistentry>
|
---|
232 |
|
---|
233 | <varlistentry id="grep-changelog">
|
---|
234 | <term><command>grep-changelog</command></term>
|
---|
235 | <listitem>
|
---|
236 | <para>prints entries in Change Logs matching
|
---|
237 | various criteria.</para>
|
---|
238 | <indexterm zone="emacs grep-changelog">
|
---|
239 | <primary sortas="b-grep-changelog">grep-changelog</primary>
|
---|
240 | </indexterm>
|
---|
241 | </listitem>
|
---|
242 | </varlistentry>
|
---|
243 | <!--
|
---|
244 | <varlistentry id="rcs-checkin">
|
---|
245 | <term><command>rcs-checkin</command></term>
|
---|
246 | <listitem>
|
---|
247 | <para>is a shell script used to check files into RCS.</para>
|
---|
248 | <indexterm zone="emacs rcs-checkin">
|
---|
249 | <primary sortas="b-rcs-checkin">rcs-checkin</primary>
|
---|
250 | </indexterm>
|
---|
251 | </listitem>
|
---|
252 | </varlistentry>-->
|
---|
253 |
|
---|
254 | </variablelist>
|
---|
255 |
|
---|
256 | </sect2>
|
---|
257 |
|
---|
258 | </sect1>
|
---|