BSD 4_3_Reno development

[unix-history] / usr / share / man / cat5 / man.conf.0

MAN.CONF(5)                   1990                    MAN.CONF(5)



N\bNA\bAM\bME\bE
    man.conf - man command's configuration file

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
    _\bM_\ba_\bn(1), _\ba_\bp_\br_\bo_\bp_\bo_\bs(1), and _\bw_\bh_\ba_\bt_\bi_\bs(1) search for manual pages or
    their database files as specified by the _\bm_\ba_\bn._\bc_\bo_\bn_\bf file.
    Manual pages are expected to be preformatted (see _\bn_\br_\bo_\bf_\bf(1))
    and named with a trailing ``.0''.

    The _\bm_\ba_\bn._\bc_\bo_\bn_\bf file contains two types of lines.

    The first type of line is a ``section'' line, which contains
    a section name followed by a directory path.  Lines in this
    format specify that manual pages for the section may be
    found in the directory.

    Directories named with a trailing slash character (``/'')
    are expected to contain subdirectories (see the keyword
    ``_subdir'' below) instead of manual pages.  These subdirec-
    tories are searched instead of the directory.

    All directories (either explicitly specified or named with a
    trailing slash) may contain subdirectories.  _\bM_\ba_\bn(1) automat-
    ically searches any subdirectory with the same name as the
    current machine type before the directory is searched.  No
    specification of these subdirectories is necessary in the
    _\bm_\ba_\bn._\bc_\bo_\bn_\bf file.

    Section names are unrestricted except for the reserved words
    specified below; in general, however, it is best to avoid
    anything beginning with an underscore (``_'') in order to
    avoid future incompatibilities.

    The section named ``_default'' is the list of directories to
    be searched if no section is specified.

    The second type of line is preceded with a ``keyword''.  The
    possible keywords and their meanings are as follows:


    _subdir
         The list (in search order) of subdirectories which will
         be searched in any directory named with a trailing
         slash (``/'') character.

    _version
         The version of the configuration file.

    _whatdb
         The full pathname (not just a directory path) for a
         database to be used by the _\ba_\bp_\br_\bo_\bp_\bo_\bs(1) and _\bw_\bh_\ba_\bt_\bi_\bs(1)
         commands.



Printed 6/26/90               June                              1






MAN.CONF(5)                   1990                    MAN.CONF(5)



    Multiple specifications for all types of lines (except for
    ``_version'') are cumulative and the entries are used in the
    order listed in the file; multiple entries may be listed per
    line, as well.

    Empty lines or lines whose first non-whitespace character is
    a hash mark (``#'') are ignored.

E\bEX\bXA\bAM\bMP\bPL\bLE\bES\bS
    Given the following _\bm_\ba_\bn._\bc_\bo_\bn_\bf _\bf_\bi_\bl_\be:

         _version       BSD.1
         _subdir        cat1 cat2 cat3
         _default       /usr/share/man/
         sect3          /usr/share/man/cat3

    The default _\bm_\bk_\bt_\be_\bm_\bp(3) manual page should be stored in
    ``/usr/share/man/cat3/mktemp.0''.  Any VAX architecture
    specific version of it should be stored in
    ``cat3/vax/mktemp.0''.

    The command ``man mktemp'' would search the subdirectories
    ``cat1'' ``cat2'', and ``cat3'', in ``/usr/share/man'', in
    that order, for ``mktemp.0''.  If a subdirectory with the
    same name as the current machine type existed in any of
    them, it would be searched as well.

    The command ``man sect3 mktemp'' would only search
    ``/usr/share/man/cat3'' and any possible per machine sub-
    directory.

F\bFI\bIL\bLE\bES\bS
    /etc/man.conf  standard manual directory search path

S\bSE\bEE\bE A\bAL\bLS\bSO\bO
    apropos(1), machine(1), man(1), whatis(1), whereis(1)



















Printed 6/26/90               June                              2