[PATCH 2/7] man: Build proper sentences for various options.

James Cloos cloos at jhcloos.com
Sun Jun 5 17:03:51 PDT 2011


>>>>> "CB" == Cyril Brulebois <kibi at debian.org> writes:

CB>  .B \-nocursor
CB> -disable the display of the pointer cursor.
CB> +disables the display of the pointer cursor.

Most (all?) of those depend on whether the option is part of the
sentence.  You change would be correct if the option is a noun
which is the object of the verb, but not if the sentence is
an imperitive description separate from the option.

Most man pages use the latter style.

Xserver(1) is the only man page I've found (with just a quick check)
which does not use that style.

Perhaps patching that one would be the better fix.

Also, one could argue that the first would should be titlecased;
ie s/disable/Disable/ et al.

-JimC
-- 
James Cloos <cloos at jhcloos.com>         OpenPGP: 1024D/ED7DAEA6


More information about the xorg-devel mailing list