]> diplodocus.org Git - nmh/blobdiff - docs/README.manpages
README.manpages: Add question to guide update of .TH's date.
[nmh] / docs / README.manpages
index e266953..5b2c274 100644 (file)
@@ -27,10 +27,10 @@ Troff Considerations
        When quoting, use \*(lq and \*(rq. This ensures correct
        formatting on typesetter-like devices.
 
        When quoting, use \*(lq and \*(rq. This ensures correct
        formatting on typesetter-like devices.
 
-       Don't use UTF-8 characters in the manpage source.  We still
-       build and run on systems that can't handle this.  And most
-       anything you would want to use has an internal troff character
-       escape sequence, anyway.
+        A man page's source is ASCII, not UTF-8.  troff has escapes for
+        non-ASCII characters, e.g. \(em for an em-dash, U+2014, that are
+        mapped onto whatever the output device supports, e.g. UTF-8 or
+        PDF.
 
 
 Section Ordering
 
 
 Section Ordering
@@ -61,10 +61,11 @@ Section Ordering
 
 Dates
 
 
 Dates
 
-       The DATE in the .TH macro should reflect the most recent
-       *non-trivial* update to the *content* of the manpage;
-       formatting changes don't count, nor does expanding the `SEE
-       ALSO' list.  The date is in `yyyy-mm-dd' format.
+        The DATE in the .TH macro is in `yyyy-mm-dd' format, and should
+        reflect the most recent *non-trivial* update to the *content* of
+        the manpage; formatting changes don't count, nor does expanding
+        the `SEE ALSO' list.  Ask "Would the familiar user wish to
+        re-read this page to learn of this change?"
 
 
 Program Names
 
 
 Program Names