* Colin Watson <[EMAIL PROTECTED]> [2005-04-12 18:35]:

> On Tue, Apr 12, 2005 at 07:06:28PM +0200, Rafael Laboissiere wrote:
>
> > Or am I misunderstanding your proposal?
> 
> You are. Currently, Pod::Man puts *(C` and *(C' in the NAME section. I'm
> suggesting that, when it's generating the NAME section, it should as a
> special case *itself* expand *(C` and *(C' to " - or, perhaps
> preferably, just leave them out altogether - rather than relying on
> nroff/troff to do it.
> 
> This has the disadvantage that you don't quite get the semantics of *(C`
> and *(C' (namely that in nroff they expand to " but in troff they expand
> to nothing, because in troff the constant-width font is visible), but
> you can't have everything. The NAME section is short enough that losing
> a bit of sophisticated markup isn't very important, and it's never been
> a good idea to use sophisticated markup there anyway.

Thinking more about it, I finally agree with your arguments. We should
consider the NAME section of a manpage as a kind of machine-readable
description.  For instance, it would make no sense to have markups like
bold and italics in it.

However, *(C` and *(C' represent quotes and, since quotes can be safely
represented in ascii with '"', the authors of the POD sections in
packages concerned by this bug report should make this change.

-- 
Rafael


-- 
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]

Reply via email to