summaryrefslogtreecommitdiffstats
path: root/soelim.1
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2015-05-20 20:55:04 +0000
committerIngo Schwarze <schwarze@openbsd.org>2015-05-20 20:55:04 +0000
commit77dfa06b4b522e2904138dd90d9b4fb4dd301fd6 (patch)
tree1cd2cbc409eb20efc455d85d2e65c6ec989fcf28 /soelim.1
parent843bd6231811b6e5d6963a17f5792b4f18817ca0 (diff)
downloadmandoc-77dfa06b4b522e2904138dd90d9b4fb4dd301fd6.tar.gz
Initial revision
Diffstat (limited to 'soelim.1')
-rw-r--r--soelim.182
1 files changed, 82 insertions, 0 deletions
diff --git a/soelim.1 b/soelim.1
new file mode 100644
index 00000000..b6ec13c1
--- /dev/null
+++ b/soelim.1
@@ -0,0 +1,82 @@
+.\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd May 1, 2015
+.Dt SOELIM 1
+.Os
+.Sh NAME
+.Nm soelim
+.Nd interpret .so directive in manpages
+.Sh SYNOPSIS
+.Nm
+.Op Fl Crtv
+.Op Fl I Ar dir
+.Op Ar files ...
+.Sh DESCRIPTION
+.Nm
+reads
+.Ar files
+lines by lines.
+.Pp
+If a line starts by:
+.Dq .so anotherfile
+it replace the line by processing
+.Dq anotherfile .
+Otherwise the line is printed to stdout.
+.Bl -tag -width "-I dir"
+.It Fl C
+Recognise
+.Em .so
+when not followed by a space character.
+.It Fl r
+Compatibility with GNU groff's
+.Xr soelim 1
+(does nothing).
+.It Fl t
+Compatibility with GNU groff's
+.Xr soelim 1
+(does nothing).
+.It Fl v
+Compatibility with GNU groff's
+.Xr soelim 1
+(does nothing).
+.It Fl I Ar dir
+This option specify directories where
+.Nm
+searches for files (both those on the command line and those named in
+.Dq .so
+directive.)
+This options may be specified multiple times. The directories will be searched
+in the order specified.
+.El
+.Pp
+The files are always searched first in the current directory.
+.Pp
+A file specified with an absolute path will be opened directly without
+performing a search.
+.Sh SEE ALSO
+.Xr mandoc 1 ,
+.Xr soelim 1