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] [file ...]
10

DESCRIPTION

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

OPTIONS

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

USAGE

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

SEE ALSO

84       groff(1)
85
86
87
88groff 1.22.4                     17 March 2021                       SOELIM(1)