Re: [PATCH] improve new manpage layout
"Bernhard R. Link" <[email protected]>
| Newsgroups | gmane.comp.window-managers.ratpoison.devel |
|---|---|
| Message-ID | <[email protected]> |
* Jérémie Courrèges-Anglas <[email protected]> [140325 22:21]: > "Bernhard R. Link" <[email protected]> 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 way. > > 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 set." Bernhard R. Link -- F8AC 04D5 0B9B 064B 3383 C3DA AFFC 96D1 151D FFDC _______________________________________________ Ratpoison-devel mailing list [email protected] https://lists.nongnu.org/mailman/listinfo/ratpoison-devel