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