From 05ca9f20a8229a96f319eda99f0cfd725a51d3cb Mon Sep 17 00:00:00 2001 From: Stephen Gregoratto Date: Tue, 20 Nov 2018 01:42:31 +1100 Subject: [PATCH] Omit needless words, change description to UNIX/BSD style. Regardless of standards considerations, if there's any advice that needs to be hammered into man authors, it's to be concise and accurate, but not pedantic. As Will Strunk commanded, "Omit needless words." The most needless words of all are promotional. No man page should utter words like "powerful", "extraordinarily versatile", "user-friendly", or "has a wide range of options". -- Doug McIlroy[1] [1] https://lists.gnu.org/archive/html/groff/2018-11/msg00058.html --- scdoc.1.scd | 10 ++++------ scdoc.5.scd | 2 +- diff --git a/scdoc.1.scd b/scdoc.1.scd index 4153c10083b473aedd9f6321e1c26c8cf2b37292..74c38d2ab5afb627c1269e08f3f5261077762863 100644 --- a/scdoc.1.scd +++ b/scdoc.1.scd @@ -2,18 +2,16 @@ scdoc(1) # NAME -scdoc - tool for generating *roff*(7) manual pages +scdoc - generate *man*(7) manual pages # SYNOPSIS -*scdoc* < _input_ > _output_ +*scdoc* < _input_ # DESCRIPTION -scdoc is a tool designed to make the process of writing man pages more -friendly. It reads scdoc syntax from stdin and writes roff to stdout, suitable -for reading with *man*(1). For a description of the syntax of scdoc source -files, see *scdoc*(5). +The scdoc utility reads *scdoc*(5) syntax from the standard input and writes +*man*(7) style roff to the standard output. # SEE ALSO diff --git a/scdoc.5.scd b/scdoc.5.scd index dfe5353a10279f626a10e66cca93984ebd424ee7..42c1ec06c3c229afd44fe85b159de0e34c6fc3f3 100644 --- a/scdoc.5.scd +++ b/scdoc.5.scd @@ -14,7 +14,7 @@ Each scdoc file must begin with the following preamble: *name*(_section_) ["left\_footer" ["center\_header"]] -The *name* is the name of the man page you are writing, and _section_ is the +*name* is the name of the man page you are writing, and _section_ is the section you're writing for (see *man*(1) for information on manual sections). _left\_footer_ and _center\_header_ are optional arguments which set the text -- 2.48.1