1SOELIM(1)                   General Commands Manual                  SOELIM(1)
2
3
4

NAME

6       soelim - interpret .so requests in groff input
7

SYNOPSIS

9       soelim [-Crtv] [-I dir] [files ...]
10
11       It  is  possible  to have whitespace between the -I command line option
12       and its parameter.
13

DESCRIPTION

15       soelim reads files and replaces lines of the form
16
17              .so file
18
19       by the contents of file.  It is useful if files included with .so  need
20       to  be  preprocessed.   Normally,  soelim should be invoked with the -s
21       option of groff.
22
23       To embed `\' in the file name, write `\\' or `\e'.  To embed  a  space,
24       write  `\ '.  Any other escape sequence in file makes soelim ignore the
25       whole line.
26
27       Note that there must be no whitespace between the leading dot  and  the
28       two  characters  `s' and `o'.  Otherwise, only groff interprets the .so
29       request (and soelim ignores it).
30

OPTIONS

32       -C     Recognize .so even when followed by a character other than space
33              or newline.
34
35       -Idir  This  option  may  be used to add a directory to the search path
36              for files (both those on the command line and those named in .so
37              requests).   The  search  path  is  initialized with the current
38              directory.  This option may be specified  more  than  once;  the
39              directories are then searched in the order specified (but before
40              the current directory).  If you want to make the current  direc‐
41              tory  be read before other directories, add -I. at the appropri‐
42              ate place.
43
44              No directory search is performed for files with an absolute file
45              name.
46
47       -r     Do not add .lf requests (for general use, with non-groff files).
48
49       -t     Don't  emit  .lf  requests  but TeX comment lines (starting with
50              `%') giving the current file and line number.
51
52       -v     Print the version number.
53

USAGE

55       The normal processing sequence of groff is this:
56
57                 input        sourced
58                 file          file
59                   |             |
60                   v             v
61               preprocessor -> troff -> postprocessor
62                                             |
63                                             v
64                                          output
65                                           file
66
67       That is, files sourced with .so are normally read only  by  troff  (the
68       actual formatter).  soelim is not required for troff to source files.
69
70       If a file to be sourced should also be preprocessed, it must already be
71       read before the input file passes through the  preprocessor.   This  is
72       handled by soelim:
73
74                 input
75                 file
76                   |
77                   v
78                 soelim -> preprocessor -> troff -> postprocessor
79                   ^                                     |
80                   |                                     v
81                sourced                               output
82                 file                                  file
83

SEE ALSO

85       groff(1)
86
87
88
89Groff Version 1.20.1            9 January 2009                       SOELIM(1)