contrib/groff/src/preproc/soelim/soelim.man

   1 .ig
   2 Copyright (C) 1989-2000, 2001 Free Software Foundation, Inc.
   3
   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.
   7
   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.
  12
  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.
  18 ..
  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
  24 [
  25 .B \-Cv
  26 ]
  27 [
  28 .BI \-I dir
  29 ]
  30 [
  31 .IR files \|.\|.\|.\|
  32 ]
  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 .PP
  57 Note that there must be no whitespace between the leading dot and
  58 the two characters `s' and `o'.  Otherwise, only
  59 .B groff
  60 interprets the
  61 .B .so
  62 request (and
  63 .B soelim
  64 ignores it).
  65 .SH OPTIONS
  66 .TP
  67 .B \-C
  68 Recognize
  69 .B .so
  70 even when followed by a character other than space or newline.
  71 .TP
  72 .BI \-I dir
  73 This option may be used to specify a directory to search for
  74 files (both those on the command line and those named in
  75 .B \&.so
  76 lines).
  77 The current directory is always searched first.
  78 This option may be specified more than once,
  79 the directories will be searched in the order specified.
  80 No directory search is performed for files specified using an absolute path.
  81 .TP
  82 .B \-v
  83 Print the version number.
  84 .SH "SEE ALSO"
  85 .BR groff (@MAN1EXT@)
  86 .
  87 .\" Local Variables:
  88 .\" mode: nroff
  89 .\" End: