In man(1) mode, properly clean up the resn[] result array

[mandoc.git] / man.1

diff --git a/man.1 b/man.1
index b9644446dd29967828749eb9c8b6d9e4f9dd4437..d3a54c6a235c204639cae473dc3531afdde29161 100644 (file)
--- a/man.1
+++ b/man.1
@@ -1,9 +1,9 @@
-.\"    $Id: man.1,v 1.5 2014/09/03 05:22:45 schwarze Exp $
+.\"    $Id: man.1,v 1.40 2020/07/20 16:57:30 schwarze Exp $

 .\"
 .\" Copyright (c) 1989, 1990, 1993
 .\"    The Regents of the University of California.  All rights reserved.
 .\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org>
 .\"
 .\" Copyright (c) 1989, 1990, 1993
 .\"    The Regents of the University of California.  All rights reserved.
 .\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org>

-.\" Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2010, 2011, 2014-2020 Ingo Schwarze <schwarze@openbsd.org>

 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions


@@ -31,7 +31,7 @@
 .\"
 .\"     @(#)man.1      8.2 (Berkeley) 1/2/94
 .\"
 .\"
 .\"     @(#)man.1      8.2 (Berkeley) 1/2/94
 .\"

-.Dd $Mdocdate: September 3 2014 $
+.Dd $Mdocdate: July 20 2020 $

 .Dt MAN 1
 .Os
 .Sh NAME
 .Dt MAN 1
 .Os
 .Sh NAME


@@ -39,20 +39,19 @@
 .Nd display manual pages
 .Sh SYNOPSIS
 .Nm man
 .Nd display manual pages
 .Sh SYNOPSIS
 .Nm man

-.Op Fl acfhklVw
+.Op Fl acfhklw

 .Op Fl C Ar file
 .Op Fl M Ar path
 .Op Fl m Ar path
 .Op Fl S Ar subsection
 .Op Fl C Ar file
 .Op Fl M Ar path
 .Op Fl m Ar path
 .Op Fl S Ar subsection

-.Op Fl s Ar section
-.Op Ar section
+.Op Oo Fl s Oc Ar section

 .Ar name ...
 .Sh DESCRIPTION
 The
 .Nm
 utility
 displays the
 .Ar name ...
 .Sh DESCRIPTION
 The
 .Nm
 utility
 displays the

-manual pages entitled
+manual page entitled

 .Ar name .
 Pages may be selected according to
 a specific category
 .Ar name .
 Pages may be selected according to
 a specific category


@@ -64,12 +63,7 @@ machine architecture
 The options are as follows:
 .Bl -tag -width Ds
 .It Fl a
 The options are as follows:
 .Bl -tag -width Ds
 .It Fl a

-Display all of the manual pages for a specified
-.Ar section
-and
-.Ar name
-combination.
-Normally, only the first manual page found is displayed.
+Display all matching manual pages.

 .It Fl C Ar file
 Use the specified
 .Ar file
 .It Fl C Ar file
 Use the specified
 .Ar file


@@ -80,9 +74,21 @@ See
 for a description of the contents of this file.
 .It Fl c
 Copy the manual page to the standard output instead of using
 for a description of the contents of this file.
 .It Fl c
 Copy the manual page to the standard output instead of using

-.Xr more 1
+.Xr less 1

 to paginate it.
 This is done by default if the standard output is not a terminal device.
 to paginate it.
 This is done by default if the standard output is not a terminal device.

+.Pp
+When using
+.Fl c ,
+most terminal devices are unable to show the markup.
+To print the output of
+.Nm
+to the terminal with markup but without using a pager, pipe it to
+.Xr ul 1 .
+To remove the markup, pipe the output to
+.Xr col 1
+.Fl b
+instead.

 .It Fl f
 A synonym for
 .Xr whatis 1 .
 .It Fl f
 A synonym for
 .Xr whatis 1 .


@@ -90,15 +96,12 @@ It searches for
 .Ar name
 in manual page names and displays the header lines from all matching pages.
 The search is case insensitive and matches whole words only.
 .Ar name
 in manual page names and displays the header lines from all matching pages.
 The search is case insensitive and matches whole words only.

-This overrides any earlier
-.Fl k
-and
-.Fl l
-options.

 .It Fl h
 Display only the SYNOPSIS lines of the requested manual pages.
 Implies
 .It Fl h
 Display only the SYNOPSIS lines of the requested manual pages.
 Implies

-.Fl a .
+.Fl a
+and
+.Fl c .

 .It Fl k
 A synonym for
 .Xr apropos 1 .
 .It Fl k
 A synonym for
 .Xr apropos 1 .


@@ -108,15 +111,9 @@ an expression can be provided using the syntax described in the
 .Xr apropos 1
 manual.
 By default, it displays the header lines of all matching pages.
 .Xr apropos 1
 manual.
 By default, it displays the header lines of all matching pages.

-This overrides any earlier
-.Fl f
-and
-.Fl l
-options.

 .It Fl l
 A synonym for
 .It Fl l
 A synonym for

-.Xr mandoc 1
-.Fl a .
+.Xr mandoc 1 .

 The
 .Ar name
 arguments are interpreted as filenames.
 The
 .Ar name
 arguments are interpreted as filenames.


@@ -124,57 +121,40 @@ No search is done and
 .Ar file ,
 .Ar path ,
 .Ar section ,
 .Ar file ,
 .Ar path ,
 .Ar section ,

-and
-.Ar subsection
-are ignored.
-This overrides any earlier
-.Fl f ,
-.Fl k ,
+.Ar subsection ,

 and
 .Fl w
 and
 .Fl w

-options.
+are ignored.
+This option implies
+.Fl a .

 .It Fl M Ar path
 .It Fl M Ar path

-Override the list of standard directories which
-.Nm
-searches for manual pages.
+Override the list of directories to search for manual pages.

 The supplied
 .Ar path
 must be a colon
 .Pq Ql \&:
 separated list of directories.
 The supplied
 .Ar path
 must be a colon
 .Pq Ql \&:
 separated list of directories.

-This search path may also be set using the environment variable
-.Ev MANPATH .
-The subdirectories to be searched, and their search order,
-are specified by the
-.Dq _subdir
-line in the
-.Nm
-configuration file.
+This option also overrides the environment variable
+.Ev MANPATH
+and any directories specified in the
+.Xr man.conf 5
+file.

 .It Fl m Ar path
 .It Fl m Ar path

-Augment the list of standard directories which
-.Nm
-searches for manual pages.
+Augment the list of directories to search for manual pages.

 The supplied
 .Ar path
 must be a colon
 .Pq Ql \&:
 separated list of directories.
 The supplied
 .Ar path
 must be a colon
 .Pq Ql \&:
 separated list of directories.

-These directories will be searched before the standard directories or
-the directories specified using the
+These directories will be searched before those specified using the

 .Fl M
 .Fl M

-option or the
+option, the

 .Ev MANPATH
 .Ev MANPATH

-environment variable.
-The subdirectories to be searched, and their search order,
-are specified by the
-.Dq _subdir
-line in the
-.Nm
-configuration file.
+environment variable, the
+.Xr man.conf 5
+file, or the default directories.

 .It Fl S Ar subsection
 .It Fl S Ar subsection

-Restricts the directories that
-.Nm
-will search to those of a specific
+Only show pages for the specified

 .Xr machine 1
 architecture.
 .Ar subsection
 .Xr machine 1
 architecture.
 .Ar subsection


@@ -187,13 +167,10 @@ architecture whilst using another.
 This option overrides the
 .Ev MACHINE
 environment variable.
 This option overrides the
 .Ev MACHINE
 environment variable.

-.It Xo
-.Op Fl s
-.Ar section
-.Xc
-Restricts the directories that
-.Nm
-will search to a specific section.
+.Tg s
+.It Oo Fl s Oc Ar section
+Only select manuals from the specified
+.Ar section .

 The currently available sections are:
 .Pp
 .Bl -tag -width "localXXX" -offset indent -compact
 The currently available sections are:
 .Pp
 .Bl -tag -width "localXXX" -offset indent -compact


@@ -203,9 +180,7 @@ General commands
 .It 2
 System calls and error numbers.
 .It 3
 .It 2
 System calls and error numbers.
 .It 3

-Libraries.
-.It 3f
-Fortran programmer's reference guide.
+Library functions.

 .It 3p
 .Xr perl 1
 programmer's reference guide.
 .It 3p
 .Xr perl 1
 programmer's reference guide.


@@ -216,66 +191,68 @@ File formats.
 .It 6
 Games.
 .It 7
 .It 6
 Games.
 .It 7

-Miscellaneous.
+Miscellaneous information.

 .It 8
 System maintenance and operation commands.
 .It 9
 Kernel internals.
 .It 8
 System maintenance and operation commands.
 .It 9
 Kernel internals.

-.It X11
-An alias for X11R6.
-.It X11R6
-X Window System.
-.It local
-Pages located in
-.Pa /usr/local .
-.It n
-Tcl/Tk commands.

 .El
 .El

-.Pp
-The
-.Nm
-configuration file,
-.Xr man.conf 5 ,
-specifies the possible
-.Ar section
-values, and their search order.
-Additional sections may be specified.
-.It Fl V
-Print version and exit.

 .It Fl w
 .It Fl w

-List the pathnames of the manual pages which
-.Nm
-would display for the specified
-.Ar section
-and
+List the pathnames of all matching manual pages instead of displaying
+any of them.
+If no

 .Ar name
 .Ar name

-combination.
+is given, list the directories that would be searched.

 .El
 .Pp
 .El
 .Pp

-The
-.Nm
-utility also supports the options
-.Fl IOTW
-described in the
-.Xr mandoc 1
-manual.
+The options
+.Fl IKOTW
+are also supported and are documented in
+.Xr mandoc 1 .
+The options
+.Fl fkl
+are mutually exclusive and override each other.

 .Pp
 .Pp

-Guidelines for writing
-man pages can be found in
-.Xr mdoc 7 .
+The search starts with the
+.Fl m
+argument if provided, then continues with the
+.Fl M
+argument, the
+.Ev MANPATH
+variable, the
+.Ic manpath
+entries in the
+.Xr man.conf 5
+file, or with
+.Pa /usr/share/man : Ns Pa /usr/X11R6/man : Ns Pa /usr/local/man
+by default.
+Within each of these, directories are searched in the order provided.
+Within each directory, the search proceeds according to the following
+list of sections: 1, 8, 6, 2, 3, 5, 7, 4, 9, 3p.
+The first match found is shown.

 .Pp
 .Pp

+The
+.Xr mandoc.db 5
+database is used for looking up manual page entries.
+In cases where the database is absent, outdated, or corrupt,
+.Nm
+falls back to looking for files called
+.Ar name . Ns Ar section .

 If both a formatted and an unformatted version of the same manual page,
 for example
 .Pa cat1/foo.0
 and
 .Pa man1/foo.1 ,
 If both a formatted and an unformatted version of the same manual page,
 for example
 .Pa cat1/foo.0
 and
 .Pa man1/foo.1 ,

-exist in the same directory, and at least one of them is selected,
-only the newer one is used.
-However, if both the
-.Fl a
-and the
-.Fl w
-options are specified, both file names are printed.
+exist in the same directory, only the unformatted version is used.
+The database is kept up to date with
+.Xr makewhatis 8 ,
+which is run by the
+.Xr weekly 8
+maintenance script.
+.Pp
+Guidelines for writing
+man pages can be found in
+.Xr mdoc 7 .

 .Sh ENVIRONMENT
 .Bl -tag -width MANPATHX
 .It Ev MACHINE
 .Sh ENVIRONMENT
 .Bl -tag -width MANPATHX
 .It Ev MACHINE


@@ -297,54 +274,94 @@ is case insensitive.
 .It Ev MANPAGER
 Any non-empty value of the environment variable
 .Ev MANPAGER
 .It Ev MANPAGER
 Any non-empty value of the environment variable
 .Ev MANPAGER

-will be used instead of the standard pagination program,
-.Xr more 1 .
+is used instead of the standard pagination program,
+.Xr less 1 .
+If
+.Xr less 1
+is used, the interactive
+.Ic :t
+command can be used to go to the definitions of various terms, for
+example command line options, command modifiers, internal commands,
+environment variables, function names, preprocessor macros,
+.Xr errno 2
+values, and some other emphasized words.
+Some terms may have defining text at more than one place.
+In that case, the
+.Xr less 1
+interactive commands
+.Ic t
+and
+.Ic T
+can be used to move to the next and to the previous place providing
+information about the term last searched for with
+.Ic :t .
+The
+.Fl O Cm tag Ns Op = Ns Ar term
+option documented in the
+.Xr mandoc 1
+manual opens a manual page at the definition of a specific
+.Ar term
+rather than at the beginning.

 .It Ev MANPATH
 .It Ev MANPATH

-The standard search path used by
-.Nm
-may be overridden by specifying a path in the
+Override the standard search path which is either specified in
+.Xr man.conf 5
+or the default path.
+The format of

 .Ev MANPATH
 .Ev MANPATH

-environment
-variable.
-The format of the path is a colon
+is a colon

 .Pq Ql \&:
 separated list of directories.
 .Pq Ql \&:
 separated list of directories.

-The subdirectories to be searched, as well as their search order,
-are specified by the
-.Dq _subdir
-line in the
-.Nm
-configuration file.
+Invalid directories are ignored.
+Overridden by
+.Fl M ,
+ignored if
+.Fl l
+is specified.
+.Pp
+If
+.Ev MANPATH
+begins with a colon, it is appended to the standard path;
+if it ends with a colon, it is prepended to the standard path;
+or if it contains two adjacent colons,
+the standard path is inserted between the colons.

 .It Ev PAGER
 Specifies the pagination program to use when
 .Ev MANPAGER
 is not defined.
 If neither PAGER nor MANPAGER is defined,
 .It Ev PAGER
 Specifies the pagination program to use when
 .Ev MANPAGER
 is not defined.
 If neither PAGER nor MANPAGER is defined,

-.Pa /usr/bin/more Fl s
-will be used.
+.Xr less 1
+is used.

 .El
 .Sh FILES
 .Bl -tag -width /etc/man.conf -compact
 .It Pa /etc/man.conf
 .El
 .Sh FILES
 .Bl -tag -width /etc/man.conf -compact
 .It Pa /etc/man.conf

-default man configuration file
+default
+.Nm
+configuration file

 .El
 .Sh EXIT STATUS
 .Ex -std man
 .El
 .Sh EXIT STATUS
 .Ex -std man

+See
+.Xr mandoc 1
+for details.
+.Sh EXAMPLES
+Format a page for pasting extracts into an email message \(em
+avoid printing any UTF-8 characters, reduce the width to ease
+quoting in replies, and remove markup:
+.Pp
+.Dl $ man -T ascii -O width=65 pledge | col -b
+.Pp
+Read a typeset page in a PDF viewer:
+.Pp
+.Dl $ MANPAGER=mupdf man -T pdf lpd

 .Sh SEE ALSO
 .Xr apropos 1 ,
 .Sh SEE ALSO
 .Xr apropos 1 ,

-.Xr intro 1 ,
-.Xr whatis 1 ,
+.Xr col 1 ,
+.Xr mandoc 1 ,
+.Xr ul 1 ,

 .Xr whereis 1 ,
 .Xr whereis 1 ,

-.Xr intro 2 ,
-.Xr intro 3 ,
-.Xr intro 4 ,
-.Xr intro 5 ,

 .Xr man.conf 5 ,
 .Xr man.conf 5 ,

-.Xr intro 6 ,
-.Xr intro 7 ,
-.Xr mdoc 7 ,
-.Xr intro 8 ,
-.Xr intro 9
+.Xr mdoc 7

 .Sh STANDARDS
 The
 .Nm
 .Sh STANDARDS
 The
 .Nm


@@ -353,7 +370,7 @@ utility is compliant with the
 specification.
 .Pp
 The flags
 specification.
 .Pp
 The flags

-.Op Fl aCcfhMmSsw ,
+.Op Fl aCcfhIKlMmOSsTWw ,

 as well as the environment variables
 .Ev MACHINE ,
 .Ev MANPAGER ,
 as well as the environment variables
 .Ev MACHINE ,
 .Ev MANPAGER ,


@@ -364,7 +381,7 @@ are extensions to that specification.
 A
 .Nm
 command first appeared in
 A
 .Nm
 command first appeared in

-.At v3 .
+.At v2 .

 .Pp
 The
 .Fl w
 .Pp
 The
 .Fl w


@@ -392,9 +409,23 @@ in
 .Fl C
 in
 .Nx 1.0 ;
 .Fl C
 in
 .Nx 1.0 ;

-and

 .Fl s
 and
 .Fl S
 in
 .Fl s
 and
 .Fl S
 in

-.Ox 2.3 .
+.Ox 2.3 ;
+and
+.Fl I ,
+.Fl K ,
+.Fl l ,
+.Fl O ,
+and
+.Fl W
+in
+.Ox 5.7 .
+The
+.Fl T
+option first appeared in
+.At III
+and was also added in
+.Ox 5.7 .