GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOELIM (1)

NAME

soelim - interpret .so requests in groff input

CONTENTS

Synopsis
Description
Options
Usage

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

box invisible width 0.5 height 0.4 "input" "file"; move to last box .bottom; down; arrow 0.3; box invisible width 0.8 height 0.2 "preprocessor"; move to last box .right right; arrow 0.3; A: box invisible width 0.35 height 0.2 "troff"; move to last box .top; up; move 0.3; box invisible width 0.6 height 0.4 "sourced" "file"; line <- up 0.3 from A.top; move to A.right; right; arrow 0.3; box invisible width 0.85 height 0.2 "postprocessor"; move to last box .bottom; down; arrow 0.3; box invisible width 0.5 height 0.4 "output" "file"

          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:

box invisible width 0.5 height 0.4 "input" "file"; move to last box .bottom; down; arrow 0.3; A: box invisible width 0.5 height 0.2 "soelim"; line <- 0.3; box invisible width 0.5 height 0.4 "sourced" "file"; move to A.right; right; arrow 0.3; box invisible width 0.8 height 0.2 "preprocessor"; arrow 0.3; box invisible width 0.35 height 0.2 "troff"; arrow 0.3 box invisible width 0.85 height 0.2 "postprocessor"; move to last box .bottom; down; arrow 0.3; box invisible width 0.5 height 0.4 "output" "file"

          input
          file
            |
            v
          soelim -> preprocessor -> troff -> postprocessor
            ^                                     |
            |                                     v
         sourced                               output
          file                                  file

SEE ALSO

groff(1)
Search for    or go to Top of page |  Section 1 |  Main Index


Groff Version 1.19.2 SOELIM (1) 24 March 2016

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.