CATMAN
Section: December 15, 1992
(8)
Updated: ADMINISTRATION COMMANDS
Index
Return to Main Contents
NAME
catman - create the cat files for the manual
SYNOPSIS
catman [-nptw] [-M
path ]
[-T
macro-package ]
[
sections
]
DESCRIPTION
catman creates the preformatted versions of the on-line manual from the
nroff(1) input files.
Each manual page is examined and those whose preformatted versions are
missing or out of date are recreated.
If any changes are made, catman recreates the whatis database.
If there is one parameter not starting with a `-',
it is taken to be a list of manual sections to look in.
For example
-
catman 123
only updates manual sections 1, 2 and 3.
OPTIONS
- -n
-
Do not (re)create the whatis
database.
- -p
-
Print what would be done instead of doing it.
- -w
-
Only create the whatis database that is used by apropos(1), whatis(1)
and the man(1) -f and -k options. No manual reformatting is done.
-M
path
-
Change the search path for manual pages.
path
is a (semi)colon-separated list of subdirectories thar contain manual
page directory subtrees. For example, /usr/man;/usr/local/man makes
catman update both /usr/man and /usr/local/man. Each directory in the
path
is assumed to contain subdirectories of the form man[1-8] or cat[1-8].
-T
macro-package
-
catman tells nroff(1) to use
macro-package
rather than the standard -man macros defined in /usr/lib/tmac/tmac.an
for formatting manual pages.
ENVIRONMENT
- MANPATH
-
If set, its value overrides /usr/man as the default search path. (The -M
flag, in turn, overrides this value.)
FILES
- /usr/man
-
default manual directory location
- /usr/man/man?/*
-
raw (nroff input) manual sections
- /usr/man/cat?/*
-
preformatted nroffed manual pages
- /usr/man/whatis
-
whatis database location
SEE ALSO
apropos(1), man(1), nroff(1), whatis(1)
NOTES
If the -n option is specified, the /usr/man/whatis
database is not created and the apropos, whatis, `man -f' and `man -k'
commands will fail.
BUGS
catman has not been tested under TOS (only MiNT).
catman is not safe in respect to strings. A pathname that is too
long can therefore crash catman. The current limit is 255 characters,
which should be long enough for must purposes.
catman behaves differently from the UN*X version in several respects.
AUTHOR
Hildo Biersma (schuller@dutiag.tudelft.nl)
VERSION
This is version 0.2, the second released version.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- ENVIRONMENT
-
- FILES
-
- SEE ALSO
-
- NOTES
-
- BUGS
-
- AUTHOR
-
- VERSION
-
This document was created by
man2html,
using the manual pages.
Time: 23:26:11 GMT, January 03, 2023