Bump date for previous.
New sentence, new line. Remove trailing whitespace.
This commit is contained in:
wiz
parent
afd4fdef89
commit
3aec927b7b
@ -1,4 +1,4 @@
|
||||
.\" $NetBSD: man.conf.5,v 1.18 2006/04/10 16:20:46 chuck Exp $
|
||||
.\" $NetBSD: man.conf.5,v 1.19 2006/04/13 21:15:50 wiz Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1989, 1991, 1993
|
||||
.\" The Regents of the University of California. All rights reserved.
|
||||
@ -29,7 +29,7 @@
|
||||
.\"
|
||||
.\" @(#)man.conf.5 8.5 (Berkeley) 1/2/94
|
||||
.\"
|
||||
.Dd June 26, 2001
|
||||
.Dd April 10, 2006
|
||||
.Dt MAN.CONF 5
|
||||
.Os
|
||||
.Sh NAME
|
||||
@ -38,13 +38,13 @@
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
file contains the default configuration used by
|
||||
file contains the default configuration used by
|
||||
.Xr man 1 ,
|
||||
.Xr apropos 1 ,
|
||||
.Xr whatis 1 ,
|
||||
.Xr catman 8 ,
|
||||
and
|
||||
.Xr makewhatis 8
|
||||
.Xr makewhatis 8
|
||||
to find manual pages and information about manual pages (e.g. the
|
||||
whatis database).
|
||||
.Pp
|
||||
@ -52,28 +52,28 @@ Manual pages are located by searching an ordered set of directories
|
||||
called the
|
||||
.Dq man path
|
||||
for a file that matches the name of the requested page.
|
||||
Each directory in the search path usually has a set of subdirectories
|
||||
Each directory in the search path usually has a set of subdirectories
|
||||
in it (though this is not required).
|
||||
When subdirectories are used, there are normally two subdirectories
|
||||
for each section of the manual.
|
||||
One subdirectory contains formatted copies of that section's manual
|
||||
pages that can be directly displayed to a terminal, while the other
|
||||
section subdirectory contains unformatted copies of the pages (see
|
||||
.Xr nroff 1
|
||||
pages that can be directly displayed to a terminal, while the other
|
||||
section subdirectory contains unformatted copies of the pages (see
|
||||
.Xr nroff 1
|
||||
and
|
||||
.Xr mdoc 7 ) .
|
||||
Formatted manual pages are normally named with a trailing
|
||||
.Dq \.0
|
||||
.Dq \.0
|
||||
suffix.
|
||||
.Pp
|
||||
The
|
||||
.Nm
|
||||
file contains comment and configuration lines. Comment lines start with
|
||||
the
|
||||
file contains comment and configuration lines.
|
||||
Comment lines start with the
|
||||
.Dq #
|
||||
character.
|
||||
Blank lines are also treated as comment lines.
|
||||
Configuration lines consist of a configuration keyword followed by a
|
||||
character.
|
||||
Blank lines are also treated as comment lines.
|
||||
Configuration lines consist of a configuration keyword followed by a
|
||||
configuration string.
|
||||
There are two types of configuration keywords: control keywords and
|
||||
section keywords.
|
||||
@ -83,27 +83,27 @@ character.
|
||||
The following control keywords are currently defined:
|
||||
.Bl -tag -width "_version"
|
||||
.It _build
|
||||
identifies the set of suffixes used for manual pages that must be
|
||||
formatted for display and the command that should be used to format
|
||||
them. Manual file names, regardless of their format, are
|
||||
expected to end in a
|
||||
identifies the set of suffixes used for manual pages that must be
|
||||
formatted for display and the command that should be used to format
|
||||
them.
|
||||
Manual file names, regardless of their format, are expected to end in a
|
||||
.Dq \.*
|
||||
pattern, i.e. a
|
||||
.Dq \&\.
|
||||
followed by some suffix.
|
||||
The first field of a _build line contains a man page suffix specification.
|
||||
The suffix specification may contain the normal shell globbing characters
|
||||
The suffix specification may contain the normal shell globbing characters
|
||||
(NOT including curly braces
|
||||
.Pq Dq {} ) .
|
||||
The rest of the _build line is a shell command line whose standard
|
||||
output is a formatted manual page that can be directly displayed to
|
||||
The rest of the _build line is a shell command line whose standard
|
||||
output is a formatted manual page that can be directly displayed to
|
||||
the user.
|
||||
Any occurrences of the string
|
||||
.Dq %s
|
||||
in the shell command line will
|
||||
be replaced by the name of the file which is being formatted.
|
||||
.It _crunch
|
||||
used by
|
||||
used by
|
||||
.Xr catman 8
|
||||
to determine how to crunch formatted pages
|
||||
which originally were compressed man pages: The first field lists a suffix
|
||||
@ -113,14 +113,14 @@ formatted pages.
|
||||
.It _default
|
||||
contains the system-wide default man path used to search for man pages.
|
||||
.It _subdir
|
||||
contains the list (in search order) of section subdirectories which will
|
||||
contains the list (in search order) of section subdirectories which will
|
||||
be searched in any man path directory named with a trailing slash
|
||||
.Pq Dq /
|
||||
character.
|
||||
This list is also used, even if there is no trailing slash character,
|
||||
when a path is specified to the
|
||||
.Xr man 1
|
||||
utility by the user, by the
|
||||
utility by the user, by the
|
||||
.Ev MANPATH
|
||||
environment variable, or by the
|
||||
.Fl M
|
||||
@ -129,7 +129,7 @@ and
|
||||
options.
|
||||
.It _suffix
|
||||
identifies the set of suffixes used for formatted man pages
|
||||
(the
|
||||
(the
|
||||
.Dq \.0
|
||||
suffix is normally used here).
|
||||
Formatted man pages can be directly displayed to the user.
|
||||
@ -139,7 +139,7 @@ including curly braces
|
||||
.It _version
|
||||
contains the version of the configuration file.
|
||||
.It _whatdb
|
||||
defines the full pathname (not just a directory path) for a database to
|
||||
defines the full pathname (not just a directory path) for a database to
|
||||
be used
|
||||
by the
|
||||
.Xr apropos 1
|
||||
@ -154,7 +154,7 @@ precede it with a backslash
|
||||
.Pq Dq \e .
|
||||
.El
|
||||
.Pp
|
||||
Section configuration lines in
|
||||
Section configuration lines in
|
||||
.Nm
|
||||
consist of a section keyword naming the section and a configuration
|
||||
string that defines the directory or subdirectory path that the section's
|
||||
@ -171,7 +171,7 @@ character.
|
||||
.Pp
|
||||
A section path may contain either a list of absolute directories or
|
||||
a list of or relative directories (but not both).
|
||||
Relative directory paths are treated as a list of subdirectories that
|
||||
Relative directory paths are treated as a list of subdirectories that
|
||||
are appended to the current man path directory being searched.
|
||||
Section configuration lines with absolute directory paths (starting with
|
||||
.Dq / )
|
||||
@ -185,24 +185,24 @@ of manual pages, (see the keyword
|
||||
above).
|
||||
The
|
||||
.Dq _subdir
|
||||
subdirectory list is not applied to absolute section directories
|
||||
subdirectory list is not applied to absolute section directories
|
||||
if there is no trailing slash.
|
||||
.Pp
|
||||
In addition to the above rules, the
|
||||
In addition to the above rules, the
|
||||
.Xr man 1
|
||||
command also always checks in each directory that it searches for
|
||||
a subdirectory with the same name as the current machine type.
|
||||
If the machine-specific directory is found, it is also searched.
|
||||
This allows the manual to contain machine-specific man pages.
|
||||
Note that the machine subdirectory does not need to be specified
|
||||
in the
|
||||
This allows the manual to contain machine-specific man pages.
|
||||
Note that the machine subdirectory does not need to be specified
|
||||
in the
|
||||
.Nm
|
||||
file.
|
||||
.Pp
|
||||
Multiple specifications for all types of
|
||||
Multiple specifications for all types of
|
||||
.Nm
|
||||
configuration lines are
|
||||
cumulative and the entries are used in the order listed in the file;
|
||||
configuration lines are
|
||||
cumulative and the entries are used in the order listed in the file;
|
||||
multiple entries may be listed per line, as well.
|
||||
.Sh FILES
|
||||
.Bl -tag -width /etc/man.conf -compact
|
||||
|
||||
Loading…
Reference in New Issue
Block a user