catman.local(8) [freebsd man page]

MAKEWHATIS.LOCAL(8)					    BSD System Manager's Manual 				       MAKEWHATIS.LOCAL(8)

NAME

     makewhatis.local, catman.local -- start makewhatis or catman for local file systems

SYNOPSIS

     /usr/libexec/makewhatis.local [options] directories ...
     /usr/libexec/catman.local [options] directories ...

DESCRIPTION

     The makewhatis.local utility starts makewhatis(1) only for file systems physically mounted on the system where the makewhatis.local is being
     executed.	Running makewhatis by periodic weekly for rw nfs-mounted /usr may kill your NFS server -- all NFS clients start makewhatis at the
     same time!  So use this wrapper for cron(8) instead of calling makewhatis directly.  The catman.local utility is using for same purposes as
     makewhatis.local but for catman(1).

FILES

     /etc/periodic/weekly/320.whatis	  run makewhatis.local every week
     /etc/periodic/weekly/330.catman	  run catman.local every week

SEE ALSO

     catman(1), find(1), makewhatis(1), cron(8), periodic(8)

HISTORY

     The makewhatis.local utility appeared in FreeBSD 2.2.

BSD
								  April 26, 1996							       BSD

MAKEWHATIS(1)						    BSD General Commands Manual 					     MAKEWHATIS(1)

NAME

     makewhatis -- create whatis database

SYNOPSIS

     makewhatis [-a] [-i column] [-n name] [-o file] [-v] [-L] [directories ...]

DESCRIPTION

     The makewhatis utility collects the names and short descriptions from all the unformatted man pages in the directories and puts them into a
     file used by the whatis(1) and apropos(1) commands.  Directories may be separated by colons instead of spaces.  If no directories are speci-
     fied, the contents of the MANPATH environment variable will be used, or if that is not set, the default directory /usr/share/man will be pro-
     cessed.

     The options are as follows:

     -a 	Appends to the output file(s) instead of replacing them.  The output will be sorted with duplicate lines removed, but may have
		obsolete entries.

     -i column	Indents the description by column characters.  The default value is 24.

     -n name	Uses name instead of whatis.

     -o file	Outputs all lines to the file instead of */man/whatis.

     -v 	Makes makewhatis more verbose about what it is doing.

     -L 	Process only localized subdirectories corresponding to the locale specified in the standard environment variables.

ENVIRONMENT

     LC_ALL, LC_CTYPE, LANG
	      These variables control what subdirectories will be processed if the -L option is used.

     MACHINE  If set, its value is used to override the current machine type when searching machine specific subdirectories.

     MACHINE_ARCH
	      If set, its value is used to override the current architecture when searching architecture specific subdirectories.

     MANPATH  Determines the set of directories to be processed if none are given on the command line.

FILES

     /usr/share/man  Default directory to process if the MANPATH environment variable is not set.
     */man/whatis    The default output file.

EXIT STATUS

     The makewhatis utility exits 0 on success, and >0 if an error occurs.

SEE ALSO

     apropos(1), whatis(1)

HISTORY

     The makewhatis command appeared in FreeBSD 2.1.

AUTHORS

     The makewhatis program was originally written in Perl and was contributed by Wolfram Schneider.  The current version of makewhatis was
     rewritten in C by John Rochester.

BSD
								 December 3, 2005							       BSD