runlisp.c, README.org: Ignore unknown permitted Lisp systems.

[runlisp] / runlisp.1.in

diff --git a/runlisp.1.in b/runlisp.1.in
index 65c6543a03635c9317ae59cfa843f2c37bd54268..c015ea05b901112fbbac2dc7f13f0732a631887c 100644 (file)
--- a/runlisp.1.in
+++ b/runlisp.1.in
@@ -39,6 +39,7 @@
 .IP
 \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
 ..
+.ds .. \&.\|.\|.
 .
 .\"--------------------------------------------------------------------------
 .TH runlisp 1 "2 August 2020" "Mark Wooding"
@@ -53,29 +54,39 @@ runlisp \- run Common Lisp programs as scripts
 .RB [ \-\- ]
 .I script
 .RI [ arguments
-\&...]
+\*(..]
 .br
 .B runlisp
 .RI [ options ]
+.RB [ \-d
+.IR form ]
 .RB [ \-e
-.IR form  ]
+.IR form ]
 .RB [ \-l
 .IR file ]
 .RB [ \-p
-.IR form  ]
+.IR form ]
+.if !t \{\
+.br
+       \c
+.\}
 .RB [ \-\- ]
 .RI [ arguments
-\&...]
+\*(..]
 .PP
 where
 .I options
 is
 .br
-       \&
+       \c
 .RB [ \-CDEnqv ]
 .RB [ +DEn ]
 .RB [ \-L
-.IB sys , sys , \fR...]
+.IB sys , sys , \fR\*(..]
+.if !t \{\
+.br
+       \c
+.\}
 .RB [ \-c
 .IR conf ]
 .RB [ \-o
@@ -159,15 +170,13 @@ Negate with
 or
 .BR \-\-no-command-line-only .
 This has no effect in eval mode.
-which is set at compile time.
 .
 .TP
-.BI "\-L" "\fR, " "\-\-accept-lisp=" sys , sys ,\fR...
+.BI "\-L" "\fR, " "\-\-accept-lisp=" sys , sys ,\fR\*(..
 Use one of the named Lisp systems.
-Each
+The
 .I sys
-must name a supported Lisp system;
-the names are separated by a comma
+names are separated by a comma
 .RB ` , '
 and/or one or more whitespace characters.
 This option may be given more than once:
@@ -176,6 +185,13 @@ listing all of the systems named, in the same order.
 If a system is named more than once,
 a warning is issued (at verbosity level 1 or higher),
 and all but the first occurrence is ignored.
+System names which do not refer to known Lisp systems
+are silently ignored:
+otherwise, a script which supports an unusual Lisp system
+could never run at a site which doesn't have
+configuration runes for that Lisp system,
+even though they're useless
+if the system isn't actually installed.
 .
 .TP
 .BI "\-c" "\fR, " "\-\-config-file=" conf
@@ -194,6 +210,32 @@ All of the files are expected to be as described in
 .BR runlisp.conf (5).
 .
 .TP
+.BI "\-d" "\fR, " "\-\-dump-expression=" expr
+Evaluate the expression(s)
+.I expr
+and print the resulting value(s)
+to standard output
+(with
+.B *print-escape*
+true, as if by
+.BR prin1 ).
+If a form produces multiple values,
+they are printed on a single line,
+separated by a single space character;
+if a form produces no values at all,
+then nothing is printed \(en not even a newline character.
+This option causes
+.B runlisp
+to execute in
+.I eval
+mode.
+See also
+.RB ` \-p ',
+which prints with
+.B *print-escape*
+false.
+.
+.TP
 .BI "\-e" "\fR, " "\-\-evaluate-expression=" expr
 Evaluate the expression(s)
 .I expr
@@ -227,13 +269,30 @@ or
 .BR "\-\-no-dry-run" .
 .
 .TP
-.BI "\-p" "\fR, " "\-\-print-expressin=" expr
+.BI "\-o" "\fR, " "\-\-set-option=\fR[" sect :\fR] var = value
+Assign
+.I value
+to the variable
+.I var
+in configuration section
+.IR sect ,
+or
+.B @CONFIG
+if no section is specified.
+The value is unexpandable,
+and overrides any similarly named setting
+from the configuration file(s).
+.
+.TP
+.BI "\-p" "\fR, " "\-\-print-expression=" expr
 Evaluate the expression(s)
 .I expr
 and print the resulting value(s)
 to standard output
-(as if by
-.BR prin1 ).
+(with
+.B *print-escape*
+false, as if by
+.BR princ ).
 If a form produces multiple values,
 they are printed on a single line,
 separated by a single space character;
@@ -244,6 +303,11 @@ This option causes
 to execute in
 .I eval
 mode.
+See also
+.RB ` \-d ',
+which prints with
+.B *print-escape*
+true.
 .
 .TP
 .BR "\-q" ", " "\-\-quiet"
@@ -270,13 +334,14 @@ Higher verbosity levels print informational and debugging messages.
 .
 .PP
 The
+.RB ` \-d ',
 .RB ` \-e ',
 .RB ` \-l ',
 and
 .RB ` \-p '
 options may only be given on the command-line itself,
 not following a
-.RB `@ RUNLISP: '
+.RB ` @RUNLISP: '
 marker in a script.
 These options may be given multiple times:
 they will be processed in the order given.
@@ -288,7 +353,7 @@ instead, use
 to load code from files.
 The
 .IR arguments ,
-ppif any,
+if any,
 are still made available to the evaluated forms and loaded files.
 .
 .SS "Operation"
@@ -303,6 +368,7 @@ though the boundary may be marked explicitly using
 .RB ` \-\- '
 if desired.
 If the command line contains any of
+.RB ` \-d ',
 .RB ` \-e ',
 .RB ` \-l ',
 or
@@ -328,6 +394,9 @@ mode.
 In
 .I script
 mode,
+and if the
+.RB ` \-E '
+option was not given,
 .B runlisp
 reads the second line of the script file,
 and checks to see if it contains the string
@@ -347,10 +416,10 @@ can be included in a word by
 or
 .IR escaping .
 Text between single quotes
-.BR ' ... '
+.BR ' \*(.. '
 is included literally, without any further interpretation;
 text between double quotes
-.BR """" ... """"
+.BR """" \*(.. """"
 is treated literally,
 except that escaping can still be used
 to escape (e.g.) double quotes and the escape character itself.
@@ -402,6 +471,7 @@ and
 is now committed to
 .I script
 mode, so it's too late for
+.RB ` \-d ',
 .RB ` \-e ',
 .RB ` \-l ',
 and