xref: /freebsd/usr.bin/soelim/soelim.1 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
2.\" 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd November 7, 2015
26.Dt SOELIM 1
27.Os
28.Sh NAME
29.Nm soelim
30.Nd interpret .so requests in manpages
31.Sh SYNOPSIS
32.Nm
33.Op Fl Crtv
34.Op Fl I Ar dir
35.Op Ar
36.Sh DESCRIPTION
37The
38.Nm
39utility
40reads the specified files or the standard input and performs the textual
41inclusion implied by the
42.Xr nroff 1 Pq Pa ports/textproc/groff
43directives of the form:
44.Pp
45.Dl \&.so anotherfile
46.Pp
47If a line starts with:
48.Dq .so anotherfile
49it replaces the line by processing
50.Dq anotherfile .
51Otherwise the line is printed to stdout.
52.Bl -tag -width "-I dir"
53.It Fl C
54Recognise
55.Em .so
56when it is not followed by a space character.
57.It Fl r
58Compatibility with groff's
59.Xr soelim 1
60(does nothing).
61.It Fl t
62Compatibility with groff's
63.Xr soelim 1
64(does nothing).
65.It Fl v
66Compatibility with groff's
67.Xr soelim 1
68(does nothing).
69.It Fl I Ar dir
70This option specifies directories where
71.Nm
72searches for files (both those on the command line and those named in
73.Dq .so
74directive.)
75This option may be specified multiple times.
76The directories will be searched in the order specified.
77.El
78.Pp
79The files are always searched first in the current directory.
80.Pp
81A file specified with an absolute path will be opened directly without
82performing a search.
83.Sh SEE ALSO
84.Xr mandoc 1
85.Sh AUTHORS
86This version of the
87.Nm
88utility was written by
89.An Baptiste Daroussin Aq Mt bapt@freebsd.org .
90