Re: charmap.5: clarify keyword syntax

["Michael Kerrisk (man-pages)" <mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>]

On 06/15/2016 09:58 AM, Marko Myllynen wrote:
> Hi,
> 
> On 2016-06-14 19:56, Mike Frysinger wrote:
>> On 13 Jun 2016 10:20, Marko Myllynen wrote:
>>> The patch below updates charmap.5 to match the syntax all the glibc
>>> charmap files are using currently.
>>
>> hmm, i guess this is confusing.  when i read the man page, i see it as
>> the normal syntax of "<required value>" rather than the <> being literal
>> characers that you need to type out.  although in that regard, i would
>> expect it to look something like:
>> 	<character> <byte-sequence> [comment]
>>
>> although in the locale(5) page, we rarely use the <foo> syntax.
> 
> Yes, in the locale(5) page <foo> is now used only in cases like:
> 
>   The characters <space> and <tab> are automatically included.
> 
> In the glibc charmap files the <> notation is used with keywords, the
> man pages states that comment is optional but would it make thing
> clearer if we would use something like:
> 
> .TP
> <
> .I code_set_name
>> is followed by the name of the character map.
> 
> (Ok, that renders badly but you get the idea.)

I'd take patches to fix this. 

I think you want:

.TP
.RI < code_set_name >

Cheers,

Michael



-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html