bugGNU roff - Bugs: bug #61958, document all shipped tmac files...

 
 

bug #61958: document all shipped tmac files somewhere

Submitter:  G. Branden Robinson <gbranden>
Submitted:  Sat 29 Jan 2022 04:45:21 AM UTC
   
 
Category:  Macro - others/general Severity:  3 - Normal
Item Group:  Documentation Status:  In Progress
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Open Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Mon 21 Feb 2022 11:17:14 AM UTC, comment #1: 


commit 922751f8bf764b513e61ac634f7e52aaa6565d6e
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Feb 14 18:43:15 2022 +1100

    [man pages]: Fix content, style, markup nits.

    Content:
    * Improve example in grops(1) to be more effective; just setting an
      unexported environment variable won't work.  Show the command
      following it on the same input line.
    * groff_me(7) (Files): Document use of refer-me.tmac file.
    * groff_ms(7) (Files): Documsnt use of refer-ms.tmac file.
    * grops(1): Fix missing colon after tag in device control command
      example.

    Style:
    * When joining two independent clauses with a colon, the second is not
      to be capitalized as a sentence.
    * Stop dangling an example command line as the incomplete end of a
      sentence.
    * Recast and tighten.

    Markup:
    * grops(1): Use RS/EX/EE/RE to bracket examples, not IP/B.  Reduce use
      of vertical spacing around examples that are inlined into sentences.
      Set command names in italics, not bold.  Try a new idiom for
      multi-paragraph tagged item discussions with embedded examples.
    * groff_tmac(5): Mark up man(1) and (g)soelim references with `MR` and
      `I`, respectively.
    * Break lines before multi-word parentheticals and after commas.
    * Use `P` paragraphing macro instead of `LP`.

    Partially addresses <https://savannah.gnu.org/bugs/?61958>.


commit 91a048aa09f5c77456ab83373c2a86e73293afc2
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Feb 21 04:42:27 2022 +1100

    groff_char(7): Recast accent/composite stuff.

    Add a "Files" section as well, in pursuit of the quest to document all
    of our macro files.


G. Branden Robinson <gbranden>
Group administrator
Sat 29 Jan 2022 04:45:21 AM UTC, original submission:  

All macro files we ship that end up in the tmac/ directory
should be documented somewhere.

Full-service macro packages have their own man pages.

So do some auxiliary ones (hdtbl, rfc1345, trace, www).  Others
are documented in groff_tmac(5) (62bit, ec, papersize, pdfpic,
pspic, ptx, sboxes).

I'm not sure I'd call tty-char an "auxiliary" one, though under
a strict definition of the term ("not full-service"), it is.

Localization macro files are documented in groff_tmac(5).

We don't even have an official term for "device" macro files
like ps.tmac, pdf.tmac, and tty.tmac, that are unconditionally
loaded corresponding to the -T option (or device default).
These are probably best documented in each driver's man page.

`safer` is empty and slated for the chopping block (bug #61831).

There are others.

`a4` is 3 years older than `papersize`; the latter totally
subsumes its function.  Should probably be deprecated for groff
1.23 and then retired in 1.24 (or, more aggressively, 1.23.0-rc2
and then 1.23.0).

Maybe that issue should move into bug #61831 as well.

Things like "psatk" and "psfig" are not really documented
anywhere outside of the NEWS file.

G. Branden Robinson <gbranden>
Group administrator

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gbranden (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-02-21 gbranden StatusNone In Progress
        Assigned toNone gbranden

    Back to the top

    Powered by Savane 3.12.
    Corresponding source code