* doc/Makefile (clean): Include more index files.
[s-roff.git] / src / preproc / soelim / soelim.man
blob0d927f7719e3fe5df429b3aa6f0961f28056b45c
1 .ig \"-*- nroff -*-
2 Copyright (C) 1989-2000 Free Software Foundation, Inc.
4 Permission is granted to make and distribute verbatim copies of
5 this manual provided the copyright notice and this permission notice
6 are preserved on all copies.
8 Permission is granted to copy and distribute modified versions of this
9 manual under the conditions for verbatim copying, provided that the
10 entire resulting derived work is distributed under the terms of a
11 permission notice identical to this one.
13 Permission is granted to copy and distribute translations of this
14 manual into another language, under the above conditions for modified
15 versions, except that this permission notice may be included in
16 translations approved by the Free Software Foundation instead of in
17 the original English.
19 .TH @G@SOELIM @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
20 .SH NAME
21 @g@soelim \- interpret .so requests in groff input
22 .SH SYNOPSIS
23 .B @g@soelim
25 .B \-Cv
28 .BI \-I dir
31 .IR files \|.\|.\|.\|
33 .PP
34 It is possible to have whitespace between the
35 .B \-I
36 command line option and its parameter.
37 .SH DESCRIPTION
38 .B @g@soelim
39 reads
40 .I files
41 and replaces lines of the form
42 .IP
43 .BI .so\  file
44 .LP
45 by the contents of
46 .IR file .
47 It is useful if files included with
48 .B so
49 need to be preprocessed.
50 Normally,
51 .B @g@soelim
52 should be invoked with the
53 .B \-s
54 option of
55 .BR groff .
56 .SH OPTIONS
57 .TP
58 .B \-C
59 Recognize
60 .B .so
61 even when followed by a character other than space or newline.
62 .TP
63 .BI \-I dir
64 This option may be used to specify a directory to search for
65 files (both those on the command line and those named in
66 .B \&.so
67 lines).
68 The current directory is always searched first.
69 This option may be specified more than once,
70 the directories will be searched in the order specified.
71 No directory search is performed for files specified using an absolute path.
72 .TP
73 .B \-v
74 Print the version number.
75 .SH "SEE ALSO"
76 .BR groff (@MAN1EXT@)