Return to man.conf.5 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/man.conf.5, Revision 1.1

1.1     ! schwarze    1: .\"    $Id: man.conf.5,v 1.1 2015/03/26 23:45:37 schwarze Exp $
        !             2: .\"
        !             3: .\" Copyright (c) 2015 Ingo Schwarze <schwarze@openbsd.org>
        !             4: .\"
        !             5: .\" Permission to use, copy, modify, and distribute this software for any
        !             6: .\" purpose with or without fee is hereby granted, provided that the above
        !             7: .\" copyright notice and this permission notice appear in all copies.
        !             8: .\"
        !             9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
        !            10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
        !            11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
        !            12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
        !            13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
        !            14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
        !            15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
        !            16: .\"
        !            17: .Dd $Mdocdate: March 26 2015 $
        !            18: .Dt MAN.CONF 5
        !            19: .Os
        !            20: .Sh NAME
        !            21: .Nm man.conf
        !            22: .Nd configuration file for man(1)
        !            23: .Sh DESCRIPTION
        !            24: The
        !            25: .Nm
        !            26: configuration file allows to specify non-standard directory trees
        !            27: for use by the
        !            28: .Xr man 1 ,
        !            29: .Xr apropos 1 ,
        !            30: and
        !            31: .Xr makewhatis 8
        !            32: utilities.
        !            33: Its presence and all directives are optional.
        !            34: .Pp
        !            35: This file is an ASCII text file.
        !            36: Leading whitespace on lines, lines starting with
        !            37: .Sq # ,
        !            38: and blank lines are ignored.
        !            39: Words are separated by whitespace.
        !            40: The first word on each line is the name of a configuration directive.
        !            41: .Pp
        !            42: The following directives are supported:
        !            43: .Bl -tag -width Ds
        !            44: .It Ic manpath Ar path
        !            45: Specify that the absolute
        !            46: .Ar path
        !            47: contains a tree of manual pages, and that
        !            48: .Xr man 1 ,
        !            49: .Xr apropos 1 ,
        !            50: and
        !            51: .Xr makewhatis 8
        !            52: shall use it by default.
        !            53: Each such tree is supposed to contain subdirectories
        !            54: whose names consist of the strings
        !            55: .Sq man
        !            56: and/or
        !            57: .Sq cat
        !            58: followed by the names of sections, usually single digits.
        !            59: The former are supposed to contain unformatted manual pages in
        !            60: .Xr mdoc 7
        !            61: and/or
        !            62: .Xr man 7
        !            63: format; file names are supposed to end with the name of the section
        !            64: preceded by a dot.
        !            65: The latter are supposed to contain preformatted manual pages;
        !            66: file names are supposed to end with
        !            67: .Ql .0 .
        !            68: Creating a
        !            69: .Xr mandoc.db 5
        !            70: database with
        !            71: .Xr makewhatis 8
        !            72: in each directory configured with
        !            73: .Ic manpath
        !            74: is recommended and necessary for
        !            75: .Xr apropos 1
        !            76: to work, but not strictly required for
        !            77: .Xr man 1 .
        !            78: .Pp
        !            79: Specifying at least one
        !            80: .Ic manpath
        !            81: directive does not append to the default search path
        !            82: but instead overrides it.
        !            83: The order of
        !            84: .Ic manpath
        !            85: directives determines the manual page search order.
        !            86: .It Ic _whatdb Ar path Ns Cm /whatis.db
        !            87: This directive provides the same functionality as
        !            88: .Ic manpath ,
        !            89: but using a historic and misleading syntax.
        !            90: It is kept for backward compatibility for now,
        !            91: but will eventually be removed.
        !            92: .El
        !            93: .Sh FILES
        !            94: .Pa /etc/man.conf
        !            95: .Sh EXAMPLES
        !            96: The following configuration file reproduces the defaults:
        !            97: Installing it is equivalent to not having a file
        !            98: .Nm
        !            99: at all.
        !           100: .Bd -literal -offset indent
        !           101: manpath /usr/share/man
        !           102: manpath /usr/X11R6/man
        !           103: manpath /usr/local/man
        !           104: .Ed
        !           105: .Sh SEE ALSO
        !           106: .Xr apropos 1 ,
        !           107: .Xr man 1 ,
        !           108: .Xr makewhatis 8
        !           109: .Sh HISTORY
        !           110: A relatively complicated
        !           111: .Nm
        !           112: file format first appeared in
        !           113: .Bx 4.3 Reno .
        !           114: For
        !           115: .Ox 5.8 ,
        !           116: it was redesigned from scratch, aiming for simplicity.
        !           117: .Sh AUTHORS
        !           118: .An Ingo Schwarze Aq Mt schwarze@openbsd.org