* src/preproc/soelim/soelim.man: Document how to insert `\' and ` '

in file names.

1 files changed, 27 insertions, 5 deletions

diff --git a/src/preproc/soelim/soelim.man b/src/preproc/soelim/soelim.man
index fb17e364..340a5b71 100644
--- a/src/preproc/soelim/soelim.man
+++ b/src/preproc/soelim/soelim.man
@@ -1,6 +1,7 @@
 '\" p
 .ig
-Copyright (C) 1989-2000, 2001, 2003, 2004 Free Software Foundation, Inc.
+Copyright (C) 1989-2000, 2001, 2003, 2004, 2006
+Free Software Foundation, Inc.
 
 Permission is granted to make and distribute verbatim copies of
 this manual provided the copyright notice and this permission notice
@@ -22,10 +23,14 @@ the original English.
 .
 .TH @G@SOELIM @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
 .
+.
 .SH NAME
+.
 @g@soelim \- interpret .so requests in groff input
 .
+.
 .SH SYNOPSIS
+.
 .B @g@soelim
 [
 .B \-Crtv
@@ -42,7 +47,9 @@ It is possible to have whitespace between the
 .B \-I
 command line option and its parameter.
 .
+.
 .SH DESCRIPTION
+.
 .B @g@soelim
 reads
 .I files
@@ -63,6 +70,15 @@ option of
 .BR groff .
 .
 .PP
+To embed `\[rs]' in the file name, write `\[rs]\[rs]' or `\[rs]e'.
+To embed a space, write `\[rs]\ '.
+Any other escape sequence in
+.I file
+makes
+.B soelim
+ignore the whole line.
+.
+.PP
 Note that there must be no whitespace between the leading dot and
 the two characters `s' and `o'.  Otherwise, only
 .B groff
@@ -72,7 +88,9 @@ request (and
 .B soelim
 ignores it).
 .
+.
 .SH OPTIONS
+.
 .TP
 .B \-C
 Recognize
@@ -83,27 +101,29 @@ even when followed by a character other than space or newline.
 .BI \-I dir
 This option may be used to specify a directory to search for
 files (both those on the command line and those named in
-.B \&.so
+.B .so
 requests).
 The current directory is always searched first.
 This option may be specified more than once,
-the directories will be searched in the order specified.
+the directories are searched in the order specified.
 No directory search is performed for files specified using an absolute path.
 .
 .TP
 .B \-r
-Do not add .lf requests (for general use, with non-groff files).
+Do not add \&.lf requests (for general use, with non-groff files).
 .
 .TP
 .B \-t
-Don't emit .lf requests but TeX comment lines (starting with `%') giving
+Don't emit \&.lf requests but TeX comment lines (starting with `%') giving
 the current file and line number.
 .
 .TP
 .B \-v
 Print the version number.
 .
+.
 .SH USAGE
+.
 The normal processing sequence of groff is this:
 .
 .PP
@@ -208,7 +228,9 @@ box invisible width 0.5 height 0.4 "output" "file"
 .fi
 .\}
 .
+.
 .SH "SEE ALSO"
+.
 .BR groff (@MAN1EXT@)
 .
 .\" Local Variables: