269 lines
4.1 KiB
HTML
269 lines
4.1 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of SOELIM</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>SOELIM</H1>
|
|
Section: User Commands (1)<BR>Updated: 21 March 2020<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
soelim - interpret .so requests in groff input
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
|
|
[ <B>-Crtv</B> ]
|
|
|
|
[ <B>-I </B><I>dir</I> ]
|
|
|
|
[<I>file</I>
|
|
|
|
...]
|
|
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
<B>soelim</B>
|
|
|
|
reads
|
|
<I>files</I>
|
|
|
|
and replaces lines of the form
|
|
<DL COMPACT>
|
|
<DT id="1"><DD>
|
|
<B>.so~</B><I>file</I>
|
|
|
|
</DL>
|
|
<P>
|
|
|
|
by the contents of
|
|
<I>file</I>.
|
|
|
|
It is useful if files included with
|
|
<B>.so</B>
|
|
|
|
need to be preprocessed.
|
|
Normally,
|
|
<B>soelim</B>
|
|
|
|
should be invoked with the
|
|
<B>-s</B>
|
|
|
|
option of
|
|
<B>groff</B>.
|
|
|
|
<P>
|
|
|
|
To embed '\' in the file name, write '\\'
|
|
or '\e'.
|
|
To embed a space, write '\ '.
|
|
Any other escape sequence in
|
|
<I>file</I>
|
|
|
|
makes
|
|
<B>soelim</B>
|
|
|
|
ignore the whole line.
|
|
<P>
|
|
|
|
Note that there must be no whitespace between the leading dot and the two
|
|
characters 's' and 'o'.
|
|
Otherwise, only
|
|
<B>groff</B>
|
|
|
|
interprets the
|
|
<B>.so</B>
|
|
|
|
request (and
|
|
<B>soelim</B>
|
|
|
|
ignores it).
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
|
|
Whitespace is permitted between a command-line option and its argument.
|
|
<DL COMPACT>
|
|
<DT id="2"><B>-C</B>
|
|
|
|
<DD>
|
|
Recognize
|
|
<B>.so</B>
|
|
|
|
even when followed by a character other than space or newline.
|
|
<DT id="3"><B>-I</B><I>dir</I>
|
|
|
|
<DD>
|
|
This option may be used to add a directory to the search path for
|
|
files (both those on the command line and those named in
|
|
<B>.so</B>
|
|
|
|
requests).
|
|
The search path is initialized with the current directory.
|
|
This option may be specified more than once; the directories are then
|
|
searched in the order specified (but before the current directory).
|
|
If you want to make the current directory be read before other
|
|
directories, add
|
|
<B>-I.</B>
|
|
|
|
at the appropriate place.
|
|
<DT id="4"><DD>
|
|
No directory search is performed for files with an absolute file name.
|
|
<DT id="5"><B>-r</B>
|
|
|
|
<DD>
|
|
Do not add
|
|
<B>.lf</B>
|
|
|
|
requests (for general use, with non-groff files).
|
|
<DT id="6"><B>-t</B>
|
|
|
|
<DD>
|
|
Don't emit
|
|
<B>.lf</B>
|
|
|
|
requests but TeX comment lines (starting with '%') giving the
|
|
current file and line number.
|
|
<DT id="7"><B>-v</B>
|
|
|
|
<DD>
|
|
Print the version number.
|
|
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>USAGE</H2>
|
|
|
|
|
|
The normal processing sequence of groff is this:
|
|
<P>
|
|
|
|
|
|
<PRE>
|
|
|
|
input sourced
|
|
file file
|
|
| |
|
|
v v
|
|
preprocessor -> troff -> postprocessor
|
|
|
|
|
v
|
|
output
|
|
file
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
That is, files sourced with
|
|
<B>.so</B>
|
|
|
|
are normally read
|
|
<I>only</I>
|
|
|
|
by
|
|
<B>troff</B>
|
|
|
|
(the actual formatter).
|
|
<B>soelim</B>
|
|
|
|
is
|
|
<I>not</I>
|
|
|
|
required for
|
|
<B>troff</B>
|
|
|
|
to source files.
|
|
<P>
|
|
|
|
If a file to be sourced should also be preprocessed, it must already be read
|
|
<I>before</I>
|
|
|
|
the input file passes through the preprocessor.
|
|
This is handled by
|
|
<B>soelim</B>:
|
|
|
|
<P>
|
|
|
|
|
|
<PRE>
|
|
|
|
input
|
|
file
|
|
|
|
|
v
|
|
soelim -> preprocessor -> troff -> postprocessor
|
|
^ |
|
|
| v
|
|
sourced output
|
|
file file
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAG"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+groff">groff</A></B>(1)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="8"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="9"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="10"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="11"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="12"><A HREF="#lbAF">USAGE</A><DD>
|
|
<DT id="13"><A HREF="#lbAG">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:27 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|