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