Source

xemacsweb / Install / index.content

%title%
Installation HOWTO
%author%
john s jacobs anderson
%main%
  
  <h1>XEmacs Installation HOWTO</h1>
  
  <h2>2002-08-19</h2>
  
  <p>
    These installation instructions apply to UNIX and Linux systems
    and assume that you have <strong>root</strong> access. These
    instructions result in a <strong>non</strong>-Mule XEmacs. If you
    have to alter or modify any steps in order to install on your
    configuration, or if these instructions are not clear or do not
    work for you, please email the details to

    <a
    href="mailto:webmaster@xemacs.org?body=Feedback%20from%0a%20<!--
    _GP_ $me = $outputfile; $me =~ s|$root||; $me -->">webmaster@xemacs.org</a>

    .</p>

  <p>
    If you already have a working XEmacs of version 21.1 or greater
    around, you may want to install the XEmacs build package.</p>

  <p>
    Its 

    <a href="<!-- _GP_
    relPath(qq{Documentation/packages/html/build.html})
    -->">documentation</a>

    should give you a better understanding of the XEmacs build process
    on UNIX and Windows alike, no matter whether you want to build
    from tarballs or CVS.</p>
  
  <ol type="1">
    
    <li>
      <p>
        Check out the list of optional

        <a href="<!-- _GP_ relPath(qq{Download/optLibs.html}) -->"
          >external libraries</a>

        used by XEmacs. Obtain, build, and configure any you do not
        have.</p></li>

    <li>
      <p>
        <a href="<!-- _GP_ relPath(qq{Download/index.html}) -->"
          >Download</a>

        the following files from the

        <a href="<!-- _GP_ relPath(qq{Releases/index.html#Beta}) -->"
          >beta</a>

        ,

        <a href="<!-- _GP_ relPath(qq{Releases/index.html#Gamma}) -->"
          >gamma</a>

        , or

        <a href="<!-- _GP_ relPath(qq{Releases/index.html#Stable}) -->"
          >stable</a>

        directory of a networkologically close mirror (depending on
        whether you want to build a beta version, a gamma version, or a
        stable XEmacs version).  Substitute the XEmacs version number
        for &lt;VERSION&gt; below (e.g. VERSION=21.1.14 is the latest
        stable version as of 2002-02-21).</p>

      <dl>
        <!-- one of (dd dt) -->
        <dt>Source Tarball:</dt>
        <dd>xemacs-&lt;VERSION&gt;.tar.gz</dd>
        <dt>Lisp Tarball:</dt>
        <dd>xemacs-&lt;VERSION&gt;-elc.tar.gz</dd>
        <dt>Info Documents Tarball:</dt>
        <dd>xemacs-&lt;VERSION&gt;-info.tar.gz</dd>
      </dl>

      <p>
        For XEmacs 21.4 and higher, the
        <code>xemacs-&lt;VERSION&gt;.tar.gz</code> tarball contains
        everything necessary, ie. the same files as the following tarballs
        together.
      </p>

      <dl>
        <dt>Source Tarball:</dt>
        <dd>xemacs-&lt;VERSION&gt;-src.tar.gz</dd>
        <dt>Lisp Tarball:</dt>
        <dd>xemacs-&lt;VERSION&gt;-elc.tar.gz</dd>
        <dt>Info Documents Tarball:</dt>
        <dd>xemacs-&lt;VERSION&gt;-info.tar.gz</dd>
      </dl>

    </li>

    <li>
      <p>
        Expand the above files into the directory used for compiling, e.g.</p>

      <pre xml:space="preserve">
gzip -dc xemacs-&lt;VERSION&gt;.tar.gz | tar xf -
      </pre></li>
    
    <li>
      <p>
        Change to the directory where you expanded the files, e.g.</p>

      <pre xml:space="preserve">cd /usr/src/xemacs-&lt;VERSION&gt;</pre></li>

    <li>
      <p>
        (This step does not apply to a native Windows build.)
        After reading about all the available options printed by</p>

        <pre xml:space="preserve">./configure --help</pre>

      <p>type:</p>

      <pre xml:space="preserve">./configure
      <var>[--OPTION[=VALUE]
          ...] [CONFIGURATION]</var>; make</pre></li>

    <li>
      <p>
        After configuration finishes, switch to the root account and type</p>
      
      <pre xml:space="preserve">make install</pre>

      <p>
        If you don't have root privilege, you may run XEmacs
        <cite>in-place</cite> after typing</p>

      <pre xml:space="preserve">make all</pre>

    </li>

    <li>
      <p>
        <a href="<!-- _GP_ relPath(qq{Download/index.html}) -->">Download</a>
        at least following XEmacs <a
        href="<!-- _GP_ relPath(qq{Documentation/packageGuide.html})
        -->">packages</a>:</p>

      <dir>
        <li><strong>efs-*-pkg.tar.gz</strong></li>
        <li><strong>xemacs-base-*-pkg.tar.gz</strong></li>
      </dir>

      <p>
        If you have an XEmacs built with Mule support, you should also
        get:</p>

      <dir>
        <li><strong>mule-base-*-pkg.tar.gz</strong></li>
      </dir>

      <p>
	Fetch any of the above packages as documented in our <a
	href="<!-- _GP_ relPath(qq{Releases/index.html#Packages})
	-->">Release Notice Archive</a>.</p>

      <p>
        The current version number will replace the '*'.</p></li>

    <li>
      <p>
        Expand the above files into:
        <code>/usr/local/lib/xemacs/xemacs-packages/</code>. 
        <strong>Please note</strong> that the
        <strong>mule-base-*-pkg.tar.gz</strong> should be installed
        to: 
        <code>/usr/local/lib/xemacs/mule-packages/</code>.

        If you would prefer to install these in a different location,
        set the <strong>EMACSPACKAGEPATH</strong> environment variable
        to your preferred location.  Then extract the files in that 
        location. Don't forget to export the variable, and to add it
        to the appropriate startup script!</p></li>

    <li>
      <p>
        Start XEmacs by typing</p>
      <pre xml:space="preserve">xemacs</pre>

      <p>
        If you're trying XEmacs without installing it (<code>make all</code>),
        start it with <code>./src/xemacs</code> from the top-level directory
        in the XEmacs source tree.</p></li>

    <li>
      <p>
        From the menubar, choose <strong>Options -&gt; Manage Packages
          -&gt; Add Download Site</strong>.  Or, if you are using an
          XEmacs &gt;= 21.4, you would choose: <strong>Tools -&gt;
          Packages -&gt; Add Download Site</strong>, and pick a
          networkologically
        close mirror.  As of 21.4.16 and 21.5.12 the entry has been
        renamed to <strong>Tools -&gt; Packages -&gt; Set Download
        Site</strong> to make it clearer that only one download site
        can be set at any time.</p></li>

    <li>
      <p>
        From the menubar, choose <strong>Options -&gt; Manage Packages -&gt;
          List and Install</strong>. Or, if you are using an XEmacs
          &gt;= 21.4, you would choose: <strong>Tools -&gt; Packages
          -&gt; List and Install</strong>.  This will download the
        most recent package index and list the packages available for
        install. If you get EFS, PGP, or GPG errors (``<code>Can't check
        signature...</code>''), refer to the description in the <a
        href="<!-- _GP_ relPath(qq{Documentation/packageGuide.html})
        -->">package guide</a> how to resolve them.
	Instructions and key bindings for this buffer are at
        the bottom; use the scroll bar to view them. If in doubt about a
        particular package, it is generally safe to just install
        it.</p></li>

    <li>
      <p>
        An overview of existing packages and their purpose may be found
        at
        <a
           href="<!-- _GP_ relPath(qq{Develop/packages.html}) -->"><!-- _GP_ relPath(qq{Develop/packages.html}) --></a>
        and under the XEmacs source tree in <code>etc/PACKAGES</code>.</p></li>
    
    <li>
      <p>
        Select the packages you wish to install and then choose:
        <strong>Packages -&gt; Add Required</strong>.  This will
        select any packages that are needed by the ones you have
        selected.</p></li> 
    
    <li>
      <p>
        From the menubar, choose <strong>Packages -&gt; Install/Remove
          Selected</strong></p></li>

    <li>
      <p>
        Once the package files have been downloaded and
        installed, XEmacs must be exited and restarted in order to use
        the package functions.</p></li>

  </ol>

      <p>
        As an alternative to steps 7 to 15 above, you can get a
        fully-featured XEmacs the easy way, just fetch the latest Sumo
        package tarball:</p>

      <dir>
        <li><strong>xemacs-sumo.tar.gz</strong></li>
      </dir>
        Or:
      <dir>
        <li><strong>xemacs-sumo.tar.bz2</strong></li>
      </dir>

      <p>
        For a fully-featured Mule XEmacs, fetch the latest Mule Sumo
        package tarball as well:</p>

      <dir>
        <li><strong>xemacs-mule-sumo.tar.gz</strong></li>
      </dir>
        Or:
      <dir>
        <li><strong>xemacs-mule-sumo.tar.bz2</strong></li>
      </dir>

      <p>
        The Sumo tarballs are available from the same FTP directory as
        all the other XEmacs packages.</p>

      <p>
        To install the Sumo tarballs, simply unpack them to:
        <code>/usr/local/lib/xemacs/</code></p>


  <!-- Keep this comment at the end of the file
  Local variables:
  mode: xml
  sgml-omittag:nil
  sgml-shorttag:nil
  sgml-namecase-general:nil
  sgml-general-insert-case:lower
  sgml-minimize-attributes:nil
  sgml-always-quote-attributes:t
  sgml-indent-step:2
  sgml-indent-data:t
  sgml-parent-document:("../template.html" "html" "body" "table" "tr" "td")
  sgml-exposed-tags:nil
  sgml-local-catalogs:nil
  sgml-local-ecat-files:nil
  End:
  -->
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.