When a file is given on the command line, actually exists, and its name

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index fdb705f7a363e2f0442cc8f4fab8b59a1c2a26b8..6ca3ec36d668918cef7060e0d6a08ae004344805 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\"    $Id: mandoc.1,v 1.124 2014/11/27 23:40:19 schwarze Exp $
+.\"    $Id: mandoc.1,v 1.130 2014/12/28 14:42:27 schwarze Exp $

 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>


@@ -15,7 +15,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: November 27 2014 $
+.Dd $Mdocdate: December 28 2014 $

 .Dt MANDOC 1
 .Os
 .Sh NAME
 .Dt MANDOC 1
 .Os
 .Sh NAME


@@ -49,7 +49,7 @@ or
 text from stdin, implying
 .Fl m Ns Cm andoc ,
 and produces
 text from stdin, implying
 .Fl m Ns Cm andoc ,
 and produces

-.Fl T Ns Cm ascii
+.Fl T Ns Cm locale

 output.
 .Pp
 The options are as follows:
 output.
 .Pp
 The options are as follows:


@@ -85,6 +85,9 @@ Override the default operating system
 for the
 .Xr mdoc 7
 .Sq \&Os
 for the
 .Xr mdoc 7
 .Sq \&Os

+and for the
+.Xr man 7
+.Sq \&TH

 macro.
 .It Fl h
 Display only the SYNOPSIS lines.
 macro.
 .It Fl h
 Display only the SYNOPSIS lines.


@@ -146,7 +149,7 @@ See
 .Sx Output Formats
 for available formats.
 Defaults to
 .Sx Output Formats
 for available formats.
 Defaults to

-.Fl T Ns Cm ascii .
+.Fl T Ns Cm locale .

 .It Fl V
 Print version and exit.
 .It Fl W Ns Ar level
 .It Fl V
 Print version and exit.
 .It Fl W Ns Ar level


@@ -255,7 +258,6 @@ arguments, which correspond to output modes:
 .Bl -tag -width "-Tlocale"
 .It Fl T Ns Cm ascii
 Produce 7-bit ASCII output.
 .Bl -tag -width "-Tlocale"
 .It Fl T Ns Cm ascii
 Produce 7-bit ASCII output.

-This is the default.

 See
 .Sx ASCII Output .
 .It Fl T Ns Cm html
 See
 .Sx ASCII Output .
 .It Fl T Ns Cm html


@@ -268,6 +270,7 @@ Implies
 .Fl W Ns Cm warning .
 .It Fl T Ns Cm locale
 Encode output using the current locale.
 .Fl W Ns Cm warning .
 .It Fl T Ns Cm locale
 Encode output using the current locale.

+This is the default.

 See
 .Sx Locale Output .
 .It Fl T Ns Cm man
 See
 .Sx Locale Output .
 .It Fl T Ns Cm man


@@ -299,8 +302,8 @@ If multiple input files are specified, these will be processed by the
 corresponding filter in-order.
 .Ss ASCII Output
 Output produced by
 corresponding filter in-order.
 .Ss ASCII Output
 Output produced by

-.Fl T Ns Cm ascii ,
-which is the default, is rendered in standard 7-bit ASCII documented in
+.Fl T Ns Cm ascii
+is rendered in standard 7-bit ASCII documented in

 .Xr ascii 7 .
 .Pp
 Font styles are applied by using back-spaced encoding such that an
 .Xr ascii 7 .
 .Pp
 Font styles are applied by using back-spaced encoding such that an


@@ -413,6 +416,8 @@ relative URI.
 .Ss Locale Output
 Locale-depending output encoding is triggered with
 .Fl T Ns Cm locale .
 .Ss Locale Output
 Locale-depending output encoding is triggered with
 .Fl T Ns Cm locale .

+This is the default.
+.Pp

 This option is not available on all systems: systems without locale
 support, or those whose internal representation is not natively UCS-4,
 will fall back to
 This option is not available on all systems: systems without locale
 support, or those whose internal representation is not natively UCS-4,
 will fall back to


@@ -665,12 +670,6 @@ macro lacks the mandatory section argument.
 The section number in a
 .Ic \&Dt
 line is invalid, but still used.
 The section number in a
 .Ic \&Dt
 line is invalid, but still used.

-.It Sy "unknown manual volume or arch"
-.Pq mdoc
-The volume name in a
-.Ic \&Dt
-line is invalid, but still used.
-The manual is assumed to be architecture-independent.

 .It Sy "missing date, using today's date"
 .Pq mdoc, man
 The document was parsed as
 .It Sy "missing date, using today's date"
 .Pq mdoc, man
 The document was parsed as


@@ -809,6 +808,13 @@ Probably, there are author names lacking markup.
 See the
 .Xr mdoc 7
 manual for replacements.
 See the
 .Xr mdoc 7
 manual for replacements.

+.It Sy "macro neither callable nor escaped"
+.Pq mdoc
+The name of a macro that is not callable appears on a macro line.
+It is printed verbatim.
+If the intention is to call it, move it to its own line;
+otherwise, escape it by prepending
+.Sq \e& .

 .It Sy "skipping paragraph macro"
 In
 .Xr mdoc 7
 .It Sy "skipping paragraph macro"
 In
 .Xr mdoc 7


@@ -1053,6 +1059,14 @@ argument is invalid.
 The default font
 .Cm \efR
 is used instead.
 The default font
 .Cm \efR
 is used instead.

+.It Sy "nothing follows prefix"
+.Pq mdoc
+A
+.Ic \&Pf
+macro has no argument, or only one argument and no macro follows
+on the same input line.
+This defeats its purpose; in particular, spacing is not suppressed
+before the text or macros following on the next input line.

 .It Sy "missing -std argument, adding it"
 .Pq mdoc
 An
 .It Sy "missing -std argument, adding it"
 .Pq mdoc
 An


@@ -1255,6 +1269,7 @@ keeps the code more readable.
 .It "ignore data in cell"
 .It "data block still open"
 .It "ignoring extra data cells"
 .It "ignore data in cell"
 .It "data block still open"
 .It "ignoring extra data cells"

+.It "ignoring macro in table"

 .El
 .Ss "Errors related to roff, mdoc, and man code"
 .Bl -ohang
 .El
 .Ss "Errors related to roff, mdoc, and man code"
 .Bl -ohang