version 1.1, 2015/03/27 00:18:14 |
version 1.7, 2020/02/10 14:13:24 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2015 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2015, 2017 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm man.conf |
.Nm man.conf |
.Nd configuration file for man(1) |
.Nd configuration file for man |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
This is the configuration file |
.Nm |
for the |
configuration file allows to specify non-standard directory trees |
|
for use by the |
|
.Xr man 1 , |
.Xr man 1 , |
.Xr apropos 1 , |
.Xr apropos 1 , |
and |
and |
.Xr makewhatis 8 |
.Xr makewhatis 8 |
utilities. |
utilities. |
Its presence and all directives are optional. |
Its presence, and all directives, are optional. |
.Pp |
.Pp |
This file is an ASCII text file. |
This file is an ASCII text file. |
Leading whitespace on lines, lines starting with |
Leading whitespace on lines, lines starting with |
Line 42 The first word on each line is the name of a configura |
|
Line 40 The first word on each line is the name of a configura |
|
The following directives are supported: |
The following directives are supported: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Ic manpath Ar path |
.It Ic manpath Ar path |
Specify that the absolute |
Override the default search |
.Ar path |
.Ar path |
contains a tree of manual pages, and that |
for |
.Xr man 1 , |
.Xr man 1 , |
.Xr apropos 1 , |
.Xr apropos 1 , |
and |
and |
.Xr makewhatis 8 |
.Xr makewhatis 8 . |
shall use it by default. |
It can be used multiple times to specify multiple paths, |
Each such tree is supposed to contain subdirectories |
with the order determining the manual page search order. |
|
.Pp |
|
Each path is a tree containing subdirectories |
whose names consist of the strings |
whose names consist of the strings |
.Sq man |
.Sq man |
and/or |
and/or |
Line 60 The former are supposed to contain unformatted manual |
|
Line 60 The former are supposed to contain unformatted manual |
|
.Xr mdoc 7 |
.Xr mdoc 7 |
and/or |
and/or |
.Xr man 7 |
.Xr man 7 |
format; file names are supposed to end with the name of the section |
format; file names should end with the name of the section |
preceded by a dot. |
preceded by a dot. |
The latter are supposed to contain preformatted manual pages; |
The latter should contain preformatted manual pages; |
file names are supposed to end with |
file names should end with |
.Ql .0 . |
.Ql .0 . |
|
.Pp |
Creating a |
Creating a |
.Xr mandoc.db 5 |
.Xr mandoc.db 5 |
database with |
database with |
Line 73 in each directory configured with |
|
Line 74 in each directory configured with |
|
.Ic manpath |
.Ic manpath |
is recommended and necessary for |
is recommended and necessary for |
.Xr apropos 1 |
.Xr apropos 1 |
to work, but not strictly required for |
to work, and also for |
.Xr man 1 . |
.Xr man 1 |
|
on operating systems like |
|
.Ox |
|
that install each manual page with only one file name in the file system, |
|
even if it documents multiple utilities or functions. |
|
.It Ic output Ar option Op Ar value |
|
Configure the default value of an output option. |
|
These directives are overridden by the |
|
.Fl O |
|
command line options of the same names. |
|
For details, see the |
|
.Xr mandoc 1 |
|
manual. |
.Pp |
.Pp |
Specifying at least one |
.Bl -column fragment integer "ascii, utf8" -compact |
.Ic manpath |
.It Ar option Ta Ar value Ta used by Fl T Ta purpose |
directive does not append to the default search path |
.It Ta Ta Ta |
but instead overrides it. |
.It Ic fragment Ta none Ta Cm html Ta print only body |
The order of |
.It Ic includes Ta string Ta Cm html Ta path to header files |
.Ic manpath |
.It Ic indent Ta integer Ta Cm ascii , utf8 Ta left margin |
directives determines the manual page search order. |
.It Ic man Ta string Ta Cm html Ta path for \&Xr links |
|
.It Ic paper Ta string Ta Cm ps , pdf Ta paper size |
|
.It Ic style Ta string Ta Cm html Ta CSS file |
|
.It Ic toc Ta none Ta Cm html Ta print table of contents |
|
.It Ic width Ta integer Ta Cm ascii , utf8 Ta right margin |
|
.El |
.It Ic _whatdb Ar path Ns Cm /whatis.db |
.It Ic _whatdb Ar path Ns Cm /whatis.db |
This directive provides the same functionality as |
This directive provides the same functionality as |
.Ic manpath , |
.Ic manpath , |
Line 91 It is kept for backward compatibility for now, |
|
Line 109 It is kept for backward compatibility for now, |
|
but will eventually be removed. |
but will eventually be removed. |
.El |
.El |
.Sh FILES |
.Sh FILES |
.Pa /etc/man.conf |
.Bl -tag -width /etc/examples/man.conf -compact |
|
.It Pa /etc/man.conf |
|
.El |
.Sh EXAMPLES |
.Sh EXAMPLES |
The following configuration file reproduces the defaults: |
The following configuration file reproduces the defaults: |
Installing it is equivalent to not having a file |
installing it is equivalent to not having a |
.Nm |
.Nm |
at all. |
file at all. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
manpath /usr/share/man |
manpath /usr/share/man |
manpath /usr/X11R6/man |
manpath /usr/X11R6/man |