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