Mac Developer Library Developer
Search

 

This manual page is for Mac OS X version 10.9

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • To learn how the manual is organized or to learn about command syntax, read the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Developer Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



SOELIM(1)                                                                                          SOELIM(1)



NAME
       soelim - interpret .so requests in groff input

SYNOPSIS
       soelim [ -Crtv ] [ -Idir ] [ files... ]

       It is possible to have whitespace between the -I command line option and its parameter.

DESCRIPTION
       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.

       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).

OPTIONS
       -C     Recognize .so even when followed by a character other than space or newline.

       -Idir  This  option may be used to specify a directory to search for files (both those on the command
              line and those named in .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 speci-fied. specified.
              fied.  No directory search is performed for files specified using an absolute path.

       -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.

USAGE
       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

SEE ALSO
       groff(1)



Groff Version 1.19.2                            6 August 2004                                      SOELIM(1)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Feedback