Simplify search form: minus two visible control elements, minus

[mandoc.git] / man.1

diff --git a/man.1 b/man.1
index b9644446dd29967828749eb9c8b6d9e4f9dd4437..f29360bd5f06ae3ab4914dbddebdaf050ed7ea24 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.16 2015/09/21 09:59:02 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) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2010, 2011, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" 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
 .\"
-.Dd $Mdocdate: September 3 2014 $
+.Dd $Mdocdate: September 21 2015 $
 .Dt MAN 1
 .Os
 .Sh NAME
@@ -39,12 +39,17 @@
 .Nd display manual pages
 .Sh SYNOPSIS
 .Nm man
-.Op Fl acfhklVw
+.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
@@ -95,10 +100,34 @@ This overrides any earlier
 and
 .Fl l
 options.
+.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 h
 Display only the SYNOPSIS lines of the requested manual pages.
 Implies
-.Fl a .
+.Fl a
+and
+.Fl c .
+.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 .
@@ -144,12 +173,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
@@ -165,12 +188,11 @@ 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
@@ -240,8 +262,43 @@ specifies the possible
 .Ar section
 values, and their search order.
 Additional sections may be specified.
-.It Fl V
-Print version and exit.
+.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
+is silent.
+See the
+.Xr mandoc 1
+manual for details.
 .It Fl w
 List the pathnames of the manual pages which
 .Nm
@@ -252,14 +309,6 @@ and
 combination.
 .El
 .Pp
-The
-.Nm
-utility also supports the options
-.Fl IOTW
-described in the
-.Xr mandoc 1
-manual.
-.Pp
 Guidelines for writing
 man pages can be found in
 .Xr mdoc 7 .
@@ -299,6 +348,13 @@ Any non-empty value of the environment variable
 .Ev MANPAGER
 will be 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,
+and environment variables.
 .It Ev MANPATH
 The standard search path used by
 .Nm
@@ -309,18 +365,13 @@ 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.
 .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
+.Xr more 1
+.Fl s
 will be used.
 .El
 .Sh FILES
@@ -353,7 +404,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 ,