Return to whatis.1 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / usr.bin / man / whatis

Annotation of 43BSDReno/usr.bin/man/whatis/whatis.1, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1989, 1990 The Regents of the University of California.
                      2: .\" Copyright (c) 1990 The Regents of the University of California.
                      3: .\" All rights reserved.
                      4: .\"
                      5: .\" Redistribution and use in source and binary forms are permitted provided
                      6: .\" that: (1) source distributions retain this entire copyright notice and
                      7: .\" comment, and (2) distributions including binaries display the following
                      8: .\" acknowledgement:  ``This product includes software developed by the
                      9: .\" University of California, Berkeley and its contributors'' in the
                     10: .\" documentation or other materials provided with the distribution and in
                     11: .\" all advertising materials mentioning features or use of this software.
                     12: .\" Neither the name of the University nor the names of its contributors may
                     13: .\" be used to endorse or promote products derived from this software without
                     14: .\" specific prior written permission.
                     15: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     16: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     17: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     18: .\"
                     19: .\"     @(#)whatis.1   6.7 (Berkeley) 6/24/90
                     20: .\"
                     21: .TH WHATIS 1 "%Q"
                     22: .UC 4
                     23: .SH NAME
                     24: whatis \- describe what a command is
                     25: .SH SYNOPSIS
                     26: .nf
                     27: .ft B
                     28: whatis [-M path] [-m path] command ...
                     29: .ft R
                     30: .fi
                     31: .SH DESCRIPTION
                     32: .I Whatis
                     33: looks up a given command and gives the header line from the manual page.
                     34: You can then use the
                     35: .IR man (1)
                     36: command to get more information.
                     37: .PP
                     38: The options are as follows:
                     39: .TP
                     40: .I M
                     41: Override the list of standard directories where
                     42: .I whatis
                     43: searches for its database named ``whatis.db''.
                     44: The supplied
                     45: .I path
                     46: must be a colon (``:'') separated list of directories.
                     47: This search path may also be set using the environment variable
                     48: .IR MANPATH .
                     49: .TP
                     50: .I m
                     51: Augment the list of standard directories where
                     52: .I whatis
                     53: searches for its database named ``whatis.db''.
                     54: The supplied
                     55: .I path
                     56: must be a colon (``:'') separated list of directories.
                     57: These directories will be searched before the standard directories
                     58: or the directories supplied with the
                     59: .I M
                     60: option or the
                     61: .I MANPATH
                     62: environment variable are searched.
                     63: .SH ENVIRONMENT
                     64: .TP
                     65: .I MANPATH
                     66: The standard search path used by
                     67: .I man
                     68: may be overridden by specifying a path in the
                     69: .I MANPATH
                     70: environment variable.
                     71: The format of the path is a colon (``:'') separated list of directories.
                     72: .SH FILES
                     73: whatis.db              name of the whatis database
                     74: .SH "SEE ALSO"
                     75: apropos(1), man(1), whereis(1)

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.