From: Jason McIntyre <jmc@kerhand.co.uk>
To: discuss@mdocml.bsd.lv
Subject: Re: man.7 tweaks
Date: Sat, 24 Jul 2010 15:50:39 +0059 [thread overview]
Message-ID: <20100724145103.GA23978@bramka.kerhand.co.uk> (raw)
In-Reply-To: <20100724135918.GC26858@iris.usta.de>
On Sat, Jul 24, 2010 at 03:59:18PM +0200, Ingo Schwarze wrote:
>
> > i'm trying to work out what the best way forward is.
>
> Send the patch! ;-)
>
urgle!
Index: man.7
===================================================================
RCS file: /cvs/src/share/man/man7/man.7,v
retrieving revision 1.3
diff -u -r1.3 man.7
--- man.7 19 Jul 2010 23:06:29 -0000 1.3
+++ man.7 24 Jul 2010 13:23:14 -0000
@@ -111,7 +111,7 @@
attribute is forgotten when entering or exiting a macro block.
.Ss Whitespace
Whitespace consists of the space character.
-In free-form lines, whitespace is preserved within a line; un-escaped
+In free-form lines, whitespace is preserved within a line; unescaped
trailing spaces are stripped from input (unless in a literal context).
Blank free-form lines, which may include spaces, are permitted and
rendered as an empty line.
@@ -190,23 +190,25 @@
which, if a unit is not provided, will instead interpret the string as
literal text.
.Ss Sentence Spacing
-When composing a manual, make sure that your sentences end at the end of
+When composing a manual, make sure that sentences end at the end of
a line.
By doing so, front-ends will be able to apply the proper amount of
spacing after the end of sentence (unescaped) period, exclamation mark,
or question mark followed by zero or more non-sentence closing
-delimiters (
-.Ns Sq \&) ,
+delimiters
+.Po
+.Sq \&) ,
.Sq \&] ,
.Sq \&' ,
-.Sq \&" ) .
+.Sq \&"
+.Pc .
.Sh MANUAL STRUCTURE
Each
.Nm
-document must contain contains at least the
+document must contain the
.Sx \&TH
macro describing the document's section and title.
-It may occur anywhere in the document, although conventionally, it
+It may occur anywhere in the document, although conventionally it
appears as the first macro.
.Pp
Beyond
@@ -291,10 +293,7 @@
This is useful when implementing standard functions that may have side
effects or notable algorithmic implications.
.It Em RETURN VALUES
-This section is the dual of
-.Em EXIT STATUS ,
-which is used for commands.
-It documents the return values of functions in sections 2, 3, and 9.
+This section documents the return values of functions in sections 2, 3, and 9.
.It Em ENVIRONMENT
Documents any usages of environment variables, e.g.,
.Xr environ 7 .
@@ -303,10 +302,8 @@
It's helpful to document both the file name and a short description of how
the file is used (created, modified, etc.).
.It Em EXIT STATUS
-Command exit status for section 1, 6, and 8 manuals.
-This section is the dual of
-.Em RETURN VALUES ,
-which is used for functions.
+This section documents the command exit status for
+section 1, 6, and 8 utilities.
Historically, this information was described in
.Em DIAGNOSTICS ,
a practise that is now discouraged.
@@ -314,7 +311,7 @@
Example usages.
This often contains snippets of well-formed,
well-tested invocations.
-Make doubly sure that your examples work properly!
+Make sure that examples work properly!
.It Em DIAGNOSTICS
Documents error conditions.
This is most useful in section 4 manuals.
@@ -351,13 +348,13 @@
Common misuses and misunderstandings should be explained
in this section.
.It Em BUGS
-Known bugs, limitations and work-arounds should be described
+Known bugs, limitations, and work-arounds should be described
in this section.
.It Em SECURITY CONSIDERATIONS
Documents any security precautions that operators should consider.
.El
.Sh MACRO SYNTAX
-Macros are one to three three characters in length and begin with a
+Macros are one to three characters in length and begin with a
control character,
.Sq \&. ,
at the beginning of the line.
@@ -444,8 +441,8 @@
.Nm
manuals.
.Ss Block Macros
-Block macros are comprised of a head and body.
-Like for in-line macros, the head is scoped to the current line and, in
+Block macros comprise a head and body.
+As with in-line macros, the head is scoped to the current line and, in
one circumstance, the next line (the next-line stipulations as in
.Sx Line Macros
apply here as well).
@@ -602,8 +599,8 @@
and
.Sx \&r .
.Ss \&IB
-Text is rendered alternately in italics and bold face. Whitespace
-between arguments is omitted in output.
+Text is rendered alternately in italics and bold face.
+Whitespace between arguments is omitted in output.
.Pp
See
.Sx \&BI
@@ -626,7 +623,7 @@
The
.Cm width
argument defines the width of the left margin and is defined by
-.Sx Scaling Widths ,
+.Sx Scaling Widths .
It's saved for later paragraph left-margins; if unspecified, the saved or
default width is used.
.Pp
@@ -943,7 +940,7 @@
The stand-alone implementation that is part of the
.Xr mandoc 1
utility written by Kristaps Dzonsons appeared in
-.Ox 4.6.
+.Ox 4.6 .
.Sh AUTHORS
This
.Nm
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next prev parent reply other threads:[~2010-07-24 14:51 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-07-24 13:32 Jason McIntyre
2010-07-24 13:59 ` Ingo Schwarze
2010-07-24 14:51 ` Jason McIntyre [this message]
2010-07-24 18:47 ` Ingo Schwarze
2010-07-24 15:04 ` Jason McIntyre
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20100724145103.GA23978@bramka.kerhand.co.uk \
--to=jmc@kerhand.co.uk \
--cc=discuss@mdocml.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).