|
NAME | SYNOPSIS | DESCRIPTION | OPTIONS | USAGE | SEE ALSO | COLOPHON |
|
SOELIM(1) General Commands Manual SOELIM(1)
soelim - interpret .so requests in groff input
soelim [-Crtv] [-I dir] [files ...]
It is possible to have whitespace between the -I command-line option
and its parameter.
soelim reads files and replaces lines of the form
.so file
by the contents of file. It is useful if files included with .so
need to be preprocessed. Normally, soelim should be invoked with the
-s option of groff.
To embed ‘\’ in the file name, write ‘\\’ or ‘\e’. To embed a space,
write ‘\ ’. Any other escape sequence in file makes soelim ignore
the whole line.
Note that there must be no whitespace between the leading dot and the
two characters ‘s’ and ‘o’. Otherwise, only groff interprets the .so
request (and soelim ignores it).
-C Recognize .so even when followed by a character other than
space or newline.
-Idir 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
.so 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 -I. at
the appropriate place.
No directory search is performed for files with an absolute
file name.
-r Do not add .lf requests (for general use, with non-groff
files).
-t Don't emit .lf requests but TeX comment lines (starting with
‘%’) giving the current file and line number.
-v Print the version number.
The normal processing sequence of groff is this:
input sourced
file file
| |
v v
preprocessor -> troff -> postprocessor
|
v
output
file
That is, files sourced with .so are normally read only by troff (the
actual formatter). soelim is not required for troff to source files.
If a file to be sourced should also be preprocessed, it must already
be read before the input file passes through the preprocessor. This
is handled by soelim:
input
file
|
v
soelim -> preprocessor -> troff -> postprocessor
^ |
| v
sourced output
file file
groff(1)
This page is part of the groff (GNU troff) project. Information
about the project can be found at
⟨http://www.gnu.org/software/groff/⟩. If you have a bug report for
this manual page, see ⟨http://www.gnu.org/software/groff/⟩. This
page was obtained from the project's upstream Git repository
⟨https://git.savannah.gnu.org/git/groff.git⟩ on 2018-02-02. (At that
time, the date of the most recent commit that was found in the repos‐
itory was 2018-02-02.) If you discover any rendering problems in
this HTML version of the page, or you believe there is a better or
more up-to-date source for the page, or you have corrections or
improvements to the information in this COLOPHON (which is not part
of the original manual page), send a mail to man-pages@man7.org
Groff Version 1.22.3 24 November 2017 SOELIM(1)
Pages that refer to this page: groff(1), refer(1), groff_tmac(5)
|
HTML rendering created 2018-02-02 by Michael Kerrisk, author of The Linux Programming Interface, maintainer of the Linux man-pages project. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.
|
|