[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[bug #59222] Issues with groff man pages
From: |
G. Branden Robinson |
Subject: |
[bug #59222] Issues with groff man pages |
Date: |
Thu, 8 Oct 2020 07:58:59 -0400 (EDT) |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Firefox/68.0 |
Update of bug #59222 (project groff):
Item Group: None => Documentation
Status: None => Fixed
Assigned to: None => gbranden
Open/Closed: Open => Closed
Planned Release: None => 1.22.5
_______________________________________________________
Follow-up Comment #1:
Thanks for the report, Helge.
[comment #0 original submission:]
> Man page: groff.1
> Issue: Why B<and> but not B<7>?
>
> "I<groff> has man pages in sections B<1>,B< 5>,B<and> 7B<.>"
> --
> Man page: groff.1
> Issue: English sentence broken (and sentence garbage: »in the same
section« and »with the lowset section«)
>
> "When there are several I<man pages> with the same name in the same I<man>
"
> "section, the one with the lowest section is should as first."
> --
The above 2 issues were both resolved through elimination of the material.
commit 550ab5338e04e54539214997315f451c89ac25e6
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date: Mon Sep 14 21:10:15 2020 +1000
man pages: Remove unncessary material.
[...]
* src/roff/groff/groff.1.man: Remove novice-oriented material
introducing the concept of man page section numbers and man(1) usage
advice. This is not appropriate here; intro(1) is the proper place.
> Man page: soelim.1
> Issue: missing whitespace
>
> "B<-I>I<dir>"
This one has just been fixed alongside a bunch of other changes to the page.
commit 7eca9c3c6d0efdbb29dcedad51d18d4c4993a22a (HEAD -> master,
origin/master, origin/HEAD)
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date: Thu Oct 8 22:11:38 2020 +1100
soelim(1): Fix style problems.
* Update apropos summary. Expand ".so" request to its mnemonic
(source), and characterize input as "troff" instead of "groff" since,
in contrast to some GNU roff preprocessors, GNU soelim should work
fine for traditional troff input.
* Define and use string for rendering the TeX logo correctly on
typesetter devices, like other groff man pages.
* Stop using .OP macro in favor of font macros. Also place explicit
space between option flag and its argument.
* Rename "file" parameter to "input-file" for disambiguation.
* Recast description to clearly distinguish arguments to soelim from
arguments to .so requests in the processed input.
* Note that soelim works recursively.
* Note how soelim treats standard input and output.
* Use font changes as well as quotation marks to clarify discussion of
escape sequences recognized by soelim.
* Call out "\[rs]" as _not_ recognized.
* Remove unneeded "Note that" construction (here's to you, Dave Kemper).
* Set command names in italics.
* Use command prefix consistently; it was neglected in places.
* The command prefix creates pain for the diagrams used in this man
page; if there is a command prefix, add language noting the different
usage in the diagram, guarded by an .if request. Put a dollar in the
man page swear jar. Add comment explaining what's going on.
* Replace .nf and .fi requests with .EX and .EE macros.
* Use arrow and bracket-building glyphs instead of ASCII art for arrows
in terminal versions of diagrams.
* Recast description of -I option in imperative mood. Also place
explicit space between option flag and its argument.
* Break input lines after commas and semicolons.
* Put parenthetical asides on their own input lines.
_______________________________________________________
Reply to this item at:
<https://savannah.gnu.org/bugs/?59222>
_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/