Changeset 9387


Ignore:
Timestamp:
May 7, 2008, 8:13:41 PM (11 years ago)
Author:
mikel
Message:

numerous minor mechanical and style edits in build, install, and about

Location:
trunk/source/doc/src
Files:
3 edited

Legend:

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

    r9071 r9387  
    7676      <listitem><para>Full Unicode support.</para></listitem>
    7777      <listitem><para>Full SLIME integration.</para></listitem>
    78       <listitem><para>An IDE on the Mac OS X, fully integrated with
     78      <listitem><para>An IDE on Mac OS X, fully integrated with
    7979      the Macintosh window system and User Interface
    8080      standards.</para></listitem>
     
    8585      X.</para></listitem>
    8686      <listitem><para>Many extensions including: files mapped to
    87       Common Lisp vectors for fast file I/O; thread local hash tables
     87      Common Lisp vectors for fast file I/O; thread-local hash tables
    8888      and streams to eliminate locking overhead; cons hashing support;
    8989      and much more</para></listitem>
  • trunk/source/doc/src/build.xml

    r9199 r9387  
    3535    build, and is not described here.</para>
    3636
    37   <sect1 id="building-definitions"><title>Building Definitions</title>
     37  <!-- =========================================================== -->
     38  <sect1 id="building-definitions">
     39    <title>Building Definitions</title>
    3840    <para>The following terms are used in subsequent sections; it
    3941      may be helpful to refer to these definitions.</para>
     
    98100      <xref linkend="Platform-specific-filename-conventions"/>.</para>
    99101
     102    <!-- ******************************************************** -->
    100103    <sect2 id="filename_conventions">
    101104      <title>Platform-specific filename conventions</title>
     
    176179  </sect1>
    177180
     181  <!-- =========================================================== -->
    178182  <sect1 id="Setting-Up-to-Build">
    179183    <title>Setting Up to Build</title>
     
    187191          supports Unicode</para></listitem>
    188192          <listitem><para>Version 1.2 - supports (at least) all of the
    189               features and platforms as 1.1, but is distributed and updated
     193              features and platforms of 1.1, but is distributed and updated
    190194              differently</para></listitem>
    191195    </itemizedlist>
     
    245249  </sect1>
    246250
     251  <!-- =========================================================== -->
    247252  <sect1 id="Building-Everything">
    248253    <title>Building Everything</title>
     
    296301  </sect1>
    297302
     303  <!-- =========================================================== -->
    298304  <sect1 id="Building-the-kernel">
    299305    <title>Building the kernel</title>
     
    324330
    325331
     332    <!-- ******************************************************** -->
    326333    <sect2 id="Kernel-build-prerequisites">
    327334      <title>Kernel build prerequisites</title>
     
    350357          </para>
    351358    </sect2>
     359
     360    <!-- ******************************************************** -->
    352361    <sect2 id="kernel-build-command">
    353362          <title>Using "make" to build the lisp kernel</title>
     
    364373    </sect2>
    365374  </sect1>
     375
     376  <!-- =========================================================== -->
    366377  <sect1 id="Building-the-heap-image">
    367378    <title>Building the heap image</title>
     
    389400      <literal>ccl:save-application</literal>.)</para>
    390401
     402    <!-- ******************************************************** -->
    391403    <sect2 id="Development-cycle">
    392404          <title>Development cycle</title>
     
    435447    </sect2>
    436448
     449    <!-- ******************************************************** -->
    437450    <sect2 id="Generating-a-bootstrapping-image">
    438451      <title>Generating a bootstrapping image</title>
     
    455468        &CCL; from the shell:</para>
    456469      <programlisting>
    457 shell&gt; openmcl
     470shell&gt; ccl
    458471Welcome to &CCL; .... !
    459472?
     
    480493    </sect2>
    481494
     495    <!-- ******************************************************** -->
    482496    <sect2 id="Generating-fasl-files">
    483497      <title>Generating fasl files</title>
     
    508522    </sect2>
    509523
     524    <!-- ******************************************************** -->
    510525    <sect2 id="Building-a-full-image-from-a-bootstrapping-image">
    511526          <title>Building a full image from a bootstrapping image</title>
  • trunk/source/doc/src/install.xml

    r9115 r9387  
    1313<chapter><title>Obtaining, Installing, and Running &CCL;</title>
    1414 
     15  <!-- ============================================================ -->
    1516  <sect1><title>Releases and System Requirements</title>
    1617   
     
    4950
    5051    <para>Older versions are still available for downloading as
    51     tarballs.  Version 1.0 was a stable release released in late 2005.
     52    tarballs.  Version 1.0 was a stable version released in late 2005.
    5253    Version 1.1 was under active development until late 2007.  A final
    5354    1.1 release was never made.  It was distributed as a series of
    5455    development "snapshots" and CVS updates.  1.1 snapshots introduced
    5556    support for x86-64 platforms, internal use of Unicode, and many
    56     other features, but were a moving target. </para>
    57 
     57    other features, but were moving targets. </para>
     58
     59    <!-- ***************************************************** -->
    5860    <sect2><title>LinuxPPC</title>
    5961     
     
    6365    </sect2>
    6466
     67    <!-- ***************************************************** -->
    6568    <sect2><title>Linux X8664</title>
    6669
     
    7477      Linux have been known to have problems compiling some of the C
    7578      code in the kernel; some very old Linux distributions don't
    76       follow the current ABI standards wrt segment register usage;
    77       some early Linux kernels for x86-64 had problems mapping large
    78       regions of the address space; and so on. It's difficult to
    79       enumerate exactly what versions of what Linux distributions have
     79      follow the current ABI standards with regard to segment register
     80      usage; some early Linux kernels for x86-64 had problems mapping
     81      large regions of the address space; and so on. It's difficult to
     82      enumerate exactly what versions of which Linux distributions have
    8083      what problems.  A rule of thumb is that&mdash;because much of
    8184      the development of &CCL; for x86-64 took place in that time
     
    8487    </sect2>
    8588
     89    <!-- ***************************************************** -->
    8690    <sect2><title>FreeBSD-amd64</title> <para>&CCL; runs on FreeBSD on
    8791    x86-64 (FreeBSD releases generally call the platform "amd64").
     
    9296    </sect2>
    9397
     98    <!-- ***************************************************** -->
    9499    <sect2><title>DarwinPPC-MacOS-X</title>
    95100
     
    109114    </sect2>
    110115
     116    <!-- ***************************************************** -->
    111117    <sect2><title>Darwinx8664-MacOS-X</title> <para>&CCL; runs on
    112118    64-bit DarwinX86 (Mac OS X on Intel).</para>
     
    124130
    125131
     132  <!-- ============================================================ -->
    126133  <sect1><title>Obtaining Clozure CL</title>
    127134    <para>There two main ways to obtain Clozure CL.  For Mac OS X,
     
    142149      sections describe these options.</para>
    143150
     151    <!-- ***************************************************** -->
    144152    <sect2><title>The Mac Way</title>
    145153      <para>If you are using Mac OS X then you can install and use
     
    166174   
    167175
     176    <!-- ***************************************************** -->
    168177    <sect2><title>Getting Clozure CL with Subversion</title>
    169178      <para>It is very easy to download, install, and build Clozure CL
     
    177186
    178187
    179       <para>One subversion command will create a
     188      <para>One subversion command creates a
    180189      <literal>ccl</literal> directory with runnable binaries, and a
    181190      complete set of buildable sources.  To get the bleeding edge
     
    222231Welcome to Clozure Common Lisp Version 1.2  (DarwinX8664)!
    223232? (rebuild-ccl :full t)
     233
    224234<lots of compilation output>
     235
    225236  ? (quit)
    226237  joe:ccl>]]>
     
    234245shell> svn]]>
    235246        </programlisting>
    236         If Subversion is installed, it will say something like:
     247        If Subversion is installed, you will see something like:
    237248        <programlisting>
    238249          <![CDATA[
    239250Type 'svn help' for usage]]>
    240251        </programlisting>
    241         If Subversion is not installed, it will say something
     252        If Subversion is not installed, you will see something
    242253        like:
    243254        <programlisting>
     
    253264    </sect2>
    254265
     266    <!-- ***************************************************** -->
    255267    <sect2><title>Tarballs</title>
    256268      <para>Tarballs are available at <ulink
     
    264276  </sect1>
    265277
     278  <!-- ============================================================ -->
    266279  <sect1><title>Command Line Set Up</title>
    267280    <para>Sometimes it's convenient to use Clozure CL from a Unix
     
    269282      CL as a way to run Common Lisp utilities.</para>
    270283
     284    <!-- ***************************************************** -->
    271285    <sect2 id="The-ccl-Shell-Script"><title>The ccl Shell Script</title>
    272286      <para>&CCL; needs to be able to find the
     
    303317          <literal>~/bin</literal>.  It is better to do this than to
    304318          add <literal>ccl/scripts</literal> to your
    305           <varname>PATH</varname> since the script needs to be edited,
    306           it will show up as modified to Subversion.</para>
     319          <varname>PATH</varname>, because the script needs to be edited,
     320          and editing it in-place means that Subversion sees the script as
     321          modified..</para>
    307322        </listitem>
    308323        <listitem>
     
    379394      </programlisting>
    380395    </sect2>
     396
     397    <!-- ***************************************************** -->
    381398    <sect2 id="Invocation">
    382399          <title>Invocation</title>
     
    390407    </sect2>
    391408  </sect1>
     409
     410  <!-- ============================================================ -->
    392411  <sect1 id="Personal-Customization-with-the-Init-File">
    393412        <title>Personal Customization with the Init File</title>
    394413    <para>By default &CCL; tries to load the file
    395       <literal>"home:openmcl-init.lisp"</literal> or the compiled
     414      <literal>"home:ccl-init.lisp"</literal> or the compiled
    396415         
    397       <literal>"home:openmcl-init.fasl"</literal> upon starting up. It
    398       does this by executing <literal>(load
    399       "home:openmcl-init")</literal>.  If it's unable to load the file
     416      <literal>"home:ccl-init.fasl"</literal> upon starting up. For
     417      the sake of backward compatibility, it also tries to load the
     418      file <literal>"home:openmcl-init.lisp"</literal>, or its compiled
     419      equivalent. &CCL; does this by executing <literal>(load
     420      "home:ccl-init")</literal>.  If it's unable to load the file
    400421      (for example because the file doesn't exist), &CCL; doesn't
    401422      signal an error or warning, it just completes its startup
     
    405426      your home directory. &CCL; therefore looks for either of the
    406427      files
    407       <literal>~/openmcl-init.lisp</literal> or
    408       <literal>~/openmcl-init.fasl</literal>.</para>
     428      <literal>~/ccl-init.lisp</literal> or
     429      <literal>~/ccl-init.fasl</literal>.</para>
    409430    <para>Because the init file is loaded the same way as normal Lisp
    410431      code is, you can put anything you want in it.  For example, you
     
    415436  </sect1>
    416437
     438  <!-- ============================================================ -->
    417439  <sect1 id="Command-Line-Options">
    418440        <title>Command Line Options</title>
    419     <para>When using Clozure CL from the command line, these
     441    <para>When using Clozure CL from the command line, the following
    420442      options may be used to modify its behavior.  The exact set of
    421443      Clozure CL command-line arguments may vary per platform and
     
    435457            <para><literal>-V</literal> (or
    436458              <literal>--version</literal>).  Prints the version of
    437               Clozure CL then exits.  This is the same thing that is
    438               returned by
     459              Clozure CL then exits.  The version string is the same value
     460              that is returned by
    439461              <function>LISP-APPLICATION-VERSION</function>.</para>
    440462          </listitem>
     
    458480<![CDATA[shell> ccl -K utf-8]]>
    459481              </programlisting>
    460               will have the effect of making the standard CL streams use
     482              has the effect of making the standard CL streams use
    461483              <literal>:UTF-8</literal> as their character
    462484              encoding.</para>
     
    465487          <listitem>
    466488            <para><literal>-n</literal> (or
    467               <literal>--no-init</literal>). If this option is given,
    468               the init file is not loaded.  This is useful if &CCL; is
    469               being invoked by a shell script which should not be
    470               affected by whatever customizations a user might have in
    471               place.</para>
     489              <literal>--no-init</literal>). If this option is given, the
     490              init file is not loaded.  This is useful if &CCL; is being
     491              invoked by a shell script that should not be affected by
     492              whatever customizations a user might have in place.</para>
    472493          </listitem>
    473494
     
    529550          <listitem>
    530551            <para><literal>-b</literal> (or <literal>--batch</literal>). Execute in "batch mode". End-of-file
    531               from <varname>*STANDARD-INPUT*</varname> will cause &CCL; to exit, as will attempts to
     552              from <varname>*STANDARD-INPUT*</varname> causes &CCL; to exit, as do attempts to
    532553              enter a break loop.</para>
    533554          </listitem>
     
    555576  </sect1>
    556577
     578  <!-- ============================================================ -->
    557579  <sect1 id="Using-CCL-with-GNU-Emacs-and-SLIME">
    558580    <title>Using &CCL; with GNU Emacs and SLIME</title>
     
    583605      screencasts.</para>
    584606
     607    <!-- ***************************************************** -->
    585608    <sect2 id="Assumptions-and-Requirements">
    586609          <title>Assumptions and Requirements</title>
     
    592615              <para>You have a working installation of GNU Emacs. If you
    593616                don't have a working copy of GNU Emacs, see the web page on
    594                 obtaining Emacs.  If you prefer to use XEmacs instead of
    595                 GNU Emacs,these instructions should still work; SLIME
    596                 supports XEmacs Version21. Mac OS X includes an Emacs
    597                 installation.  If you want to look into different versions,
    598                 you can check out theEmacsWiki, which maintains a
    599                 page,EmacsForMacOS,that provides much more information
     617                <ulink url="http://www.gnu.org/software/emacs/#Obtaining">obtaining
     618                Emacs</ulink>.  If you prefer to use XEmacs instead of GNU
     619                Emacs, these instructions should still work; SLIME supports
     620                XEmacs Version21. Mac OS X includes an Emacs installation.
     621                If you want to look into different versions, you can check
     622                out theEmacsWiki, which maintains a
     623                page, EmacsForMacOS, that provides much more information
    600624                about using Emacs on the Mac.</para>
    601625          <para>A popular version of Emacs among Mac users is
    602             Aquamacs. This application is a version of GNU Emacs
    603             with a number of customizations meant to make it behave
    604             more like a standard Macintosh application, with
    605             windows, a menubar, etc.  Aquamacs includes SLIME; if
    606             you like Aquamacs then you can use SLIME right away,
    607             without getting and installing it separately. You just
    608             need to tell SLIME where to find your installation of
    609             &CCL;.</para>
     626            <ulink url="http://aquamacs.org/">Aquamacs</ulink>. This
     627            application is a version of GNU Emacs with a number of
     628            customizations meant to make it behave more like a
     629            standard Macintosh application, with windows, a menubar,
     630            etc.  Aquamacs includes SLIME; if you like Aquamacs then
     631            you can use SLIME right away, without getting and
     632            installing it separately. You just need to tell SLIME
     633            where to find your installation of &CCL;.</para>
    610634            </listitem>
    611635        <listitem>
     
    631655    </sect2>
    632656
     657    <!-- ***************************************************** -->
    633658    <sect2 id="Getting_Slime"><title>Getting SLIME</title>       
    634659
     
    650675    </sect2>
    651676
     677    <!-- ***************************************************** -->
    652678    <sect2><title>Installing SLIME</title>
    653679
     
    663689    </sect2>
    664690
     691    <!-- ***************************************************** -->
    665692    <sect2 id="Telling-Emacs-About-SLIME">
    666693          <title>Telling Emacs About SLIME</title>
     
    676703    </sect2>
    677704
     705    <!-- ***************************************************** -->
    678706    <sect2 id="Running-CCL-with-SLIME">
    679707          <title>Running &CCL; with SLIME</title>
     
    691719    </sect2>
    692720
     721    <!-- ***************************************************** -->
    693722    <sect2 id="What-if-a-New-Version-of-CCL-Breaks-SLIME-">
    694723          <title>What if a New Version of &CCL; Breaks SLIME?</title>
     
    717746    </sect2>
    718747
     748    <!-- ***************************************************** -->
    719749    <sect2 id="Known-Bugs">
    720750          <title>Known Bugs</title>
     
    738768  </sect1>
    739769
     770  <!-- ============================================================ -->
    740771  <sect1 id="Example-Programs">
    741772    <title>Example Programs</title>
     
    750781    <para>Unless the original author or contributor claims other
    751782      rights, you're free to incorporate any of this example code or
    752       derivative thereof in any of you're own works without
     783      derivative thereof in any of your own works without
    753784      restriction. In doing so, you agree that the code was provided
    754785      "as is", and that no other party is legally or otherwise
Note: See TracChangeset for help on using the changeset viewer.