Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / soelim / soelim.1
1 .\" Copyright (c) 1980, 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)soelim.1    8.1 (Berkeley) 6/6/93
33 .\" $FreeBSD: src/usr.bin/soelim/soelim.1,v 1.4.2.3 2003/02/24 23:04:39 trhodes Exp $
34 .\"
35 .Dd June 6, 1993
36 .Dt SOELIM 1
37 .Os
38 .Sh NAME
39 .Nm soelim
40 .Nd eliminate \&.so's from nroff input
41 .Sh SYNOPSIS
42 .Nm
43 .Op Ar
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility
48 reads the specified files or the standard input and performs the textual
49 inclusion implied by the
50 .Xr nroff 1
51 directives of the form:
52 .Pp
53 .Dl \&.so somefile
54 .Pp
55 The directives need to appear at the beginning of input lines.
56 This is useful since programs such as
57 .Xr tbl 1
58 do not normally do this; it allows the placement of individual tables
59 in separate files to be run as a part of a large document.
60 .Pp
61 An argument consisting of a single minus
62 .Sq Fl
63 is taken to be
64 a file name corresponding to the standard input.
65 .Pp
66 Note that inclusion can be suppressed by using
67 .Ql \e'
68 instead of
69 .Ql \e. ,
70 i.e.\&
71 .Pp
72 .Dl \'so /usr/lib/tmac.s
73 .Pp
74 A sample usage of
75 .Nm
76 would be
77 .Pp
78 .Bd -literal -offset indent -compact
79 soelim exum?.n \&| tbl \&| nroff \-ms \&| col \&| lpr
80 .Ed
81 .Sh SEE ALSO
82 .Xr colcrt 1 ,
83 .Xr more 1
84 .Sh BUGS
85 The format of the source commands must involve no strangeness \-
86 exactly one blank must precede and no blanks follow the file name.
87 .Sh HISTORY
88 The
89 .Nm
90 command appeared in
91 .Bx 3.0 .