xref: /freebsd/usr.bin/soelim/soelim.1 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1363da138SBaptiste Daroussin.\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
2363da138SBaptiste Daroussin.\" All rights reserved.
3363da138SBaptiste Daroussin.\"
4363da138SBaptiste Daroussin.\" Redistribution and use in source and binary forms, with or without
5363da138SBaptiste Daroussin.\" modification, are permitted provided that the following conditions
6363da138SBaptiste Daroussin.\" are met:
7363da138SBaptiste Daroussin.\" 1. Redistributions of source code must retain the above copyright
8363da138SBaptiste Daroussin.\"    notice, this list of conditions and the following disclaimer.
9363da138SBaptiste Daroussin.\" 2. Redistributions in binary form must reproduce the above copyright
10363da138SBaptiste Daroussin.\"    notice, this list of conditions and the following disclaimer in the
11363da138SBaptiste Daroussin.\"    documentation and/or other materials provided with the distribution.
12363da138SBaptiste Daroussin.\"
13363da138SBaptiste Daroussin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14363da138SBaptiste Daroussin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15363da138SBaptiste Daroussin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16363da138SBaptiste Daroussin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17363da138SBaptiste Daroussin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18363da138SBaptiste Daroussin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19363da138SBaptiste Daroussin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20363da138SBaptiste Daroussin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21363da138SBaptiste Daroussin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22363da138SBaptiste Daroussin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23363da138SBaptiste Daroussin.\" SUCH DAMAGE.
24363da138SBaptiste Daroussin.\"
252d32cdcdSBaptiste Daroussin.Dd November 7, 2015
26363da138SBaptiste Daroussin.Dt SOELIM 1
27363da138SBaptiste Daroussin.Os
28363da138SBaptiste Daroussin.Sh NAME
29363da138SBaptiste Daroussin.Nm soelim
30b5d6933fSBaptiste Daroussin.Nd interpret .so requests in manpages
31363da138SBaptiste Daroussin.Sh SYNOPSIS
32363da138SBaptiste Daroussin.Nm
33363da138SBaptiste Daroussin.Op Fl Crtv
34363da138SBaptiste Daroussin.Op Fl I Ar dir
352d32cdcdSBaptiste Daroussin.Op Ar
36363da138SBaptiste Daroussin.Sh DESCRIPTION
372d32cdcdSBaptiste DaroussinThe
38363da138SBaptiste Daroussin.Nm
392d32cdcdSBaptiste Daroussinutility
402d32cdcdSBaptiste Daroussinreads the specified files or the standard input and performs the textual
412d32cdcdSBaptiste Daroussininclusion implied by the
42*20f68c5fSJens Schweikhardt.Xr nroff 1 Pq Pa ports/textproc/groff
432d32cdcdSBaptiste Daroussindirectives of the form:
44363da138SBaptiste Daroussin.Pp
452d32cdcdSBaptiste Daroussin.Dl \&.so anotherfile
462d32cdcdSBaptiste Daroussin.Pp
472d32cdcdSBaptiste DaroussinIf a line starts with:
48363da138SBaptiste Daroussin.Dq .so anotherfile
492d32cdcdSBaptiste Daroussinit replaces the line by processing
50363da138SBaptiste Daroussin.Dq anotherfile .
51363da138SBaptiste DaroussinOtherwise the line is printed to stdout.
52363da138SBaptiste Daroussin.Bl -tag -width "-I dir"
53363da138SBaptiste Daroussin.It Fl C
54b4a0618cSBaptiste DaroussinRecognise
55b4a0618cSBaptiste Daroussin.Em .so
562d32cdcdSBaptiste Daroussinwhen it is not followed by a space character.
57363da138SBaptiste Daroussin.It Fl r
582d32cdcdSBaptiste DaroussinCompatibility with groff's
59363da138SBaptiste Daroussin.Xr soelim 1
60363da138SBaptiste Daroussin(does nothing).
61363da138SBaptiste Daroussin.It Fl t
622d32cdcdSBaptiste DaroussinCompatibility with groff's
63363da138SBaptiste Daroussin.Xr soelim 1
64363da138SBaptiste Daroussin(does nothing).
65363da138SBaptiste Daroussin.It Fl v
662d32cdcdSBaptiste DaroussinCompatibility with groff's
67363da138SBaptiste Daroussin.Xr soelim 1
68363da138SBaptiste Daroussin(does nothing).
69363da138SBaptiste Daroussin.It Fl I Ar dir
702d32cdcdSBaptiste DaroussinThis option specifies directories where
71363da138SBaptiste Daroussin.Nm
72363da138SBaptiste Daroussinsearches for files (both those on the command line and those named in
73363da138SBaptiste Daroussin.Dq .so
74363da138SBaptiste Daroussindirective.)
752d32cdcdSBaptiste DaroussinThis option may be specified multiple times.
762d32cdcdSBaptiste DaroussinThe directories will be searched in the order specified.
77363da138SBaptiste Daroussin.El
78363da138SBaptiste Daroussin.Pp
79363da138SBaptiste DaroussinThe files are always searched first in the current directory.
80363da138SBaptiste Daroussin.Pp
81363da138SBaptiste DaroussinA file specified with an absolute path will be opened directly without
82363da138SBaptiste Daroussinperforming a search.
83363da138SBaptiste Daroussin.Sh SEE ALSO
84b5d6933fSBaptiste Daroussin.Xr mandoc 1
85b5d6933fSBaptiste Daroussin.Sh AUTHORS
86b5d6933fSBaptiste DaroussinThis version of the
87b5d6933fSBaptiste Daroussin.Nm
88b5d6933fSBaptiste Daroussinutility was written by
89b5d6933fSBaptiste Daroussin.An Baptiste Daroussin Aq Mt bapt@freebsd.org .
90