Changeset 13455


Ignore:
Timestamp:
08/11/11 09:45:52 (10 years ago)
Author:
Mark Evenson
Message:

Document running ABCL in the manual.

Location:
trunk/abcl/doc/manual
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/abcl/doc/manual/abcl.sty

    r13438 r13455  
    2929 {}
    3030
     31\lstnewenvironment{listing-shell}
     32 {\lstset{language=sh}}
     33 {}
     34
    3135\usepackage{verbatim}
    3236
  • trunk/abcl/doc/manual/abcl.tex

    r13438 r13455  
    2020This manual corresponds to abcl-0.27.0, as yet unreleased.
    2121
     22
     23\chapter{Running}
     24
     25ABCL is packaged as a single jar file (usually named either
     26``abcl.jar'' or something like``abcl-0.27.1.jar'' if you are using a
     27versioned package) that can be executed under the
     28control of a suitable JVM as follows
     29
     30\begin{listing-shell}
     31  cmd\$ java -jar abcl.jar
     32\end{listing-shell}
     33
     34For this command to work, the ``java'' exectuable needs to be in your
     35path.
     36
     37To make it easier to faciliate the use of ABCL in tool chains (such as
     38SLIME) the invocation is wrapped in a Bourne shell script under UNIX
     39or a DOS command script under Windows so that ABCL may be executed
     40simplly as:
     41
     42\begin{listing-shell}
     43  cmd\$ abcl
     44\end{listing-shell}
     45
     46\section{Options}
     47
     48ABCL supports the following options:
     49
     50\begin{verbatim}
     51--help
     52    Displays this message.
     53--noinform
     54    Suppresses the printing of startup information and banner.
     55--noinit
     56    Suppresses the loading of the '~/.abclrc' startup file.
     57--nosystem
     58    Suppresses loading the 'system.lisp' customization file.
     59--eval <FORM>
     60    Evaluates the <FORM> before initializing REPL.
     61--load <FILE>
     62    Loads the file <FILE> before initializing REPL.
     63--load-system-file <FILE>
     64    Loads the system file <FILE> before initializing REPL.
     65--batch
     66    The process evaluates forms specified by arguments and possibly by those
     67    by those in the intialization file '~/.abcl', and then exits.
     68
     69The occurance of '--' copies the remaining arguments, unprocessed, into
     70the variable EXTENSIONS:*COMMAND-LINE-ARGUMENT-LIST*.
     71\end{verbatim}
     72
     73All of the command line arguments which follow the occurance of ``--''
     74are passed into a list bound to the EXT:*COMMAND-LINE-ARGUMENT-LIST*
     75variable.
     76
     77\section{Initialization}
     78
     79If the ABCL process is started without the ``--noinit'' flag, it
     80attempts to load a file named ``.abclrc'' located in the user's home
     81directory and then interpret its contents. 
     82
     83The user's home directory is determined by the value of the JVM system
     84property ``user.home''.
     85
    2286\chapter{Conformance}
    23 
    2487
    2588\section{ANSI Common Lisp}
Note: See TracChangeset for help on using the changeset viewer.