=================================================================== RCS file: /cvs/mandoc/man.1,v retrieving revision 1.2 retrieving revision 1.25 diff -u -p -r1.2 -r1.25 --- mandoc/man.1 2014/08/21 01:35:43 1.2 +++ mandoc/man.1 2017/03/22 13:31:49 1.25 @@ -1,10 +1,9 @@ -.\" $Id: man.1,v 1.2 2014/08/21 01:35:43 schwarze Exp $ -.\" $OpenBSD: man.1,v 1.2 2014/08/21 01:35:43 schwarze Exp $ +.\" $Id: man.1,v 1.25 2017/03/22 13:31:49 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 -.\" Copyright (c) 2010, 2011 Ingo Schwarze +.\" Copyright (c) 2010, 2011, 2014-2017 Ingo Schwarze .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -32,7 +31,7 @@ .\" .\" @(#)man.1 8.2 (Berkeley) 1/2/94 .\" -.Dd $Mdocdate: August 21 2014 $ +.Dd $Mdocdate: March 22 2017 $ .Dt MAN 1 .Os .Sh NAME @@ -40,12 +39,17 @@ .Nd display manual pages .Sh SYNOPSIS .Nm man -.Op Fl acfhkw +.Op Fl acfhklw .Op Fl C Ar file +.Op Fl I Cm os Ns = Ns Ar name +.Op Fl K Ar encoding .Op Fl M Ar path .Op Fl m Ar path +.Op Fl O Ar option Ns = Ns Ar value .Op Fl S Ar subsection .Op Fl s Ar section +.Op Fl T Ar output +.Op Fl W Ar level .Op Ar section .Ar name ... .Sh DESCRIPTION @@ -65,12 +69,8 @@ machine architecture 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. +Normally, only the first page found is displayed. .It Fl C Ar file Use the specified .Ar file @@ -91,10 +91,39 @@ 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. +This overrides any earlier +.Fl k +and +.Fl l +options. .It Fl h -Display only the -.Dq SYNOPSIS -lines of the requested manual pages. +Display only the SYNOPSIS lines of the requested manual pages. +Implies +.Fl a +and +.Fl c . +.It Fl I Cm os Ns = Ns Ar name +Override the default operating system +.Ar name +for the +.Xr mdoc 7 +.Ic \&Os +and for the +.Xr man 7 +.Ic \&TH +macro. +.It Fl K Ar encoding +Specify the input encoding. +The supported +.Ar encoding +arguments are +.Cm us-ascii , +.Cm iso-8859-1 , +and +.Cm utf-8 . +By default, the encoding is automatically detected as described in the +.Xr mandoc 1 +manual. .It Fl k A synonym for .Xr apropos 1 . @@ -104,6 +133,31 @@ an expression can be provided using the syntax describ .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 +.Xr mandoc 1 +.Fl a . +The +.Ar name +arguments are interpreted as filenames. +No search is done and +.Ar file , +.Ar path , +.Ar section , +and +.Ar subsection +are ignored. +This overrides any earlier +.Fl f , +.Fl k , +and +.Fl w +options. .It Fl M Ar path Override the list of standard directories which .Nm @@ -115,12 +169,6 @@ must be a colon 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. .It Fl m Ar path Augment the list of standard directories which .Nm @@ -136,16 +184,13 @@ the directories specified using the option or the .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. +.It Fl O Ar option Ns = Ns Ar value +Comma-separated output options. +For each output format, the available options are described in the +.Xr mandoc 1 +manual. .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 @@ -158,13 +203,9 @@ architecture whilst using another. 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. +.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 @@ -174,9 +215,7 @@ General commands .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. @@ -187,38 +226,56 @@ File formats. .It 6 Games. .It 7 -Miscellaneous. +Miscellaneous information. .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 .Pp +If not specified and a match is found in more than one section, +the first match is selected from the following list: +1, 8, 6, 2, 3, 5, 7, 4, 9, 3p. +.It Fl T Ar output +Select the output format. +The default is +.Cm locale . +The other output modes +.Cm ascii , +.Cm html , +.Cm lint , +.Cm man , +.Cm pdf , +.Cm ps , +.Cm tree , +and +.Cm utf8 +are described in the +.Xr mandoc 1 +manual. +.It Fl W Ar level +Specify the minimum message +.Ar level +to be reported on the standard error output and to affect the exit status. The +.Ar level +can be +.Cm warning , +.Cm error , +or +.Cm unsupp ; +.Cm all +is an alias for +.Cm warning . +By default, .Nm -configuration file, -.Xr man.conf 5 , -specifies the possible -.Ar section -values, and their search order. -Additional sections may be specified. +is silent. +See the +.Xr mandoc 1 +manual for details. .It Fl w -List the pathnames of the manual pages which -.Nm -would display for the specified -.Ar section -and -.Ar name -combination. +List the pathnames of all matching manual pages instead of displaying +any of them. .El .Pp Guidelines for writing @@ -230,13 +287,7 @@ 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. .Sh ENVIRONMENT .Bl -tag -width MANPATHX .It Ev MACHINE @@ -258,31 +309,64 @@ is case insensitive. .It Ev MANPAGER Any non-empty value of the environment variable .Ev MANPAGER -will be used instead of the standard pagination program, +is used instead of the standard pagination program, .Xr more 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 . .It Ev MANPATH The standard search path used by .Nm -may be overridden by specifying a path in the +may be changed by specifying a path in the .Ev MANPATH -environment -variable. +environment variable. The format of the path is a colon .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 paths, or paths without manual databases, 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 default list; +if it ends with a colon, it is prepended to the default list; +or if it contains two adjacent colons, +the standard search path is inserted between the colons. +If none of these conditions are met, it overrides the +standard search path. .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 more 1 +.Fl s +is used. +Only used if +.Fl a +or +.Fl l +is specified. .El .Sh FILES .Bl -tag -width /etc/man.conf -compact @@ -291,10 +375,12 @@ default man configuration file .El .Sh EXIT STATUS .Ex -std man +See +.Xr mandoc 1 +for details. .Sh SEE ALSO .Xr apropos 1 , .Xr intro 1 , -.Xr whatis 1 , .Xr whereis 1 , .Xr intro 2 , .Xr intro 3 , @@ -314,7 +400,7 @@ utility is compliant with the specification. .Pp The flags -.Op Fl aCcfhMmSsw , +.Op Fl aCcfhIKlMmOSsTWw , as well as the environment variables .Ev MACHINE , .Ev MANPAGER , @@ -353,9 +439,23 @@ in .Fl C in .Nx 1.0 ; -and .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 .