From 2766352e79d087ab9cebab45f5737ede5524331b Mon Sep 17 00:00:00 2001 From: Kristaps Dzonsons Date: Thu, 7 Jan 2010 19:10:09 +0000 Subject: Fix white-space issues found by mandoc's better white-space finder. Fixed bogus `\\' escapes in some manuals. --- man.3 | 6 +++--- man.7 | 24 ++++++++++++------------ mandoc.1 | 24 ++++++++++++------------ mdoc.3 | 6 +++--- mdoc.7 | 46 +++++++++++++++++++++++----------------------- 5 files changed, 53 insertions(+), 53 deletions(-) diff --git a/man.3 b/man.3 index 00ec8b28..33f35bed 100644 --- a/man.3 +++ b/man.3 @@ -1,4 +1,4 @@ -.\" $Id: man.3,v 1.10 2009/10/03 16:36:06 kristaps Exp $ +.\" $Id: man.3,v 1.11 2010/01/07 19:10:09 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: October 3 2009 $ +.Dd $Mdocdate: January 7 2010 $ .Dt MAN 3 .Os .\" SECTION @@ -257,7 +257,7 @@ line = 1; man = man_alloc(NULL, 0, NULL); while ((buf = fgetln(fp, &len))) { - buf[len - 1] = '\\0'; + buf[len - 1] = '\e0'; if ( ! man_parseln(man, line, buf)) errx(1, "man_parseln"); line++; diff --git a/man.7 b/man.7 index efaf893e..7d1ee602 100644 --- a/man.7 +++ b/man.7 @@ -1,4 +1,4 @@ -.\" $Id: man.7,v 1.54 2009/11/16 08:46:59 kristaps Exp $ +.\" $Id: man.7,v 1.55 2010/01/07 19:10:09 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" 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 16 2009 $ +.Dd $Mdocdate: January 7 2010 $ .Dt MAN 7 .Os . @@ -102,7 +102,7 @@ and Terms may be text-decorated using the .Sq \ef escape followed by an indicator: B (bold), I, (italic), R (Roman), or P -(revert to previous mode): +(revert to previous mode): .Pp .D1 \efBbold\efR \efIitalic\efP .Pp @@ -295,7 +295,7 @@ the C library, this may be as follows: .D1 Standard C Library (libc, -lc) .It Em SYNOPSIS Documents the utility invocation syntax, function call syntax, or device -configuration. +configuration. .Pp For the first, utilities (sections 1, 6, and 8), this is generally structured as follows: @@ -310,10 +310,10 @@ And for the third, configurations (section 4): .Pp .D1 \&.B name* at cardbus ? function ? .Pp -Manuals not in these sections generally don't need a +Manuals not in these sections generally don't need a .Em SYNOPSIS . .It Em DESCRIPTION -This expands upon the brief, one-line description in +This expands upon the brief, one-line description in .Em NAME . It usually contains a break-down of the options (if documenting a command). @@ -361,7 +361,7 @@ Documents error handling in sections 2, 3, and 9. . .It Em SEE ALSO References other manuals with related topics. This section should exist -for most manuals. +for most manuals. .Pp .D1 \&.BR bar \&( 1 \&), .Pp @@ -504,7 +504,7 @@ sub-section, closed by a section or .Sx \&SS ; part, closed by a section, sub-section, or .Sx \&RE ; -or paragraph, closed by a section, sub-section, part, +or paragraph, closed by a section, sub-section, part, .Sx \&HP , .Sx \&IP , .Sx \&LP , @@ -563,13 +563,13 @@ and . . .Ss \&BI -Text is rendered alternately in bold face and italic. Thus, +Text is rendered alternately in bold face and italic. Thus, .Sq .BI this word and that causes .Sq this and .Sq and -to render in bold face, while +to render in bold face, while .Sq word and .Sq that @@ -819,7 +819,7 @@ The .Cm width argument must conform to .Sx Scaling Widths . -If not specified, the saved or default width is used. +If not specified, the saved or default width is used. . . .Ss \&SB @@ -960,7 +960,7 @@ Insert vertical spaces into output with the following syntax: .Op Cm height .Ed .Pp -Insert +Insert .Cm height spaces, which must conform to .Sx Scaling Widths . diff --git a/mandoc.1 b/mandoc.1 index 527ba0ce..569ef39e 100644 --- a/mandoc.1 +++ b/mandoc.1 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.48 2009/11/16 09:52:47 kristaps Exp $ +.\" $Id: mandoc.1,v 1.49 2010/01/07 19:10:09 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" 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 16 2009 $ +.Dd $Mdocdate: January 7 2010 $ .Dt MANDOC 1 .Os . @@ -231,7 +231,7 @@ relative URI. .It Fl O Ns Ar includes=fmt The string .Ar fmt , -for example, +for example, .Ar ../src/%I.html , is used as a template for linked header files (usually via the .Sq \&In @@ -242,7 +242,7 @@ hyperlink. .It Fl O Ns Ar man=fmt The string .Ar fmt , -for example, +for example, .Ar ../html%S/%N.%S.html , is used as a template for linked manuals (usually via the .Sq \&Xr @@ -260,7 +260,7 @@ present a hyperlink. This section documents output details of .Nm . In general, output conforms to the traditional manual style of a header, -a body composed of sections and sub-sections, and a footer. +a body composed of sections and sub-sections, and a footer. .Pp The text style of output characters (non-macro characters, punctuation, and white-space) is dictated by context. @@ -307,7 +307,7 @@ however, these rules are also applied to macro arguments when appropriate. . . .Ss ASCII Output -Output produced by +Output produced by .Fl T Ns Ar ascii , which is the default, is rendered in standard 7-bit ASCII documented in .Xr ascii 7 . @@ -379,15 +379,15 @@ Each input and output format is separately noted. .Ss ASCII Compatibility .Bl -bullet -compact .It -The +The .Sq \e~ -special character doesn't produce expected behaviour in +special character doesn't produce expected behaviour in .Fl T Ns Ar ascii . . .It -The +The .Sq \&Bd \-literal -and +and .Sq \&Bd \-unfilled macros of .Xr mdoc 7 @@ -396,7 +396,7 @@ in are synonyms, as are \-filled and \-ragged. . .It -In +In .Xr groff 1 , the .Sq \&Pa @@ -446,7 +446,7 @@ escape will revert the font to the previous .Sq \ef escape, not to the last rendered decoration, which is now dictated by CSS instead of hard-coded. It also will not span past the current -scope, for the same reason. Note that in +scope, for the same reason. Note that in .Sx ASCII Output mode, this will work fine. .It diff --git a/mdoc.3 b/mdoc.3 index 5c6ac4ac..35b13f6e 100644 --- a/mdoc.3 +++ b/mdoc.3 @@ -1,4 +1,4 @@ -.\" $Id: mdoc.3,v 1.35 2009/10/03 16:36:06 kristaps Exp $ +.\" $Id: mdoc.3,v 1.36 2010/01/07 19:10:09 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: October 3 2009 $ +.Dd $Mdocdate: January 7 2010 $ .Dt MDOC 3 .Os .\" SECTION @@ -274,7 +274,7 @@ line = 1; mdoc = mdoc_alloc(NULL, 0, NULL); while ((buf = fgetln(fp, &len))) { - buf[len - 1] = '\\0'; + buf[len - 1] = '\e0'; if ( ! mdoc_parseln(mdoc, line, buf)) errx(1, "mdoc_parseln"); line++; diff --git a/mdoc.7 b/mdoc.7 index 84dad13e..8207c8b2 100644 --- a/mdoc.7 +++ b/mdoc.7 @@ -1,4 +1,4 @@ -.\" $Id: mdoc.7,v 1.81 2010/01/01 16:52:00 kristaps Exp $ +.\" $Id: mdoc.7,v 1.82 2010/01/07 19:10:10 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: January 1 2010 $ +.Dd $Mdocdate: January 7 2010 $ .Dt MDOC 7 .Os . @@ -132,7 +132,7 @@ and Terms may be text-decorated using the .Sq \ef escape followed by an indicator: B (bold), I, (italic), R (Roman), or P -(revert to previous mode): +(revert to previous mode): .Pp .D1 \efBbold\efR \efIitalic\efP .Pp @@ -170,19 +170,19 @@ for arbitrary-digit numerals: .D1 \es+(10much bigger\es-(10 .D1 \es+'100'much much bigger\es-'100' .Pp -Note these forms are +Note these forms are .Em not -recommended for +recommended for .Nm , which encourages semantic annotation. . . .Ss Predefined Strings -Historically, +Historically, .Xr groff 1 -also defined a set of package-specific +also defined a set of package-specific .Dq predefined strings , -which, like +which, like .Sx Special Characters , demark special output characters and strings by way of input codes. Predefined strings are escaped with the slash-asterisk, @@ -343,7 +343,7 @@ and .Sx \&Os macros, is required for every document. .Pp -The first section (sections are denoted by +The first section (sections are denoted by .Sx \&Sh ) must be the NAME section, consisting of at least one .Sx \&Nm @@ -420,7 +420,7 @@ macro(s) must precede the .Sx \&Nd macro. .Pp -See +See .Sx \&Nm and .Sx \&Nd . @@ -438,7 +438,7 @@ See . .It Em SYNOPSIS Documents the utility invocation syntax, function call syntax, or device -configuration. +configuration. .Pp For the first, utilities (sections 1, 6, and 8), this is generally structured as follows: @@ -469,10 +469,10 @@ And for the third, configurations (section 4): \&.Cd \*qit* at isa? port 0x4e\*q .Ed .Pp -Manuals not in these sections generally don't need a +Manuals not in these sections generally don't need a .Em SYNOPSIS . .Pp -See +See .Sx \&Op , .Sx \&Cd , .Sx \&Fn , @@ -481,7 +481,7 @@ and .Sx \&Vt . . .It Em DESCRIPTION -This expands upon the brief, one-line description in +This expands upon the brief, one-line description in .Em NAME . It usually contains a break-down of the options (if documenting a command), such as: @@ -683,7 +683,7 @@ All macros have bodies; some don't have heads; only one .Po .Sx \&It Fl column -.Pc +.Pc has multiple heads. .Bd -literal -offset indent \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB @@ -866,7 +866,7 @@ then the macro accepts an arbitrary number of arguments. .It Sx \&Xr Ta Yes Ta Yes Ta >0, <3 .It Sx \&br Ta \&No Ta \&No Ta 0 .It Sx \&sp Ta \&No Ta \&No Ta 1 -.El +.El . . .Sh REFERENCE @@ -1026,7 +1026,7 @@ a function: .Ed . .Ss \&Aq -Encloses its arguments in angled brackets. +Encloses its arguments in angled brackets. .Pp Examples: .Bd -literal -offset indent @@ -1073,7 +1073,7 @@ Note that these parameters do not begin with a hyphen. .Pp Examples: .Bd -literal -offset indent -\&.At +\&.At \&.At V.1 .Ed .Pp @@ -1242,7 +1242,7 @@ See also .Sx \&Bq . . .Ss \&Bq -Encloses its arguments in square brackets. +Encloses its arguments in square brackets. .Pp Examples: .Bd -literal -offset indent @@ -1389,7 +1389,7 @@ manual. Its calling syntax is as follows: .Pp .D1 \. Ns Sx \&Dd Cm date .Pp -The +The .Cm date field may be either .Ar $\&Mdocdate$ , @@ -1438,7 +1438,7 @@ See also .Sx \&Dq . . .Ss \&Dq -Encloses its arguments in double quotes. +Encloses its arguments in double quotes. .Pp Examples: .Bd -literal -offset indent @@ -1924,9 +1924,9 @@ the macro does not format its arguments when used in the FILES section under certain list types. This irregular behaviour has been discontinued. .It -Historic +Historic .Xr groff 1 -does not print a dash for empty +does not print a dash for empty .Sx \&Fl arguments. This behaviour has been discontinued. .It -- cgit v1.2.3-56-ge451