bugGNU troff - Bugs: bug #43532, [PATCH] man: put titles on...

 
 

bug #43532: [PATCH] man: put titles on separate lines when parts too wide, instead of overlapping them

Submitted by:  Osamu Sayama <sayama>
Submitted on:  Wed 05 Nov 2014 06:09:18 AM UTC  
 
Category:  Macro - man Severity:  1 - Wish
Item Group:  New feature Status:  Confirmed
Privacy:  Public Assigned to:  None
Open/Closed:  Open Planned Release:  None

Add a New Comment (Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Sat 25 Jul 2020 11:22:09 AM UTC, comment #3: 

For comparison, here is what mandoc does:

 $ mandoc
.TH CosNotifyChannelAdmin_StructuredProxyPushSupplier 3erl "cosNotification 1.1.18" "Ericsson AB" "Erlang Module Definition"
CosNotifyChannelAdmin_StructuredProxyPushSupplier(3erl)
                                                      Erlang Module Definition



Ericsson AB                 cosNotification 1.1.18
                       CosNotifyChannelAdmin_StructuredProxyPushSupplier(3erl)
$

Note that

  • CosNotify... is left justified on line 1
  • Erlang Module Definition   is right justified on line 2
  • Ericsson AB   is left justified
  • cosNotification 1.1.18   is centered
  • CosNotify... is right justified on the last line

I did not inspect the patch yet.

Ingo Schwarze <schwarze>
Project Member
Mon 01 Dec 2014 08:51:38 AM UTC, comment #2: 

Yes, I modified the patch to work with -rLT (and -rLL) by
using .lt and it worked ok for me.
I uploaded revised one as an-old.tmac-long-TH.patch2.

(file #32577)

Osamu Sayama <sayama>
Wed 05 Nov 2014 12:26:18 PM UTC, comment #1: 

I noticed this patch fixes the space at 4.3 inches, but groff_man specifies that the title line length can be changed by setting -rLT (or -rLL) to a different width, so should not this patch take this into account. (NB I have not actually tested the patch yet).

Deri James <deri>
Project Member
Wed 05 Nov 2014 06:09:18 AM UTC, original submission:  

For example, erlang has many long .TH man pages.
---
% grep '^.TH' /usr/share/man/man3erl/CosNotifyChannelAdmin_StructuredProxyPushSu
pplier.3erl
.TH CosNotifyChannelAdmin_StructuredProxyPushSupplier 3erl "cosNotification 1.1.
18" "Ericsson AB" "Erlang Module Definition"
---
If such a long .TH file is processed by groff, header and
fooder are displayed by overlapping.
---
% grep '^.TH' /usr/share/man/man3erl/CosNotifyChannelAdmin_StructuredProxyPushSu
pplier.3erl | gtroff -man -T ascii|grotty -c
CosNotifyChannelAdmin_SCosNotifyChannelAdmin_StructuredProxyPushSupplier(3erl)

Ericsson AB            CosNotifyChannelAdmin_StructuredProxyPushSupplier(3erl)
---
I created a patch for an-old.tmac to be displayed by two lines
if it is long.
---
% grep '^.TH' /usr/share/man/man3erl/CosNotifyChannelAdmin_StructuredProxyPushSu
pplier.3erl | gtroff -man -T ascii|grotty -c
Erlang Module Definition
                       CosNotifyChannelAdmin_StructuredProxyPushSupplier(3erl)

Ericsson AB                 cosNotification 1.1.18
                       CosNotifyChannelAdmin_StructuredProxyPushSupplier(3erl)
---
It would be great if long .TH is handled by two lines like this.

Osamu Sayama <sayama>

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #32577:  an-old.tmac-long-TH.patch2 added by sayama (4KiB - application/octet-stream)
file #32370:  an-old.tmac-long-TH.patch added by sayama (2KiB - text/x-diff)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gbranden (Updated the item)
  • -email is unavailable- added by schwarze (Updated the item)
  • -email is unavailable- added by deri (Posted a comment)
  • -email is unavailable- added by sayama (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

     

     

    Follow 8 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-07-25 gbranden Severity2 - Minor => 1 - Wish
        Summarygroff handles long .TH as overlaping in header and footer => [PATCH] man: put titles on separate lines when parts too wide, instead of overlapping them
    2018-02-16 schwarze CategoryNone => Macro - man
        Severity3 - Normal => 2 - Minor
        Item GroupNone => New feature
        StatusNone => Confirmed
    2014-12-01 sayama Attached File- => Added an-old.tmac-long-TH.patch2, #32577
    2014-11-05 sayama Attached File- => Added an-old.tmac-long-TH.patch, #32370

    Back to the top


    Powered by Savane 3.5