[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[b5951ec] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY emacs-download-http "&gnu-http;/emacs/emacs-&emacs-version;.tar.xz">
|
---|
[8558044] | 8 | <!ENTITY emacs-download-ftp " ">
|
---|
[12858a3] | 9 | <!ENTITY emacs-md5sum "b9cc42f7d8066152535cf267418b8ced">
|
---|
[f590513] | 10 | <!ENTITY emacs-size "50 MB">
|
---|
[12858a3] | 11 | <!ENTITY emacs-buildsize "525 MB">
|
---|
[e7ef550] | 12 | <!ENTITY emacs-time "0.7 SBU (Using parallelism=4)">
|
---|
[b5951ec] | 13 | ]>
|
---|
| 14 |
|
---|
[a7a755a] | 15 | <sect1 id="emacs" xreflabel="Emacs-&emacs-version;">
|
---|
[ed59474e] | 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 |
|
---|
[f716ef4] | 28 | <para>
|
---|
| 29 | The <application>Emacs</application> package contains an extensible,
|
---|
| 30 | customizable, self-documenting real-time display editor.
|
---|
| 31 | </para>
|
---|
[ed59474e] | 32 |
|
---|
[4c0efc3c] | 33 | &lfs122_checked;
|
---|
[e237c169] | 34 |
|
---|
[ed59474e] | 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
[f716ef4] | 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&emacs-download-http;"/>
|
---|
| 40 | </para>
|
---|
[ed59474e] | 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
[f716ef4] | 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&emacs-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
[ed59474e] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[f716ef4] | 48 | <para>
|
---|
| 49 | Download MD5 sum: &emacs-md5sum;
|
---|
| 50 | </para>
|
---|
[ed59474e] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[f716ef4] | 53 | <para>
|
---|
| 54 | Download size: &emacs-size;
|
---|
| 55 | </para>
|
---|
[ed59474e] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[f716ef4] | 58 | <para>
|
---|
| 59 | Estimated disk space required: &emacs-buildsize;
|
---|
| 60 | </para>
|
---|
[ed59474e] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[f716ef4] | 63 | <para>
|
---|
| 64 | Estimated build time: &emacs-time;
|
---|
| 65 | </para>
|
---|
[ed59474e] | 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
[c0a34eb] | 69 | <bridgehead renderas="sect3">Emacs Dependencies</bridgehead>
|
---|
[ed59474e] | 70 |
|
---|
[043a3842] | 71 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 72 | <para role="recommended">
|
---|
[8404399] | 73 | <xref linkend="harfbuzz"/>,
|
---|
[96fcf51] | 74 | <xref linkend="giflib"/>,
|
---|
[8404399] | 75 | <xref linkend="gnutls"/>,
|
---|
| 76 | <xref linkend="jansson"/>, and
|
---|
[96fcf51] | 77 | <xref linkend="libtiff"/>
|
---|
[043a3842] | 78 | </para>
|
---|
| 79 |
|
---|
[ed59474e] | 80 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[54666831] | 81 | <para role="optional">
|
---|
| 82 | <xref linkend="x-window-system"/>,
|
---|
| 83 | <xref linkend="alsa-lib"/>,
|
---|
[8404399] | 84 | <xref linkend="cairo"/>,
|
---|
[54666831] | 85 | <xref linkend="dbus"/>,
|
---|
[c0bc0a9] | 86 | &gobject-introspection;,
|
---|
[6608c8f] | 87 | <xref linkend="gsettings-desktop-schemas"/>,
|
---|
[54666831] | 88 | <xref linkend="gpm"/>,
|
---|
[990dbf0] | 89 | <xref linkend="gtk3"/>,
|
---|
[918c149] | 90 | <xref linkend="imagemagick"/>,
|
---|
[8404399] | 91 | <xref linkend="lcms2"/>,
|
---|
[54666831] | 92 | <xref linkend="libjpeg"/>,
|
---|
| 93 | <xref linkend="libpng"/>,
|
---|
| 94 | <xref linkend="librsvg"/>,
|
---|
[f590513] | 95 | <xref linkend="libseccomp"/>,
|
---|
| 96 | <xref linkend="libwebp"/>,
|
---|
[b9f3ff5c] | 97 | <xref linkend="libxml2"/>,
|
---|
[6608c8f] | 98 | <xref linkend="mitkrb"/>,
|
---|
[f590513] | 99 | <xref linkend="sqlite"/>,
|
---|
[b9f3ff5c] | 100 | <xref linkend="valgrind"/>,
|
---|
[8dfc5c3] | 101 | <ulink url="&gnu-http;/intlfonts/">intlfonts</ulink>,
|
---|
[cd29bc9] | 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
|
---|
[6608c8f] | 105 | display such complex scripts as Indic and Khmer, and also for scripts
|
---|
[8404399] | 106 | that require Arabic shaping support (Arabic and Farsi),
|
---|
| 107 | <ulink url="https://mailutils.org/">mailutils</ulink>, and
|
---|
[e622c0b] | 108 | <ulink url="&xorg-download-http;/lib/">libXaw3d</ulink>
|
---|
[54666831] | 109 | </para>
|
---|
[ed59474e] | 110 |
|
---|
| 111 | </sect2>
|
---|
| 112 |
|
---|
| 113 | <sect2 role="installation">
|
---|
| 114 | <title>Installation of Emacs</title>
|
---|
| 115 |
|
---|
[f716ef4] | 116 | <para>
|
---|
| 117 | Install <application>Emacs</application> by running the following
|
---|
| 118 | commands:
|
---|
| 119 | </para>
|
---|
[ed59474e] | 120 |
|
---|
[8404399] | 121 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[ca8bcae9] | 122 | make</userinput></screen>
|
---|
[ed59474e] | 123 |
|
---|
[6608c8f] | 124 | <para>
|
---|
| 125 | This package does not come with a test suite. If make succeeds, you can
|
---|
[5d5234b] | 126 | test the result by running <command>src/emacs -Q</command>, which is the
|
---|
[6608c8f] | 127 | program that will be installed, with its auxiliary files. This should
|
---|
| 128 | start and display the application opening screen.
|
---|
| 129 | </para>
|
---|
[c1ac942] | 130 |
|
---|
[f716ef4] | 131 | <para>
|
---|
| 132 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 133 | </para>
|
---|
[ed59474e] | 134 |
|
---|
[2ab28c8] | 135 | <screen role="root" revision="systemd"><userinput>make install &&
|
---|
[755379cb] | 136 | chown -v -R root:root /usr/share/emacs/&emacs-version;</userinput></screen>
|
---|
[ed59474e] | 137 |
|
---|
[2ab28c8] | 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 |
|
---|
[00d040d] | 142 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 143 | href="../../xincludes/gtk-update-icon-cache.xml"/>
|
---|
[cdabd810] | 144 |
|
---|
[ed59474e] | 145 | </sect2>
|
---|
| 146 |
|
---|
[32ccdf34] | 147 | <sect2 role="commands">
|
---|
| 148 | <title>Command Explanations</title>
|
---|
| 149 |
|
---|
[8558044] | 150 | <!-- With 27.2, it writes scores to ~/.emacs.d/games
|
---|
[f716ef4] | 151 | <para>
|
---|
[8404399] | 152 | <parameter>- -localstatedir=/var</parameter>: Create game score files
|
---|
[f716ef4] | 153 | in <filename class='directory'>/var/games/emacs</filename> instead
|
---|
| 154 | of <filename class='directory'>/usr/var/games/emacs</filename>.
|
---|
| 155 | </para>
|
---|
[8404399] | 156 | -->
|
---|
[755379cb] | 157 |
|
---|
[f716ef4] | 158 | <para>
|
---|
[918c149] | 159 | <option>--with-imagemagick</option>: Use this if you have installed
|
---|
| 160 | <xref linkend="imagemagick"/> and wish to link against it.
|
---|
[f716ef4] | 161 | </para>
|
---|
[d113301] | 162 |
|
---|
[f716ef4] | 163 | <para>
|
---|
| 164 | <option>--with-gif=no</option>: Use this if you have not installed
|
---|
[8558044] | 165 | <xref linkend="giflib"/> or
|
---|
[cd29bc9] | 166 | <ulink url="https://directory.fsf.org/wiki/Libungif">libungif</ulink>.
|
---|
[f716ef4] | 167 | </para>
|
---|
[043a3842] | 168 |
|
---|
[f716ef4] | 169 | <para>
|
---|
| 170 | <option>--with-tiff=no</option>: Use this if you have not installed
|
---|
| 171 | <xref linkend="libtiff"/>.
|
---|
| 172 | </para>
|
---|
[96fcf51] | 173 |
|
---|
[f716ef4] | 174 | <para>
|
---|
| 175 | <option>--with-gnutls=no</option>: Use this if you have not installed
|
---|
| 176 | <xref linkend="gnutls"/>.
|
---|
| 177 | </para>
|
---|
[96fcf51] | 178 |
|
---|
[8404399] | 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 |
|
---|
[32ccdf34] | 189 | </sect2>
|
---|
| 190 |
|
---|
[ed59474e] | 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>
|
---|
[f3429309] | 200 | <seg>ctags,
|
---|
| 201 | ebrowse,
|
---|
| 202 | emacs (symlink),
|
---|
[473f4358] | 203 | emacs-&emacs-version;,
|
---|
[8404399] | 204 | emacsclient, and
|
---|
| 205 | etags</seg>
|
---|
[ed59474e] | 206 | <seg>None</seg>
|
---|
[8404399] | 207 | <seg>/usr/libexec/emacs and
|
---|
| 208 | /usr/share/emacs</seg>
|
---|
[ed59474e] | 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">
|
---|
[550ca80] | 218 | <term><command>ctags</command></term>
|
---|
[ed59474e] | 219 | <listitem>
|
---|
[f716ef4] | 220 | <para>
|
---|
| 221 | creates cross-reference tagfile database files
|
---|
[4c24eb0a] | 222 | for source code
|
---|
[f716ef4] | 223 | </para>
|
---|
[ed59474e] | 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>
|
---|
[f716ef4] | 233 | <para>
|
---|
| 234 | permits browsing of C++ class hierarchies from
|
---|
[4c24eb0a] | 235 | within <command>emacs</command>
|
---|
[f716ef4] | 236 | </para>
|
---|
[ed59474e] | 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>
|
---|
[f716ef4] | 246 | <para>
|
---|
[4c24eb0a] | 247 | is an editor
|
---|
[f716ef4] | 248 | </para>
|
---|
[ed59474e] | 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>
|
---|
[f716ef4] | 258 | <para>
|
---|
| 259 | attaches an <command>emacs</command> session to an already
|
---|
[4c24eb0a] | 260 | running <command>emacsserver</command> instance
|
---|
[f716ef4] | 261 | </para>
|
---|
[ed59474e] | 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>
|
---|
[f716ef4] | 271 | <para>
|
---|
| 272 | is another program to generate source code
|
---|
[4c24eb0a] | 273 | cross-reference tagfiles
|
---|
[f716ef4] | 274 | </para>
|
---|
[ed59474e] | 275 | <indexterm zone="emacs etags">
|
---|
| 276 | <primary sortas="b-etags">etags</primary>
|
---|
| 277 | </indexterm>
|
---|
| 278 | </listitem>
|
---|
| 279 | </varlistentry>
|
---|
| 280 |
|
---|
| 281 | </variablelist>
|
---|
[b5951ec] | 282 |
|
---|
[ed59474e] | 283 | </sect2>
|
---|
[f45b1953] | 284 |
|
---|
| 285 | </sect1>
|
---|