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