Re: [Groff] ping: let man print volume headers like mdoc

[Ingo Schwarze]

Hi Walter,

> Basicly it seems ok for me, ntl some (non roff note).
> * Sun Release 4.0        Why ?

That's a comment, and my patch doesn't touch it.
I guess whoever put it there wanted to provide an example
how the fourth argument might look like.

> The names differ from what i see in the man page.
> e.g.: Sec 4   Special files

Cannot reproduce; and indeed, tmac/doc-common in the official
groff CVS repo has:

  .ds doc-volume-ds-4 Kernel Interfaces Manual

Maybe "Special files" is specific to your operating system
or even the particular page you are looking at (you mentioned
neither unless i missed it).

> Should that be in sync also ?

As far as i can see, it is.

Yours,
  Ingo


>> ----- Forwarded message from Ingo Schwarze <address@hidden> -----
>> 
>> From: Ingo Schwarze <address@hidden>
>> Date: Tue, 1 Nov 2011 19:43:27 +0100
>> To: address@hidden
>> Subject: [Groff] let man print volume headers like mdoc
>> 
>> Hi,
>> 
>> When the mdoc(7) .Dt macro is called without a third argument,
>> the page header uses the default volume name associated with
>> the second (section number) .Dt argument, controlled by the
>> doc-volume-ds-N strings in tmac/doc-common.
>> 
>> On the other hand, when the corresponding man(7) .TH macro is
>> called without a fifth argument, the volume name in the page
>> header is left blank.
>> 
>> Yuri Pankov (of IllumOS) suggested to make the two more similar
>> by letting man(7) fill in the default volume name as well.
>> I like the idea - reducing gratuitious differences between
>> mdoc(7) and man(7) seems good to me - and would like to
>> implement the change in mandoc(1).
>> 
>> However, keeping groff(1) and mandoc(1) in sync is even more
>> important than synching mdoc(7) and man(7), so i'm asking for
>> your opinion first, whether you would accept the following patch,
>> or a variant of it.
>> 
>> I think the strings are so short that there is no problem
>> with having them both in doc-common and an-old.tmac;
>> on the other hand, if you disagree, i could move them to
>> their own file and include them from both places, but
>> i fear the code will be uglier, whereas this looks quite nice.
>> 
>> Yours,
>>   Ingo
>> 
>> 
>> --- tmac/an-old.tmac.orig    Fri Dec 31 08:33:09 2010
>> +++ tmac/an-old.tmac Sun Oct 30 22:37:29 2011
>> @@ -145,7 +145,17 @@
>>  .    ie (\\n[.$] > 3) .ds an-extra2 "\\$4\"
>>  .    el               .ds an-extra2 \"Sun Release 4.0
>>  .    ie (\\n[.$] > 4) .ds an-extra3 "\\$5\"
>> -.    el               .ds an-extra3 \"System Programmer's Manual
>> +.    el .ie '\\$2'1'  .ds an-extra3 General Commands Manual
>> +.    el .ie '\\$2'2'  .ds an-extra3 System Calls Manual
>> +.    el .ie '\\$2'3'  .ds an-extra3 Library Functions Manual
>> +.    el .ie '\\$2'3p' .ds an-extra3 Perl Programmers Reference Guide
>> +.    el .ie '\\$2'4'  .ds an-extra3 Kernel Interfaces Manual
>> +.    el .ie '\\$2'5'  .ds an-extra3 File Formats Manual
>> +.    el .ie '\\$2'6'  .ds an-extra3 Games Manual
>> +.    el .ie '\\$2'7'  .ds an-extra3 Miscellaneous Information Manual
>> +.    el .ie '\\$2'8'  .ds an-extra3 System Manager's Manual
>> +.    el .ie '\\$2'9'  .ds an-extra3 Kernel Developer's Manual
>> +.    el               .ds an-extra3
>>  .    ds an-init
>>  \\..
>>  .