summaryrefslogtreecommitdiffstats
path: root/man/man1/zsoelim.man1
blob: 599e46e109a800cc2f3f975e440b856a42490fca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
.\" Man page for %zsoelim%
.\"
.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the file docs/COPYING.GPLv2 that comes with the
.\" man-db distribution.
.\"
.\" Sat Dec 10 19:33:32 GMT 1994  Wilf. (G.Wilford@ee.surrey.ac.uk)
.\"
.pc
.TH %thzsoelim% 1 "%date%" "%version%" "Manual pager utils"
.SH NAME
%zsoelim% \- satisfy .so requests in roff input
.SH SYNOPSIS
.B %zsoelim%
.RB [\| \-CVh \|]
.RI [\| file
\&.\|.\|.\|]
.SH DESCRIPTION
.B %zsoelim%
parses
.I file
arguments, or if none are specified, its standard input for lines of the
form:

.B .so
.RI <\| filename \|>

These requests are replaced by the contents of the
.I filename
specified.
If the request cannot be met,
.B %zsoelim%
looks for
.I filename.ext
where
.I .ext
can be one of
.BR .gz ,
.B .Z
or
.BR .z .
Other extension types may be supported depending upon compile time options.
If the request can be met by a compressed file, this file is decompressed
using an appropriate decompressor and its output is used to satisfy
the request.

Traditionally,
.B soelim
programs were used to allow roff preprocessors to be able to preprocess the
files referred to by the requests.
This particular version was written to circumvent problems created by
support for compressed manual pages.
.SH OPTIONS
.TP
.if !'po4a'hide' .BR \-C ", " \-\-compatible
This flag is available for compatibility with other
.B soelim
programs.
Its use is to enable .so requests followed by something other than
whitespace.
As this is already the default behaviour, it is ignored.
.TP
.if !'po4a'hide' .BR \-h ", " \-\-help
Print a help message and exit.
.TP
.if !'po4a'hide' .BR \-V ", " \-\-version
Display version information.
.SH "SEE ALSO"
.if !'po4a'hide' .BR groff (1),
.if !'po4a'hide' .BR %man% (1),
.if !'po4a'hide' .BR nroff (1),
.if !'po4a'hide' .BR troff (1)
.SH AUTHOR
.nf
.if !'po4a'hide' Wilf.\& (G.Wilford@ee.surrey.ac.uk).
.if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org).
.if !'po4a'hide' Colin Watson (cjwatson@debian.org).
.fi
.SH BUGS
.if !'po4a'hide' https://gitlab.com/man-db/man-db/-/issues
.br
.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db