gnu/usr.bin/man/catman/catman.1

   1 .\" Copyright (c) March 1996 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
   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 .\" /usr/bin/catman - preformat man pages
  26 .\"
  27 .\" $FreeBSD: src/gnu/usr.bin/man/catman/catman.1,v 1.17.2.6 2001/07/22 11:01:25 dd Exp $
  28 .Dd March 12, 1995
  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 f | Fl force
  37 .Op Fl h | Fl help
  38 .Op Fl L | Fl locale
  39 .Op Fl p | Fl print
  40 .Op Fl r | Fl remove
  41 .Op Fl v | Fl verbose
  42 .Op Ar directories ...
  43 .Sh DESCRIPTION
  44 .Nm Catman
  45 format man pages to ASCII.  It's like typing
  46 .Sq man program
  47 for all man pages in
  48 .Ar directories .
  49 .Ar Directories
  50 is a list of man directories or subdirectories separated
  51 by spaces or colons.
  52 Use
  53 .Ar /usr/share/man
  54 if no
  55 .Ar directories
  56 defined.
  57 .Sh OPTIONS
  58 .Bl -tag -width Ds
  59 .It Fl f , Fl force
  60 Force overwriting old cat pages.  Normally only those pages will be formatted
  61 which are not up to date.  This option is a waste of time, CPU and RAM.
  62 .It Fl h , Fl help
  63 Print options and exit.
  64 .It Fl L , Fl locale
  65 Sense locale environment variables for possible localized man subdirectories
  66 and process these entries only.
  67 .It Fl p , Fl print
  68 Don't actually format man pages. Show what would be done.
  69 .It Fl r , Fl remove
  70 Remove garbage, e.\& g. catpage without manpage, uncompressed catpage but
  71 a compressed catpage exist, filenames with non-alphanumeric
  72 characters, uncompressed manpage but a compressed manpage exist.
  73 .It Fl v , Fl verbose
  74 More warnings.
  75 .El
  76 .Sh EXAMPLES
  77 .Dl $ catman
  78 .Pp
  79 Format man pages in
  80 .Ar /usr/share/man
  81 if necessary.
  82 .Pp
  83 .Dl $ catman $MANPATH
  84 .Pp
  85 Format all your man pages if necessary.
  86 .Pp
  87 .Dl $ catman -f /usr/local/man/man1 /usr/local/man/manl
  88 .Pp
  89 Force reformatting of all man pages in
  90 .Pa /usr/local/man/man1
  91 and
  92 .Pa /usr/local/man/manl .
  93 .Pp
  94 .Dl $ catman -p /usr/X11/man
  95 .Pp
  96 Show only.
  97 .Sh FILES
  98 .Bl -tag -width /etc/periodic/weekly/330.catman
  99 .It Pa /etc/periodic/weekly/330.catman
 100 Starts this program
 101 .El
 102 .Sh FEATURES
 103 Very fast if all man pages already formatted.
 104 Does not support the
 105 .Fl w
 106 option as some other systems do.  Use
 107 .Xr makewhatis 1
 108 to rebuild the
 109 .Ql whatis
 110 database.
 111 .Sh BUGS
 112 .Xr man 1
 113 is a setuid program.  Be careful that user
 114 .Sq man
 115 has write permissions to the catman directories.
 116 .Nm Catman
 117 does not check for any
 118 .Sq .so
 119 in man page sources.  Use hard or symlinks
 120 to avoid redundant formatted man pages.
 121 .Sh SEE ALSO
 122 .Xr makewhatis 1 ,
 123 .Xr man 1 ,
 124 .Xr manpath 1
 125 .Sh HISTORY
 126 This version of
 127 .Nm
 128 command appeared in
 129 .Fx 2.1 .
 130 .Sh AUTHORS
 131 .An Wolfram Schneider Aq wosch@FreeBSD.org ,
 132 Berlin.