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