[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [RP] [PATCH] improve new manpage layout

From: Bernhard R. Link
Subject: Re: [RP] [PATCH] improve new manpage layout
Date: Wed, 26 Mar 2014 20:42:33 +0100
User-agent: Mutt/1.5.23 (2014-03-12)

* Jérémie Courrèges-Anglas <address@hidden> [140325 22:21]:
> "Bernhard R. Link" <address@hidden> writes:
> > Make everything to be typed in that way Ic,
> Literal strings are literal strings.  In some contexts they can be
> treated as command modifiers (Cm), but not as internal commands on their
> own.

Well, I'm not sure which sementic is correct from them. But what I know
is that their layout is wrong. They are printed as normal text (thus
like the markers for optional / alternate arguments) but not bold as
they should be so that people know which parts are to be typed in that

> > use Br* to denote
> > alternates,
> I disagree.  Square brackets denote optional arguments.  Using Op is
> perfect here, from semantic and presentation points of view.

My description was perhaps a bit too short: I mean

"use Br* to denote non-optional alternates".
(I've kept [ ... | ... ] where nothing is allowed).

> Also curly brackets are not a replacement for parens to denote groups of
> alternates.

I'm also happy with round parens. Braces are just a nice way to express
that the mdoc manpage of my system uses:
"If there are alternative values for a mandatory
parameter, braces are used (together with ‘|’) to enclose the value

        Bernhard R. Link
F8AC 04D5 0B9B 064B 3383  C3DA AFFC 96D1 151D FFDC

reply via email to

[Prev in Thread] Current Thread [Next in Thread]