usr.bin/catman/catman.1

   1 .\" Copyright (c) 2002 John Rochester
   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: src/usr.bin/catman/catman.1,v 1.3 2002/12/13 16:53:51 ru Exp $
  26 .\" $DragonFly: src/usr.bin/catman/catman.1,v 1.4 2008/11/02 18:29:07 swildner Exp $
  27 .\"
  28 .Dd November 1, 2008
  29 .Dt CATMAN 1
  30 .Os
  31 .Sh NAME
  32 .Nm catman
  33 .Nd "preformat man pages"
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl fLnrv
  37 .Op Ar directories ...
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 utility preformats all the man pages in
  42 .Ar directories
  43 using the
  44 .Nm nroff Fl man
  45 command.
  46 Directories may be separated by colons instead of spaces.
  47 If no
  48 .Ar directories
  49 are specified, the contents of the
  50 .Ev MANPATH
  51 environment variable is used, or if that is not set, the default directory
  52 .Pa /usr/share/man
  53 is processed.
  54 .Pp
  55 The options are as follows:
  56 .Bl -tag -width indent
  57 .It Fl f
  58 Force all man pages to be reformatted even if the corresponding cat page
  59 is newer.
  60 .It Fl L
  61 Process only localized subdirectories corresponding to the locale specified
  62 in the standard environment variables.
  63 .It Fl n
  64 Print out what would be done instead of performing any formatting.
  65 .It Fl r
  66 Scan for and remove
  67 .Dq junk
  68 files that are neither man pages nor their
  69 corresponding formatted cat pages.
  70 .It Fl v
  71 Cause
  72 .Nm
  73 to be more verbose about what it is doing.
  74 .El
  75 .Sh ENVIRONMENT
  76 .Bl -tag -width ".Ev MANPATH"
  77 .It Ev LC_ALL , LC_CTYPE , LANG
  78 These variables control what subdirectories will be processed if the
  79 .Fl L
  80 option is used.
  81 .It Ev MACHINE
  82 If set, overrides the current machine type when searching for
  83 machine specific man page subdirectories.
  84 .It Ev MANPATH
  85 Determines the set of directories to be processed if none are given on
  86 the command line.
  87 .El
  88 .Sh FILES
  89 .Bl -tag -width ".Pa /usr/share/man" -compact
  90 .It Pa /usr/share/man
  91 Default directory to process if the
  92 .Ev MANPATH
  93 environment variable is not set.
  94 .El
  95 .Sh EXIT STATUS
  96 .Ex -std
  97 .Sh SEE ALSO
  98 .Xr man 1 ,
  99 .Xr nroff 1 ,
 100 .Xr makewhatis 8
 101 .Sh HISTORY
 102 A previous version of the
 103 .Nm
 104 command appeared in
 105 .Fx 2.1 .
 106 .Sh AUTHORS
 107 .An John Rochester