Fill mode changes don't break next-line scope in all cases,

[mandoc.git] / man.1

diff --git a/man.1 b/man.1
index bff2fd5ede751af0cbf61f3eb9d3bc3fe25d2eea..c9ddfa7d1863b3097cb1e1e0f159483ba64c64ad 100644 (file)
--- a/man.1
+++ b/man.1
@@ -1,10 +1,9 @@
-.\"    $Id: man.1,v 1.4 2014/08/30 18:08:10 schwarze Exp $
-.\"    $OpenBSD: man.1,v 1.55 2014/04/03 06:15:18 jmc Exp $
+.\"    $Id: man.1,v 1.15 2015/07/17 22:38:29 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, 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
 .\"
 .\" 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
 .\"
 .\"
 .\"     @(#)man.1      8.2 (Berkeley) 1/2/94
 .\"

-.Dd $Mdocdate: August 30 2014 $
+.Dd $Mdocdate: July 17 2015 $

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


@@ -40,12 +39,17 @@
 .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 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 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 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
 .Op Ar section
 .Ar name ...
 .Sh DESCRIPTION


@@ -96,10 +100,34 @@ This overrides any earlier
 and
 .Fl l
 options.
 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
 .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 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 .
 .It Fl k
 A synonym for
 .Xr apropos 1 .


@@ -172,6 +200,11 @@ are specified by the
 line in the
 .Nm
 configuration file.
 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
 .It Fl S Ar subsection
 Restricts the directories that
 .Nm


@@ -241,8 +274,43 @@ specifies the possible
 .Ar section
 values, and their search order.
 Additional sections may be specified.
 .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
 .It Fl w
 List the pathnames of the manual pages which
 .Nm


@@ -253,14 +321,6 @@ and
 combination.
 .El
 .Pp
 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 .
 Guidelines for writing
 man pages can be found in
 .Xr mdoc 7 .


@@ -300,6 +360,13 @@ Any non-empty value of the environment variable
 .Ev MANPAGER
 will be used instead of the standard pagination program,
 .Xr more 1 .
 .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
 .It Ev MANPATH
 The standard search path used by
 .Nm


@@ -321,7 +388,8 @@ Specifies the pagination program to use when
 .Ev MANPAGER
 is not defined.
 If neither PAGER nor MANPAGER is defined,
 .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
 will be used.
 .El
 .Sh FILES


@@ -354,7 +422,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 ,