develooper Front page | perl.perl5.porters | Postings from April 2010

Re: RFC: Perl manual pages -- update to follow the perlstyle.podguidelines

Thread Previous | Thread Next
From:
karl williamson
Date:
April 6, 2010 06:55
Subject:
Re: RFC: Perl manual pages -- update to follow the perlstyle.podguidelines
Message ID:
4BBB3D2D.4090807@khwilliamson.com
Nicholas Clark wrote:
> On Sat, Apr 03, 2010 at 04:38:24PM -0600, Tom Christiansen wrote:
> 
>> BTW, the reason why examples like this:
>>
>>    #  0    1    2     3     4    5     6     7     8
>>    ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
>>                                                localtime(time);
>>
>> are *not* written
>>
>>
>>    # 0     1     2      3      4     5      6      7      8
>>    ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst) =
>>                                                localtime(time);
>>
>> is due to the default nroff line length.
> 
> What is the default nroff line length?

I think he means the default man page line length in nroff.  According 
to my Ubuntu man pages, it is 78 mono-space characters.  And text is 
indented 8 characters, so that leaves 70.    But it actually expands or 
shrinks depending on my terminal window width.  I think that assuming 
the window is at least 80 characters is acceptable, which yields 72 
effectively.

I've often wished that pod had some sort of table feature which would do 
automatic formatting for you.  I would still do all my documents in 
troff if support were any good for it in Linux.  But it seems that each 
release gets worse, so I haven't tried it in years.  I doubt then that 
the built-in tbl, which I assume is on all Linuxes would do a good job, 
so this seems like a vain hope.

> 
> And do we have any sort of Pod linter in core that will warn if our
> preformatted sections are "too" wide, such that they'd render to badly
> formatted man page?

If we do, it doesn't work very well.



Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About