[Top][All Lists]

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

Re: rcirc manual

From: Karl Berry
Subject: Re: rcirc manual
Date: Sun, 15 Jan 2006 16:23:45 -0600

    In any case, the explanation in the Texinfo manual should be more
    clear on this, IMHO.  It should explain what keys are suitable for
    @key, and why.

Here is what the `key' node says now.  Documentation improvements are
always welcome, of course.  I'm not too clear myself on exactly how to
make it better.

@node key
@subsection @code{@@address@hidden@address@hidden
@findex key

Use the @code{@@key} command for the conventional name for a key on a
keyboard, as in:

@end example

You can use the @code{@@key} command within the argument of an
@code{@@kbd} command when the sequence of characters to be typed
includes one or more keys that are described by name.


There are subtleties to handling words like `meta' or `ctrl' that are
names of modifier keys.  When mentioning a character in which the
modifier key is used, such as @kbd{Meta-a}, use the @code{@@kbd} command
alone; do not use the @code{@@key} command; but when you are referring
to the modifier key in isolation, use the @code{@@key} command.  For
example, write @samp{@@address@hidden@}} to produce @kbd{Meta-a} and
@samp{@@address@hidden@}} to produce @key{META}.

reply via email to

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