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