X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/runlisp/blobdiff_plain/7e3a86038e2a2cbb48b356cb029f9de99c14ec79..60f1d5fe519c30e68be464696ce9c4ad56a6b050:/README.org diff --git a/README.org b/README.org index fd8c9e4..62f5216 100644 --- a/README.org +++ b/README.org @@ -25,7 +25,8 @@ configuration file. Of course, there's a benefit to having a collection of high-quality configuration runes curated centrally, so I'm happy to accept submissions in support of any free[fn:free] Lisp implementations. -[fn:free] Here I mean free as in freedom. +[fn:free] Here I mean `free' as in freedom: see +https://www.fsf.org/about/what-is-free-software. * Writing scripts in Common Lisp @@ -121,7 +122,7 @@ For example: + The prevailing Unix standard input, output, and error files are available through the Lisp ~*standard-input*~, ~*standard-output*~, - and ~*error-ouptut*~ streams, respectively. (This is, alas, not a + and ~*error-output*~ streams, respectively. (This is, alas, not a foregone conclusion.) + The keyword ~:runlisp-script~ is added to the ~*features*~ list. @@ -176,7 +177,7 @@ prints values as if by ~prin1~. For example, : $ runlisp -p '"Hello, world!"' : Hello, world! -: runlisp -d '"Hello, world!"' +: $ runlisp -d '"Hello, world!"' : "Hello, world!" In addition to evaluating forms with ~-e~, and printing their values @@ -225,7 +226,7 @@ The ~runlisp~ program looks for configuration in a number of places. All of the files in this directory named ~SOMETHING.conf~ are read, in increasing lexicographical order by name. The package comes with a file ~0base.conf~ intended to be read first, so that it can be - overridden if necessar. This sets up basic definitions, and defines + overridden if necessary. This sets up basic definitions, and defines the necessary runes for those Lisp implementations which are supported `out of the box'. New Lisp packages might come with additional files to drop into this directory. @@ -241,7 +242,7 @@ The ~runlisp~ program looks for configuration in a number of places. directories to add support for privately installed Lisp systems, or to override settings made by earlier configuration files. -But configuration files generally look like =.ini=-style files. A line +Configuration files generally look like =.ini=-style files. A line beginning with a semicolon ~;~ is a comment and is ignored. Most lines are assignments, which look like #+BEGIN_QUOTE @@ -259,7 +260,7 @@ Configuration options can also be set on the command line, though the effects are subtly different. Again, see the manual pages for details. [fn:xdg-config] More properly, in ~$XDG_CONFIG_HOME/runlisp.conf~, if -you set that. +you set that variable. ** Deciding which Lisp implementation to use @@ -328,7 +329,9 @@ Lisp. (SBCL's command-line interface is well thought-out, so this is an ideal opportunity to explain how ~runlisp~ configuration works, without getting bogged down in the details of fighting less amenable Lisps.) -The provided ~0base.conf~ file defines SBCL as follows. +The provided ~0base.conf~ file used to define SBCL as follows. (The +real version now contains a kludge for old versions, which needn't +concern us here.) : [sbcl] : @@ -571,7 +574,7 @@ impossible to access. : NIL As another example, Armed Bear Common Lisp doesn't seem to believe in -the stderr stream: when it starts up, ~*error-ouptut*~ is bound to the +the stderr stream: when it starts up, ~*error-output*~ is bound to the standard output, just like ~*standard-output*~. Also, ~cl-launch~ loading ASDF causes a huge number of ~style-warning~ messages to be written to stdout, making ABCL pretty much useless for writing filter @@ -620,5 +623,12 @@ supports. If you want your scripts to be able to run on other Lisps, then ~cl-launch~ is the way to do that. Of course, I welcome patches to help ~runlisp~ support other free Lisp implementations. ~cl-launch~ also supports proprietary Lisps: I have very little interest in these, -so if you want to run scripts using Allegro or LispWorks then -~cl-launch~ is your only choice. +so if you want to run scripts using Allegro or LispWorks then your only +options are to maintain your own ~runlisp~ configuration for these +systems or to use ~cl-launch~. + +* COMMENT Emacs cruft + +# LocalWords: abcl Almquist argv ATTR Attr BST clisp CLisp's Clozure CMU ecl +# LocalWords: env fn ini interp launchrc lua nbsp noinform precompiled prin +# LocalWords: princ sb SBCL's sed SYSCONFDIR sysinit TBLFM tbp tikz xdg XPS