usr.bin/soelim/soelim.1

   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: head/usr.bin/soelim/soelim.1 290478 2015-11-07 01:58:23Z bapt $
  26 .\"
  27 .Dd November 7, 2015
  28 .Dt SOELIM 1
  29 .Os
  30 .Sh NAME
  31 .Nm soelim
  32 .Nd interpret .so requests in manpages
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl Crtv
  36 .Op Fl I Ar dir
  37 .Op Ar
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 utility
  42 reads the specified files or the standard input and performs the textual
  43 inclusion implied by the
  44 .Xr nroff 1
  45 directives of the form:
  46 .Pp
  47 .Dl \&.so anotherfile
  48 .Pp
  49 If a line starts with:
  50 .Dq .so anotherfile
  51 it replaces the line by processing
  52 .Dq anotherfile .
  53 Otherwise the line is printed to stdout.
  54 .Bl -tag -width "-I dir"
  55 .It Fl C
  56 Recognise
  57 .Em .so
  58 when it is not followed by a space character.
  59 .It Fl r
  60 Compatibility with groff's
  61 .Xr soelim 1
  62 (does nothing).
  63 .It Fl t
  64 Compatibility with groff's
  65 .Xr soelim 1
  66 (does nothing).
  67 .It Fl v
  68 Compatibility with groff's
  69 .Xr soelim 1
  70 (does nothing).
  71 .It Fl I Ar dir
  72 This option specifies directories where
  73 .Nm
  74 searches for files (both those on the command line and those named in
  75 .Dq .so
  76 directive.)
  77 This option may be specified multiple times.
  78 The directories will be searched in the order specified.
  79 .El
  80 .Pp
  81 The files are always searched first in the current directory.
  82 .Pp
  83 A file specified with an absolute path will be opened directly without
  84 performing a search.
  85 .Sh SEE ALSO
  86 .Xr mandoc 1
  87 .Sh AUTHORS
  88 This version of the
  89 .Nm
  90 utility was written by
  91 .An Baptiste Daroussin Aq Mt bapt@freebsd.org .