Annotation of mandoc/soelim.1, Revision 1.1.1.1
1.1 schwarze 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: .\" $FreeBSD$
26: .\"
27: .Dd May 1, 2015
28: .Dt SOELIM 1
29: .Os
30: .Sh NAME
31: .Nm soelim
32: .Nd interpret .so directive in manpages
33: .Sh SYNOPSIS
34: .Nm
35: .Op Fl Crtv
36: .Op Fl I Ar dir
37: .Op Ar files ...
38: .Sh DESCRIPTION
39: .Nm
40: reads
41: .Ar files
42: lines by lines.
43: .Pp
44: If a line starts by:
45: .Dq .so anotherfile
46: it replace the line by processing
47: .Dq anotherfile .
48: Otherwise the line is printed to stdout.
49: .Bl -tag -width "-I dir"
50: .It Fl C
51: Recognise
52: .Em .so
53: when not followed by a space character.
54: .It Fl r
55: Compatibility with GNU groff's
56: .Xr soelim 1
57: (does nothing).
58: .It Fl t
59: Compatibility with GNU groff's
60: .Xr soelim 1
61: (does nothing).
62: .It Fl v
63: Compatibility with GNU groff's
64: .Xr soelim 1
65: (does nothing).
66: .It Fl I Ar dir
67: This option specify directories where
68: .Nm
69: searches for files (both those on the command line and those named in
70: .Dq .so
71: directive.)
72: This options may be specified multiple times. The directories will be searched
73: in the order specified.
74: .El
75: .Pp
76: The files are always searched first in the current directory.
77: .Pp
78: A file specified with an absolute path will be opened directly without
79: performing a search.
80: .Sh SEE ALSO
81: .Xr mandoc 1 ,
82: .Xr soelim 1
CVSweb