xref: /freebsd/contrib/mandoc/soelim.1 (revision 01d4e2149e5566e5d9394913dc9fb032da259e0b)
1*61d06d6bSBaptiste Daroussin.\"	$Id: soelim.1,v 1.5 2017/07/04 23:40:01 schwarze Exp $
2*61d06d6bSBaptiste Daroussin.\"
3*61d06d6bSBaptiste Daroussin.\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
4*61d06d6bSBaptiste Daroussin.\" All rights reserved.
5*61d06d6bSBaptiste Daroussin.\"
6*61d06d6bSBaptiste Daroussin.\" Redistribution and use in source and binary forms, with or without
7*61d06d6bSBaptiste Daroussin.\" modification, are permitted provided that the following conditions
8*61d06d6bSBaptiste Daroussin.\" are met:
9*61d06d6bSBaptiste Daroussin.\" 1. Redistributions of source code must retain the above copyright
10*61d06d6bSBaptiste Daroussin.\"    notice, this list of conditions and the following disclaimer.
11*61d06d6bSBaptiste Daroussin.\" 2. Redistributions in binary form must reproduce the above copyright
12*61d06d6bSBaptiste Daroussin.\"    notice, this list of conditions and the following disclaimer in the
13*61d06d6bSBaptiste Daroussin.\"    documentation and/or other materials provided with the distribution.
14*61d06d6bSBaptiste Daroussin.\"
15*61d06d6bSBaptiste Daroussin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16*61d06d6bSBaptiste Daroussin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17*61d06d6bSBaptiste Daroussin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18*61d06d6bSBaptiste Daroussin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19*61d06d6bSBaptiste Daroussin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20*61d06d6bSBaptiste Daroussin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21*61d06d6bSBaptiste Daroussin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22*61d06d6bSBaptiste Daroussin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23*61d06d6bSBaptiste Daroussin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24*61d06d6bSBaptiste Daroussin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25*61d06d6bSBaptiste Daroussin.\" SUCH DAMAGE.
26*61d06d6bSBaptiste Daroussin.\"
27*61d06d6bSBaptiste Daroussin.Dd $Mdocdate: July 4 2017 $
28*61d06d6bSBaptiste Daroussin.Dt SOELIM 1
29*61d06d6bSBaptiste Daroussin.Os
30*61d06d6bSBaptiste Daroussin.Sh NAME
31*61d06d6bSBaptiste Daroussin.Nm soelim
32*61d06d6bSBaptiste Daroussin.Nd interpret .so requests in manpages
33*61d06d6bSBaptiste Daroussin.Sh SYNOPSIS
34*61d06d6bSBaptiste Daroussin.Nm
35*61d06d6bSBaptiste Daroussin.Op Fl Crtv
36*61d06d6bSBaptiste Daroussin.Op Fl I Ar dir
37*61d06d6bSBaptiste Daroussin.Op Ar files ...
38*61d06d6bSBaptiste Daroussin.Sh DESCRIPTION
39*61d06d6bSBaptiste Daroussin.Nm
40*61d06d6bSBaptiste Daroussinreads
41*61d06d6bSBaptiste Daroussin.Ar files
42*61d06d6bSBaptiste Daroussinlines by lines.
43*61d06d6bSBaptiste Daroussin.Pp
44*61d06d6bSBaptiste DaroussinIf a line starts by:
45*61d06d6bSBaptiste Daroussin.Dq .so anotherfile
46*61d06d6bSBaptiste Daroussinit replace the line by processing
47*61d06d6bSBaptiste Daroussin.Dq anotherfile .
48*61d06d6bSBaptiste DaroussinOtherwise the line is printed to stdout.
49*61d06d6bSBaptiste Daroussin.Bl -tag -width "-I dir"
50*61d06d6bSBaptiste Daroussin.It Fl C
51*61d06d6bSBaptiste DaroussinRecognise
52*61d06d6bSBaptiste Daroussin.Em .so
53*61d06d6bSBaptiste Daroussinwhen not followed by a space character.
54*61d06d6bSBaptiste Daroussin.It Fl r
55*61d06d6bSBaptiste DaroussinCompatibility with GNU groff's
56*61d06d6bSBaptiste Daroussin.Nm soelim
57*61d06d6bSBaptiste Daroussin(does nothing).
58*61d06d6bSBaptiste Daroussin.It Fl t
59*61d06d6bSBaptiste DaroussinCompatibility with GNU groff's
60*61d06d6bSBaptiste Daroussin.Nm soelim
61*61d06d6bSBaptiste Daroussin(does nothing).
62*61d06d6bSBaptiste Daroussin.It Fl v
63*61d06d6bSBaptiste DaroussinCompatibility with GNU groff's
64*61d06d6bSBaptiste Daroussin.Nm soelim
65*61d06d6bSBaptiste Daroussin(does nothing).
66*61d06d6bSBaptiste Daroussin.It Fl I Ar dir
67*61d06d6bSBaptiste DaroussinThis option specify directories where
68*61d06d6bSBaptiste Daroussin.Nm
69*61d06d6bSBaptiste Daroussinsearches for files (both those on the command line and those named in
70*61d06d6bSBaptiste Daroussin.Dq .so
71*61d06d6bSBaptiste Daroussindirective.)
72*61d06d6bSBaptiste DaroussinThis options may be specified multiple times.
73*61d06d6bSBaptiste DaroussinThe directories will be searched in the order specified.
74*61d06d6bSBaptiste Daroussin.El
75*61d06d6bSBaptiste Daroussin.Pp
76*61d06d6bSBaptiste DaroussinThe files are always searched first in the current directory.
77*61d06d6bSBaptiste Daroussin.Pp
78*61d06d6bSBaptiste DaroussinA file specified with an absolute path will be opened directly without
79*61d06d6bSBaptiste Daroussinperforming a search.
80*61d06d6bSBaptiste Daroussin.Sh SEE ALSO
81*61d06d6bSBaptiste Daroussin.Xr mandoc 1
82*61d06d6bSBaptiste Daroussin.Sh AUTHORS
83*61d06d6bSBaptiste DaroussinThis version of the
84*61d06d6bSBaptiste Daroussin.Nm
85*61d06d6bSBaptiste Daroussinutility was written by
86*61d06d6bSBaptiste Daroussin.An Baptiste Daroussin Aq Mt bapt@freebsd.org .
87