diff options
author | G. Branden Robinson <g.branden.robinson@gmail.com> | 2017-11-05 08:03:46 -0500 |
---|---|---|
committer | G. Branden Robinson <g.branden.robinson@gmail.com> | 2017-11-05 09:41:23 -0500 |
commit | 7ca66dd2987146f597f29ffdbc00dcd3084fecb4 (patch) | |
tree | 9df932dacf4dca6d975dd5184c380291b4814ec9 /contrib/chem | |
parent | f3d6a1bc693aeac1f3e6b34c1b255d8c498f76dd (diff) | |
download | groff-git-7ca66dd2987146f597f29ffdbc00dcd3084fecb4.tar.gz |
man pages: Rationalize author sections.
Part 1 of a man page author and copyright information overhaul; see
https://lists.gnu.org/archive/html/groff/2017-11/msg00013.html et seq.
Thanks to Werner Lemberg, Ingo Schwarze, and Ralph Corderoy for their
feedback and support.
* Stop defining page-local "au" macros to store author information.
* Instead, move it directly inline in the page, as is common practice
elsewhere.
I made several cleanups along the way, but only to material in the
AUTHORS section:
* Researched (insofar as I was able) and added program and macro package
author information. Something seems slightly wrong to me to have a
man page that documents some other work and then identify only the
authors of the man page itself. (By contrast, some section 5 and 7
man pages are sui generis.)
* Where the page documented a GNU reimplementation of a historical roff
work (program or macro package), clarify the point.
* Don't refer to the original Berkeley grn as @g@grn; it'll be wrong if
anyone sets the program prefix.
* Discuss "this document" or a program rather than "this file".
* Changed inline email addresses to use MT/ME macros.
* Escaped hyphens in arguments to MT and UR macros.
* Dropped unnecessary quotation marks from the argument to SH.
* Call the section AUTHORS even if there is only one author, for
consistency and future-proofing. This is what the man-pages project
folks call it, too, even though they discourage its use.
* Added discretionary hyphenless breakpoints to MT and UR macros (not
comprehensively, though).
* Set the page's own name in bold where this was not already done.
* Set references to software tools and systems in italics where they
were not (1) man page cross references; or (2) the topic of the
immediate page.
* Relocate AUTHORS section to immediately precede SEE ALSO section.
Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Diffstat (limited to 'contrib/chem')
-rw-r--r-- | contrib/chem/chem.1.man | 31 |
1 files changed, 19 insertions, 12 deletions
diff --git a/contrib/chem/chem.1.man b/contrib/chem/chem.1.man index 7910e72b9..b0c26b7b6 100644 --- a/contrib/chem/chem.1.man +++ b/contrib/chem/chem.1.man @@ -26,14 +26,6 @@ The license text for GPL2 is available in the internet at .UE . .. . -.de au -This file was written by Bernd Warken <groff-bernd.warken-72@web.de>. - -It is based on the documentation of Brian Kernighan's original awk -version of chem at -.UR http://cm.bell-labs.com/cm/cs/who/bwk/index.html -.UE . -.. . .\" ==================================================================== .\" Setup @@ -964,6 +956,25 @@ for information on availability. . . .\" ==================================================================== +.SH AUTHORS +.\" ==================================================================== +The GNU version of +.B chem +was written by +.MT groff\-bernd.warken\-72@web.de +Bernd Warken +.ME . +. +It is based on the documentation of Brian Kernighan's original +.I awk +version of +.I chem +at +.UR http://cm.bell\-labs.com/\:cm/cs/who/bwk/index.html +.UE . +. +. +.\" ==================================================================== .SH "SEE ALSO" .\" ==================================================================== . @@ -996,10 +1007,6 @@ is .SH "COPYING" .\" ==================================================================== .co -.\" ==================================================================== -.SH "AUTHORS" -.\" ==================================================================== -.au . . .cp \n[groff_C] |