Changeset 13690


Ignore:
Timestamp:
May 8, 2010, 8:21:58 PM (10 years ago)
Author:
rme
Message:

Instead of providing detailed instructions about installing Slime
in the manual, refer readers to the ccl wiki.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/source/doc/src/install.xml

    r13554 r13690  
    102102    <para> There are three popular ways to use &CCL;: as a
    103103      stand-alone double-clickable application (Mac OS X only), as a
    104       command-line application, or with EMACS and SLIME. The following
     104      command-line application, or with Emacs and SLIME. The following
    105105      sections describe these options.</para>
    106106
     
    563563  <sect1 id="Using-CCL-with-GNU-Emacs-and-SLIME">
    564564    <title>Using &CCL; with GNU Emacs and SLIME</title>
    565     <para>A very common way to use &CCL; is to run it within the
    566       GNU Emacs editor, using a Lisp interface called SLIME ("Superior
    567       Lisp Interaction Mode for Emacs"). SLIME is an Emacs package
    568       designed to provide good support within Emacs for any of several
    569       Common Lisp implementations; one of the supported
    570       implementations is &CCL;. This page describes how you can
    571       download SLIME and set it up to work with your &CCL;
    572       installation.</para>
    573     <para>Why use SLIME? With SLIME, you can do the following things from within
    574       an Emacs editing session:</para>
    575     <itemizedlist>
    576       <listitem><para>run and control Lisp</para></listitem>
    577       <listitem><para>evaluate, compile, and load files or expressions</para></listitem>
    578       <listitem><para>macroexpand expressions</para></listitem>
    579       <listitem><para>fetch documentation and source code for Lisp symbols</para></listitem>
    580       <listitem><para>autocomplete symbols and package names</para></listitem>
    581       <listitem><para>cross-reference function calls</para></listitem>
    582       <listitem><para>examine stack traces and debug errors</para></listitem>
    583      
    584     </itemizedlist>
    585     <para>For complete information about SLIME, see the
    586       SLIME <ulink url="http://common-lisp.net/project/slime/">home
    587       page</ulink>. The SLIME home page provides up-to-date downloads,
    588       plus documentation, tutorials, and instructional
    589       screencasts.</para>
    590 
    591     <!-- ***************************************************** -->
    592     <sect2 id="Assumptions-and-Requirements">
    593           <title>Assumptions and Requirements</title>
    594       <para>In order to simplify these instructions, we'll make
    595         several assumptions about your system. Specifically, we
    596         assume:</para>
    597       <itemizedlist>
    598         <listitem>
    599               <para>You have a working installation of GNU Emacs. If you
    600                 don't have a working copy of GNU Emacs, see the web page on
    601                 <ulink url="http://www.gnu.org/software/emacs/#Obtaining">obtaining
    602                 Emacs</ulink>.  If you prefer to use XEmacs instead of GNU
    603                 Emacs, these instructions should still work; SLIME supports
    604                 XEmacs Version21. Mac OS X includes an Emacs installation.
    605                 If you want to look into different versions, you can check
    606                 out theEmacsWiki, which maintains a
    607                 page, EmacsForMacOS, that provides much more information
    608                 about using Emacs on the Mac.</para>
    609           <para>A popular version of Emacs among Mac users is
    610             <ulink url="http://aquamacs.org/">Aquamacs</ulink>. This
    611             application is a version of GNU Emacs with a number of
    612             customizations meant to make it behave more like a
    613             standard Macintosh application, with windows, a menubar,
    614             etc.  Aquamacs includes SLIME; if you like Aquamacs then
    615             you can use SLIME right away, without getting and
    616             installing it separately. You just need to tell SLIME
    617             where to find your installation of &CCL;.</para>
    618             </listitem>
    619         <listitem>
    620           <para>You have a working copy of &CCL;, installed in
    621             <literal>"~/ccl"</literal>If you prefer to install
    622             &CCL; in some directory other
    623             than<literal>"~/ccl"</literal> then these
    624             instructions still work, but you must remember to use your
    625             path to your ccl directory instead of the one that we give
    626             here.</para>
    627         </listitem>
    628         <listitem>
    629           <para>You install emacs add-ons in the folder
    630             <literal>"~/emacs/site/"</literal>If this directory
    631             doesn't exist on your system, you can just create it.If
    632             you prefer to install Emacs add-ons in some place other
    633             than<literal>"~/emacs/site/"</literal> then you must
    634             remember to use your path to Emacs add-ons in place of
    635             ours.</para>
    636         </listitem>
    637        
    638       </itemizedlist>
    639     </sect2>
    640 
    641     <!-- ***************************************************** -->
    642     <sect2 id="Getting_Slime"><title>Getting SLIME</title>       
    643 
    644       <para>You can get SLIME from the SLIME Home Page. Stable
    645         releases and CVS snapshots are available as archive files, or
    646         you can follow the instructions on the SLIME Home Page to
    647         check out the latest version from their CVS repository.</para>
    648 
    649       <para>It's worth noting that stable SLIME releases happen very
    650         seldom, but the SLIME developers often make changes and
    651         improvements that are available through CVS updates. If you
    652         asked the SLIM developers, they would most likely recommend
    653         that you get SLIME from their CVS repository and update it
    654         frequently.</para>
    655 
    656       <para>Whether you get it from CVS, or download and unpack one
    657         of the available archives, you should end up with a folder
    658         named "slime" that contains the SLIME distribution.</para>
    659     </sect2>
    660 
    661     <!-- ***************************************************** -->
    662     <sect2 id="installing-slime"><title>Installing SLIME</title>
    663 
    664       <para>Once you have the "slime" folder described in the previous
    665         section, installation is a simple matter of copying the folder
    666         to the proper place. You can drag it into the "~/emacs/site/"
    667         folder, or you can use a terminal command to copy it
    668         there. For example, assuming your working directory contains
    669         the unpacked "slime" folder:</para> <para><literal>$ cp -R
    670         slime ~/emacs/site/</literal></para> <para>That's all it
    671         takes.</para>
    672 
    673     </sect2>
    674 
    675     <!-- ***************************************************** -->
    676     <sect2 id="Telling-Emacs-About-SLIME">
    677           <title>Telling Emacs About SLIME</title>
    678       <para> Once SLIME and &CCL; are installed, you just need to
    679         add a line to your "~/.emacs" file that tells SLIME where to
    680         find the script that runs &CCL;:</para>
    681       <para><literal>(setq inferior-lisp-program "~/ccl/scripts/ccl64")</literal></para>
    682       <para>or</para>
    683       <para><literal>(setq inferior-lisp-program "~/ccl/scripts/ccl")</literal></para>
    684       <warning>
    685         <para>Aquamacs users should add this line to the file "~/Library/Preferences/Aquamacs Emacs/Preferences.el".</para>
    686       </warning>
    687     </sect2>
    688 
    689     <!-- ***************************************************** -->
    690     <sect2 id="Running-CCL-with-SLIME">
    691           <title>Running &CCL; with SLIME</title>
    692       <para>Once the preparations in the previous section are
    693         complete, exit Emacs and restart it, to ensure that it reads
    694         the changes you made in your ".emacs" file (alternatively, you
    695         could tell Emacs to reload the ".emacs" file). If all went
    696         well, you should now be ready to run &CCL; using
    697         SLIME.</para>
    698       <para>To run &CCL;, execute the command "M-x slime". SLIME
    699         should start an &CCL; session in a new buffer.  (If you are
    700         unfamiliar with the Emacs notation "M-x command", see the GNU
    701         Emacs FAQ; specifically, take a look at questions 1, 2, and
    702         128.)</para>
    703     </sect2>
    704 
    705     <!-- ***************************************************** -->
    706     <sect2 id="What-if-a-New-Version-of-CCL-Breaks-SLIME-">
    707           <title>What if a New Version of &CCL; Breaks SLIME?</title>
    708           <para>Sometimes you'll get a new version of &CCL;, set up
    709             Emacs to use it with SLIME, and SLIME will fail. Most likely
    710             what has happened is that the new version of &CCL; has a
    711             change in the output files produced by the compiler (&CCL;
    712             developers will say "the fasl version has changed." fasl
    713             stands for "fast load" aka compiled files). This
    714             problem is easy to fix: just delete the existing SLIME fasl
    715             files. The next time you launch Emacs and start SLIME, it will
    716             automatically recompile the Lisp files, and that should fix
    717             the problem.</para>
    718       <para>SLIME's load process stores its fasl files in a hidden
    719         folder inside your home folder. The path is</para>
    720       <para><literal>~/.slime/fasl</literal></para>
    721       <para>You can use a shell command to remove the fasl files, or
    722         remove them using your system's file browser.</para>
    723       <para><emphasis role="bold">Note for Macintosh Users:</emphasis>
    724             The leading "." character in the ".slime" folder's name
    725             prevents the Finder from showing this folder to you. If you
    726             use the "Go To Folder" menu item in the Finder's "Go" menu,
    727             you can type in "~/.slime" and the Finder will show it to
    728             you. You can then drag the "fasl" folder to the trash.
    729           </para>
    730     </sect2>
    731 
    732     <!-- ***************************************************** -->
    733     <sect2 id="Known-Bugs">
    734           <title>Known Bugs</title>
    735           <para>SLIME has not been updated to account for recent changes
    736             made in &CCL; to support x86-64 processors. You may run into
    737             bugs running on those platforms.</para>
    738       <para>The SLIME backtrace sometimes shows incorrect information.</para>
    739       <para><literal>return-from-frame</literal> and
    740         <literal>apply-in-frame</literal> do not work reliably.  (If
    741         they work at all, it's pure luck.)</para>
    742       <para>Some versions of Emacs on the Macintosh may have trouble
    743         finding the shell script that runs &CCL; unless you specify
    744         a full path to it. See the above section "Telling Emacs About
    745         SLIME" to learn how to specify the path to the shell
    746         script.</para>
    747       <para>For more help with &CCL; on Mac OS X, consult the &CCL;
    748         mailing lists. You can find information about the mailing
    749         lists on the
    750         &CCL; <ulink url="http://trac.clozure.com/openmcl">wiki</ulink>.</para>
    751     </sect2>
     565    <para>
     566      SLIME (see  <ulink url="http://common-lisp.net/project/slime/">
     567      the SLIME web page</ulink>) is an Emacs mode for interacting with
     568      Common Lisp systems.  &CCL; is well-supported by SLIME.
     569    </para>
     570
     571    <para>
     572      See the <ulink url="http://trac.clozure.com/ccl/wiki/InstallingSlime">
     573      InstallingSlime</ulink> topic on the &CCL; wiki for some tips
     574      on how to get SLIME running with &CCL;.
     575    </para>
    752576  </sect1>
    753577
Note: See TracChangeset for help on using the changeset viewer.