date and time created 90/05/27 15:23:00 by bostic
[unix-history] / usr / src / usr.bin / man / man.conf.5
CommitLineData
882cb044
KS
1.\" Copyright (c) 1989 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms are permitted
5.\" provided that the above copyright notice and this paragraph are
6.\" duplicated in all such forms and that any documentation,
7.\" advertising materials, and other materials related to such
8.\" distribution and use acknowledge that the software was developed
9.\" by the University of California, Berkeley. The name of the
10.\" University may not be used to endorse or promote products derived
11.\" from this software without specific prior written permission.
12.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
13.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
14.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
15.\"
16.\" @(#)man.conf.5 5.1 (Berkeley) %G%
17.\"
18.TH MAN.CONF 5 ""
19.SH NAME
20man.conf \- man command's directory list
21.SH DESCRIPTION
22.IR Man (1)
23searches the directories specified in the
24.I man.conf
25file for manual pages to display.
26The
27.I man.conf
28file should contain a list of pathnames, one per line.
29Lines starting with whitespace or a hash character (``#'') are ignored.
30.PP
31Each of these directories should contain sub-directories of the form
32``cat#'', where the ``#'' should be a manual section number, i.e. ``1''
33through ``8'' or ``3f''.
34Each of these sub-directories may in turn have sub-directories of their
35own, per machine type, for example ``tahoe''.
36Manual pages should be pre-formatted (see
37.IR nroff (1))
38and stored in a file named with a trailing ``.0''.
39.PP
40For example, the
41.IR mktemp (3)
42manual page should be stored in ``cat3/mktemp.0''.
43A VAX specific version of it should be stored in ``cat3/vax/mktemp.0''.
44The FORTRAN version should be in ``cat3f/mktemp.0''.
45.FILE
46.SH FILES
47/etc/man.conf standard manual directory search path
48.SH "SEE ALSO"
49apropos(1), man(1), whatis(1), whereis(1)