[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 |
|
---|
[6608c8f] | 7 | <!ENTITY emacs-download-http "https://ftp.gnu.org/pub/gnu/emacs/emacs-&emacs-version;.tar.xz">
|
---|
[8607f108] | 8 | <!ENTITY emacs-download-ftp "ftp://ftp.gnu.org/pub/gnu/emacs/emacs-&emacs-version;.tar.xz">
|
---|
[6608c8f] | 9 | <!ENTITY emacs-md5sum "50560ee00bac9bb9cf0e822764cd0832">
|
---|
[66cb475] | 10 | <!ENTITY emacs-size "38 MB">
|
---|
[6973d03] | 11 | <!ENTITY emacs-buildsize "482 MB">
|
---|
| 12 | <!ENTITY emacs-time "4.6 SBU">
|
---|
[b5951ec] | 13 | ]>
|
---|
| 14 |
|
---|
[a7a755a] | 15 | <sect1 id="emacs" xreflabel="Emacs-&emacs-version;">
|
---|
[ed59474e] | 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 |
|
---|
[13679edb] | 32 | <para>The <application>Emacs</application> package contains an extensible,
|
---|
[ed59474e] | 33 | customizable, self-documenting real-time display editor.</para>
|
---|
| 34 |
|
---|
[90cb5d6] | 35 | &lfs78_checked;
|
---|
[e237c169] | 36 |
|
---|
[ed59474e] | 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>Download (HTTP): <ulink url="&emacs-download-http;"/></para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>Download (FTP): <ulink url="&emacs-download-ftp;"/></para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download MD5 sum: &emacs-md5sum;</para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download size: &emacs-size;</para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Estimated disk space required: &emacs-buildsize;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Estimated build time: &emacs-time;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | </itemizedlist>
|
---|
| 58 |
|
---|
[c0a34eb] | 59 | <bridgehead renderas="sect3">Emacs Dependencies</bridgehead>
|
---|
[ed59474e] | 60 |
|
---|
| 61 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[54666831] | 62 | <para role="optional">
|
---|
| 63 | <xref linkend="x-window-system"/>,
|
---|
| 64 | <xref linkend="alsa-lib"/>,
|
---|
| 65 | <xref linkend="dbus"/>,
|
---|
[6608c8f] | 66 | <xref linkend="GConf"/>,
|
---|
| 67 | <xref linkend="giflib"/>,
|
---|
[b9abcb5] | 68 | <xref linkend="gnutls"/> (currently broken),
|
---|
[54666831] | 69 | <xref linkend="gobject-introspection"/>,
|
---|
[6608c8f] | 70 | <xref linkend="gsettings-desktop-schemas"/>,
|
---|
[54666831] | 71 | <xref linkend="gpm"/>,
|
---|
| 72 | <xref linkend="gtk2"/> or <xref linkend="gtk3"/>,
|
---|
| 73 | <xref linkend="imagemagick"/>,
|
---|
| 74 | <xref linkend="libjpeg"/>,
|
---|
| 75 | <xref linkend="libpng"/>,
|
---|
| 76 | <xref linkend="librsvg"/>,
|
---|
[6608c8f] | 77 | <xref linkend="libtiff"/>,
|
---|
[b9f3ff5c] | 78 | <xref linkend="libxml2"/>,
|
---|
[6608c8f] | 79 | <xref linkend="mitkrb"/>,
|
---|
[b9f3ff5c] | 80 | <xref linkend="valgrind"/>,
|
---|
[6608c8f] | 81 | <ulink url="https://ftp.gnu.org/gnu/intlfonts/">intlfonts</ulink>,
|
---|
| 82 | <ulink url="http://directory.fsf.org/wiki/Libungif">libungif</ulink>,
|
---|
| 83 | <ulink url="http://www.nongnu.org/m17n/">libotf</ulink> and
|
---|
| 84 | <ulink url="http://www.nongnu.org/m17n/">m17n-lib</ulink> - to correctly
|
---|
| 85 | display such complex scripts as Indic and Khmer, and also for scripts
|
---|
| 86 | that require Arabic shaping support (Arabic and Farsi), and
|
---|
| 87 | <ulink url="http://ftp.x.org/pub/individual/lib/">libXaw3d</ulink>
|
---|
[54666831] | 88 | </para>
|
---|
[ed59474e] | 89 |
|
---|
[3597eb6] | 90 | <para condition="html" role="usernotes">User Notes:
|
---|
| 91 | <ulink url="&blfs-wiki;/emacs"/></para>
|
---|
| 92 |
|
---|
[ed59474e] | 93 | </sect2>
|
---|
| 94 |
|
---|
| 95 | <sect2 role="installation">
|
---|
| 96 | <title>Installation of Emacs</title>
|
---|
| 97 |
|
---|
[3aa07d1] | 98 | <para>Install <application>Emacs</application> by running the following
|
---|
[ed59474e] | 99 | commands:</para>
|
---|
| 100 |
|
---|
[6608c8f] | 101 | <screen><userinput>./configure --prefix=/usr \
|
---|
[b9abcb5] | 102 | --without-gnutls \
|
---|
[6608c8f] | 103 | --localstatedir=/var &&
|
---|
[ca8bcae9] | 104 | make</userinput></screen>
|
---|
| 105 | <!-- make bootstrap only necessary for development versions obtained with git
|
---|
| 106 | -->
|
---|
[ed59474e] | 107 |
|
---|
[6608c8f] | 108 | <para>
|
---|
| 109 | This package does not come with a test suite. If make succeeds, you can
|
---|
[5d5234b] | 110 | test the result by running <command>src/emacs -Q</command>, which is the
|
---|
[6608c8f] | 111 | program that will be installed, with its auxiliary files. This should
|
---|
| 112 | start and display the application opening screen.
|
---|
| 113 | </para>
|
---|
[c1ac942] | 114 |
|
---|
[ed59474e] | 115 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 116 |
|
---|
[755379cb] | 117 | <screen role="root"><userinput>make install &&
|
---|
| 118 | chown -v -R root:root /usr/share/emacs/&emacs-version;</userinput></screen>
|
---|
[ed59474e] | 119 |
|
---|
[6608c8f] | 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>
|
---|
[cdabd810] | 136 |
|
---|
[6608c8f] | 137 | <screen role="root"><userinput>gtk-update-icon-cache -t -f --include-image-data /usr/share/icons/hicolor &&
|
---|
| 138 | update-desktop-database</userinput></screen>
|
---|
[cdabd810] | 139 |
|
---|
[ed59474e] | 140 | </sect2>
|
---|
| 141 |
|
---|
[32ccdf34] | 142 | <sect2 role="commands">
|
---|
| 143 | <title>Command Explanations</title>
|
---|
| 144 |
|
---|
[b9abcb5] | 145 | <para><parameter>--without-gnutls</parameter>: Currently, build is broken
|
---|
| 146 | with gnutls-3.4 and later.</para>
|
---|
| 147 |
|
---|
[755379cb] | 148 | <para><option>--localstatedir=/var</option>: 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 |
|
---|
[32ccdf34] | 152 | </sect2>
|
---|
| 153 |
|
---|
[ed59474e] | 154 | <sect2 role="content">
|
---|
| 155 | <title>Contents</title>
|
---|
| 156 |
|
---|
| 157 | <segmentedlist>
|
---|
| 158 | <segtitle>Installed Programs</segtitle>
|
---|
| 159 | <segtitle>Installed Libraries</segtitle>
|
---|
| 160 | <segtitle>Installed Directories</segtitle>
|
---|
| 161 |
|
---|
| 162 | <seglistitem>
|
---|
[f3429309] | 163 | <seg>ctags,
|
---|
| 164 | ebrowse,
|
---|
| 165 | emacs (symlink),
|
---|
| 166 | emacs&emacs-version;,
|
---|
| 167 | emacsclient,
|
---|
| 168 | etags, and
|
---|
[66cb475] | 169 | grep-changelog</seg>
|
---|
[ed59474e] | 170 | <seg>None</seg>
|
---|
[34fb49a7] | 171 | <seg>/usr/libexec/emacs,
|
---|
[f3429309] | 172 | /usr/share/emacs, and
|
---|
[8607f108] | 173 | /var/games/emacs</seg>
|
---|
[ed59474e] | 174 | </seglistitem>
|
---|
| 175 | </segmentedlist>
|
---|
| 176 |
|
---|
| 177 | <variablelist>
|
---|
| 178 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 179 | <?dbfo list-presentation="list"?>
|
---|
| 180 | <?dbhtml list-presentation="table"?>
|
---|
| 181 |
|
---|
| 182 | <varlistentry id="ctags">
|
---|
[550ca80] | 183 | <term><command>ctags</command></term>
|
---|
[ed59474e] | 184 | <listitem>
|
---|
| 185 | <para>creates cross-reference tagfile database files
|
---|
| 186 | for source code.</para>
|
---|
| 187 | <indexterm zone="emacs ctags">
|
---|
| 188 | <primary sortas="b-ctags">ctags</primary>
|
---|
| 189 | </indexterm>
|
---|
| 190 | </listitem>
|
---|
| 191 | </varlistentry>
|
---|
| 192 |
|
---|
| 193 | <varlistentry id="ebrowse">
|
---|
| 194 | <term><command>ebrowse</command></term>
|
---|
| 195 | <listitem>
|
---|
| 196 | <para>permits browsing of C++ class hierarchies from
|
---|
| 197 | within <command>emacs</command>.</para>
|
---|
| 198 | <indexterm zone="emacs ebrowse">
|
---|
| 199 | <primary sortas="b-ebrowse">ebrowse</primary>
|
---|
| 200 | </indexterm>
|
---|
| 201 | </listitem>
|
---|
| 202 | </varlistentry>
|
---|
| 203 |
|
---|
| 204 | <varlistentry id="emacs-prog">
|
---|
| 205 | <term><command>emacs</command></term>
|
---|
| 206 | <listitem>
|
---|
| 207 | <para>is an editor.</para>
|
---|
| 208 | <indexterm zone="emacs emacs-prog">
|
---|
| 209 | <primary sortas="b-emacs">emacs</primary>
|
---|
| 210 | </indexterm>
|
---|
| 211 | </listitem>
|
---|
| 212 | </varlistentry>
|
---|
| 213 |
|
---|
| 214 | <varlistentry id="emacsclient">
|
---|
| 215 | <term><command>emacsclient</command></term>
|
---|
| 216 | <listitem>
|
---|
[13679edb] | 217 | <para>attaches an <command>emacs</command> session to an already
|
---|
[ed59474e] | 218 | running <command>emacsserver</command> instance.</para>
|
---|
| 219 | <indexterm zone="emacs emacsclient">
|
---|
| 220 | <primary sortas="b-emacsclient">emacsclient</primary>
|
---|
| 221 | </indexterm>
|
---|
| 222 | </listitem>
|
---|
| 223 | </varlistentry>
|
---|
| 224 |
|
---|
| 225 | <varlistentry id="etags">
|
---|
| 226 | <term><command>etags</command></term>
|
---|
| 227 | <listitem>
|
---|
| 228 | <para>is another program to generate source code
|
---|
| 229 | cross-reference tagfiles.</para>
|
---|
| 230 | <indexterm zone="emacs etags">
|
---|
| 231 | <primary sortas="b-etags">etags</primary>
|
---|
| 232 | </indexterm>
|
---|
| 233 | </listitem>
|
---|
| 234 | </varlistentry>
|
---|
| 235 |
|
---|
| 236 | <varlistentry id="grep-changelog">
|
---|
| 237 | <term><command>grep-changelog</command></term>
|
---|
| 238 | <listitem>
|
---|
| 239 | <para>prints entries in Change Logs matching
|
---|
| 240 | various criteria.</para>
|
---|
| 241 | <indexterm zone="emacs grep-changelog">
|
---|
| 242 | <primary sortas="b-grep-changelog">grep-changelog</primary>
|
---|
| 243 | </indexterm>
|
---|
| 244 | </listitem>
|
---|
| 245 | </varlistentry>
|
---|
[2bf87d8] | 246 | <!--
|
---|
[ed59474e] | 247 | <varlistentry id="rcs-checkin">
|
---|
| 248 | <term><command>rcs-checkin</command></term>
|
---|
| 249 | <listitem>
|
---|
| 250 | <para>is a shell script used to check files into RCS.</para>
|
---|
| 251 | <indexterm zone="emacs rcs-checkin">
|
---|
| 252 | <primary sortas="b-rcs-checkin">rcs-checkin</primary>
|
---|
| 253 | </indexterm>
|
---|
| 254 | </listitem>
|
---|
[2bf87d8] | 255 | </varlistentry>-->
|
---|
[a7a755a] | 256 |
|
---|
[ed59474e] | 257 | </variablelist>
|
---|
[b5951ec] | 258 |
|
---|
[ed59474e] | 259 | </sect2>
|
---|
[f45b1953] | 260 |
|
---|
| 261 | </sect1>
|
---|