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

[runlisp] / runlisp.1.in

diff --git a/runlisp.1.in b/runlisp.1.in
index 2bfbf22b9e5138c1430680f7056c348dbe6acf8a..c015ea05b901112fbbac2dc7f13f0732a631887c 100644 (file)
--- a/runlisp.1.in
+++ b/runlisp.1.in
@@ -58,12 +58,18 @@ runlisp \- run Common Lisp programs as scripts
 .br
 .B runlisp
 .RI [ options ]
 .br
 .B runlisp
 .RI [ options ]

+.RB [ \-d
+.IR form ]

 .RB [ \-e
 .RB [ \-e

-.IR form  ]
+.IR form ]

 .RB [ \-l
 .IR file ]
 .RB [ \-p
 .RB [ \-l
 .IR file ]
 .RB [ \-p

-.IR form  ]
+.IR form ]
+.if !t \{\
+.br
+       \c
+.\}

 .RB [ \-\- ]
 .RI [ arguments
 \*(..]
 .RB [ \-\- ]
 .RI [ arguments
 \*(..]


@@ -164,15 +170,13 @@ Negate with
 or
 .BR \-\-no-command-line-only .
 This has no effect in eval mode.
 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\*(..
 Use one of the named Lisp systems.
 .
 .TP
 .BI "\-L" "\fR, " "\-\-accept-lisp=" sys , sys ,\fR\*(..
 Use one of the named Lisp systems.

-Each
+The

 .I sys
 .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:
 .RB ` , '
 and/or one or more whitespace characters.
 This option may be given more than once:


@@ -181,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.
 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
 .
 .TP
 .BI "\-c" "\fR, " "\-\-config-file=" conf


@@ -199,6 +210,32 @@ All of the files are expected to be as described in
 .BR runlisp.conf (5).
 .
 .TP
 .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
 .BI "\-e" "\fR, " "\-\-evaluate-expression=" expr
 Evaluate the expression(s)
 .I expr


@@ -247,13 +284,15 @@ and overrides any similarly named setting
 from the configuration file(s).
 .
 .TP
 from the configuration file(s).
 .
 .TP

-.BI "\-p" "\fR, " "\-\-print-expressin=" expr
+.BI "\-p" "\fR, " "\-\-print-expression=" expr

 Evaluate the expression(s)
 .I expr
 and print the resulting value(s)
 to standard output
 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;
 If a form produces multiple values,
 they are printed on a single line,
 separated by a single space character;


@@ -264,6 +303,11 @@ This option causes
 to execute in
 .I eval
 mode.
 to execute in
 .I eval
 mode.

+See also
+.RB ` \-d ',
+which prints with
+.B *print-escape*
+true.

 .
 .TP
 .BR "\-q" ", " "\-\-quiet"
 .
 .TP
 .BR "\-q" ", " "\-\-quiet"


@@ -290,13 +334,14 @@ Higher verbosity levels print informational and debugging messages.
 .
 .PP
 The
 .
 .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 ` \-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.
 marker in a script.
 These options may be given multiple times:
 they will be processed in the order given.


@@ -308,7 +353,7 @@ instead, use
 to load code from files.
 The
 .IR arguments ,
 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"
 are still made available to the evaluated forms and loaded files.
 .
 .SS "Operation"


@@ -323,6 +368,7 @@ though the boundary may be marked explicitly using
 .RB ` \-\- '
 if desired.
 If the command line contains any of
 .RB ` \-\- '
 if desired.
 If the command line contains any of

+.RB ` \-d ',

 .RB ` \-e ',
 .RB ` \-l ',
 or
 .RB ` \-e ',
 .RB ` \-l ',
 or


@@ -348,6 +394,9 @@ mode.
 In
 .I script
 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
 .B runlisp
 reads the second line of the script file,
 and checks to see if it contains the string


@@ -422,6 +471,7 @@ and
 is now committed to
 .I script
 mode, so it's too late for
 is now committed to
 .I script
 mode, so it's too late for

+.RB ` \-d ',

 .RB ` \-e ',
 .RB ` \-l ',
 and
 .RB ` \-e ',
 .RB ` \-l ',
 and