xref: /netbsd-src/external/bsd/mdocml/dist/soelim.1 (revision c9bcef0391a5afc0280459d5c16c26ace267c496)
1*c9bcef03Schristos.\"	Id: soelim.1,v 1.5 2017/07/04 23:40:01 schwarze Exp
29ff1f2acSchristos.\"
39ff1f2acSchristos.\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
49ff1f2acSchristos.\" All rights reserved.
59ff1f2acSchristos.\"
69ff1f2acSchristos.\" Redistribution and use in source and binary forms, with or without
79ff1f2acSchristos.\" modification, are permitted provided that the following conditions
89ff1f2acSchristos.\" are met:
99ff1f2acSchristos.\" 1. Redistributions of source code must retain the above copyright
109ff1f2acSchristos.\"    notice, this list of conditions and the following disclaimer.
119ff1f2acSchristos.\" 2. Redistributions in binary form must reproduce the above copyright
129ff1f2acSchristos.\"    notice, this list of conditions and the following disclaimer in the
139ff1f2acSchristos.\"    documentation and/or other materials provided with the distribution.
149ff1f2acSchristos.\"
159ff1f2acSchristos.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
169ff1f2acSchristos.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
179ff1f2acSchristos.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
189ff1f2acSchristos.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
199ff1f2acSchristos.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
209ff1f2acSchristos.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
219ff1f2acSchristos.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
229ff1f2acSchristos.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
239ff1f2acSchristos.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
249ff1f2acSchristos.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
259ff1f2acSchristos.\" SUCH DAMAGE.
269ff1f2acSchristos.\"
27*c9bcef03Schristos.Dd July 4, 2017
289ff1f2acSchristos.Dt SOELIM 1
299ff1f2acSchristos.Os
309ff1f2acSchristos.Sh NAME
319ff1f2acSchristos.Nm soelim
329ff1f2acSchristos.Nd interpret .so requests in manpages
339ff1f2acSchristos.Sh SYNOPSIS
349ff1f2acSchristos.Nm
359ff1f2acSchristos.Op Fl Crtv
369ff1f2acSchristos.Op Fl I Ar dir
379ff1f2acSchristos.Op Ar files ...
389ff1f2acSchristos.Sh DESCRIPTION
399ff1f2acSchristos.Nm
409ff1f2acSchristosreads
419ff1f2acSchristos.Ar files
429ff1f2acSchristoslines by lines.
439ff1f2acSchristos.Pp
449ff1f2acSchristosIf a line starts by:
459ff1f2acSchristos.Dq .so anotherfile
469ff1f2acSchristosit replace the line by processing
479ff1f2acSchristos.Dq anotherfile .
489ff1f2acSchristosOtherwise the line is printed to stdout.
499ff1f2acSchristos.Bl -tag -width "-I dir"
509ff1f2acSchristos.It Fl C
519ff1f2acSchristosRecognise
529ff1f2acSchristos.Em .so
539ff1f2acSchristoswhen not followed by a space character.
549ff1f2acSchristos.It Fl r
559ff1f2acSchristosCompatibility with GNU groff's
56*c9bcef03Schristos.Nm soelim
579ff1f2acSchristos(does nothing).
589ff1f2acSchristos.It Fl t
599ff1f2acSchristosCompatibility with GNU groff's
60*c9bcef03Schristos.Nm soelim
619ff1f2acSchristos(does nothing).
629ff1f2acSchristos.It Fl v
639ff1f2acSchristosCompatibility with GNU groff's
64*c9bcef03Schristos.Nm soelim
659ff1f2acSchristos(does nothing).
669ff1f2acSchristos.It Fl I Ar dir
679ff1f2acSchristosThis option specify directories where
689ff1f2acSchristos.Nm
699ff1f2acSchristossearches for files (both those on the command line and those named in
709ff1f2acSchristos.Dq .so
719ff1f2acSchristosdirective.)
72*c9bcef03SchristosThis options may be specified multiple times.
73*c9bcef03SchristosThe directories will be searched in the order specified.
749ff1f2acSchristos.El
759ff1f2acSchristos.Pp
769ff1f2acSchristosThe files are always searched first in the current directory.
779ff1f2acSchristos.Pp
789ff1f2acSchristosA file specified with an absolute path will be opened directly without
799ff1f2acSchristosperforming a search.
809ff1f2acSchristos.Sh SEE ALSO
819ff1f2acSchristos.Xr mandoc 1
829ff1f2acSchristos.Sh AUTHORS
839ff1f2acSchristosThis version of the
849ff1f2acSchristos.Nm
859ff1f2acSchristosutility was written by
869ff1f2acSchristos.An Baptiste Daroussin Aq Mt bapt@freebsd.org .
87