runlisp.conf.5.in: Some minor typesetting touch-ups.

[runlisp] / runlisp.conf.5.in

diff --git a/runlisp.conf.5.in b/runlisp.conf.5.in
index 64cbe38..d94fdf5 100644 (file)
--- a/runlisp.conf.5.in
+++ b/runlisp.conf.5.in
@@ -39,7 +39,7 @@
 .IP
 \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
 ..
-.ds , \h'.16667m'
+.ds .. \&.\|.\|.
 .
 .\"--------------------------------------------------------------------------
 .TH runlisp.conf 5 "27 August 2020" "Mark Wooding"
@@ -227,7 +227,7 @@ together with the contents of the subsequent lines;
 initial and trailing whitespace is removed from each piece,
 and the (nonempty) pieces are joined,
 separated by single spaces.
-We say that a assignment
+We say that an assignment
 assigns a value to the variable
 in some section \(en
 namely, the section in which the assignment is applied.
@@ -254,7 +254,8 @@ Then
 is assigned the value
 .RB ` "one two ; not a comment three" ',
 and
-.B short is assigned
+.B short
+is assigned
 .RB ` "just a quick note" '.
 .PP
 The assignments applied to a section
@@ -278,14 +279,14 @@ and
 .B @ENV
 sections have no parents.
 The
-.B @CONFIG
+.B @COMMON
 section has one parent, namely
 .BR @BUILTIN .
 .PP
 If the variable
 .B @parents
 is set in a section other than one of those named above,
-then it must consist of a space- or comma-separated list
+then it must consist of a space- and/or comma-separated list
 of names,
 which name the section's parents.
 Currently, the parents need not be distinct,
@@ -318,7 +319,7 @@ Otherwise, the variable is looked up in each of the section's parents.
 If none of these lookups succeeds, then the lookup fails.
 If all of the successful lookups found the
 .I "same assignment"
-(not just the same value!)
+(not just the same value!)\&
 then lookup finds that assignment.
 Otherwise, the lookup reports an error.
 .
@@ -359,7 +360,7 @@ takes the form
 .IB sect : \c
 .RI ] var \c
 .RB [ | \c
-.IR filter ]... \c
+.IR filter ]\*(.. \c
 .RB [ ? \c
 .IR alt ] \c
 .BR } .
@@ -459,7 +460,7 @@ If a double-quote character
 is encountered,
 then a word is started if there is none currently under construction.
 Until the next double quote is encountered,
-whitespace and single quotes treated literally,
+whitespace and single quotes are treated literally,
 and simply added to the current word;
 backslashes can be used to escape characters,
 such as double quotes,
@@ -489,7 +490,7 @@ is encountered outside of a word,
 so that the result is subject to word splitting,
 then an error is reported if a new word is started
 without there being whitespace between the closing brace of the
-.B $ -expansion
+.BR $ -expansion
 and the character which started the new word.
 For example,
 .IP
@@ -509,9 +510,9 @@ but this is not recommended.
 .SS "Predefined variables in @BUILTIN"
 The
 .B @BULITIN
-Section has no parents.
+section has no parents.
 You should not override its settings in configuration files.
-it holds a number of variables set by the
+It holds a number of variables set by the
 .B runlisp
 programs.
 .
@@ -539,7 +540,7 @@ or
 (For some reason,
 the ECL developers are changing
 the way ECL recognizes command-line options,
-because they think that the minor aesthetic improvement
+because they think that the minor \(aesthetic improvement
 is worth breaking everyone's scripts.)
 This is determined by the
 .B ecl-opt
@@ -549,6 +550,19 @@ section,
 or a value determined at compile time.
 .
 .TP
+.B @hash
+Set by
+.BR dump-runlisp-image (1)
+to the hash
+(a string of hexadecimal digits)
+identifying the versions of the Lisp code included
+\(en or to be included \(en
+in a custom image.
+This is constructed by hashing the result of evaluating the
+.B lisp-version
+expression in the system definition.
+.
+.TP
 .B @image-dir
 The directory in which
 .B runlisp
@@ -566,6 +580,13 @@ section,
 or a value determined at compile time.
 .
 .TP
+.B @image-link
+The well-known name of the image;
+actually a symbolic link to the `real' image file,
+whose name includes a hash
+which identifies the versions of the Lisp code included in the image.
+.
+.TP
 .B @image-new
 Set by
 .BR dump-runlisp-image (1)
@@ -577,6 +598,14 @@ will rename the image into place itself,
 if the command completes successfully.)
 .
 .TP
+.B @image-newlink
+Set by
+.BR dump-runlisp-image (1)
+to the name to use for the updated symbolic link to the image file.
+This is used internally,
+and is not expected to be useful in Lisp system definitions.
+.
+.TP
 .B @image-out
 Set by
 .BR dump-runlisp-image (1)
@@ -703,7 +732,7 @@ from the
 section instead.
 .
 .TP
-.B @image-dir
+.B image-dir
 The directory in which
 .B runlisp
 looks for, and
@@ -809,10 +838,6 @@ and there is probably no need to override it;
 .B @image-dir
 is set in the
 .B @BUILTIN
-section
-.RB ( @image-dir
-is set in the
-.N @BUILTIN
 section \(en see above \(en and
 .B image-file
 must be set in this section