[bug #61958] document all shipped tmac files somewhere

[G. Branden Robinson]

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

                 Summary: document all shipped tmac files somewhere
                 Project: GNU troff
            Submitted by: gbranden
            Submitted on: Sat 29 Jan 2022 04:45:21 AM UTC
                Category: Macro - others/general
                Severity: 3 - Normal
              Item Group: Documentation
                  Status: None
                 Privacy: Public
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: None

    _______________________________________________________

Details:

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.





    _______________________________________________________

Reply to this item at:

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

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/