*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->FreeBSD man pages -> makewhatis (1)              



NAME    [Toc]    [Back]

     makewhatis -- create whatis database

SYNOPSIS    [Toc]    [Back]

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

DESCRIPTION    [Toc]    [Back]

     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 specified, the
     contents of the MANPATH environment variable will be used, or if that is
     not set, the default directory /usr/share/man will be processed.

     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    [Toc]    [Back]

	      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.

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

FILES    [Toc]    [Back]

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

DIAGNOSTICS    [Toc]    [Back]

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

SEE ALSO    [Toc]    [Back]

     apropos(1), whatis(1)

HISTORY    [Toc]    [Back]

     The makewhatis command appeared in FreeBSD 2.1.

AUTHORS    [Toc]    [Back]

     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.

FreeBSD 5.2.1			 May 12, 2002			 FreeBSD 5.2.1
[ Back ]
 Similar pages
Name OS Title
makewhatis OpenBSD create a whatis.db database
apropos FreeBSD search the whatis database
whatis FreeBSD search the whatis database
makewhatis IRIX make manual page "whatis" database for use with apropos
catman Tru64 Creates or rebuilds formatted reference pages and the whatis database
getNAME OpenBSD get NAME sections from manual source for whatis/apropos data base
dev_mkdb OpenBSD create /dev database
makedbm OpenBSD create a YP database
kvm_mkdb OpenBSD create kernel database
newkey FreeBSD create a new key in the publickey database
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service