unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: bug#4472: 23.1; Emacs manual not too helpful about binding keys
Date: Thu, 17 Sep 2009 15:51:39 -0700	[thread overview]
Message-ID: <E2306B43F9934BBEBEF5A949D82EEA5E@us.oracle.com> (raw)

I find the Emacs manual not to be very helpful about how to bind key
sequences.  I couldn't even find the form (kbd...) in the manual, and
I thought that was what we are now recommending in general (no?).
 
I tried using `i' in the manual to find information about how to bind
keys, but it wasn't very helpful. I looked for `binding', and the only
index entry was for node Commands. I tried `i key TAB' and saw lots
that looks similar (rebinding, binding,...). Not too clear to me.
 
I finally found node Init Rebinding (weird name, BTW). It had examples
of using strings such as "\C-z" and vectors such as [?\C-=] and
[C-mouse-1], but it had nothing about `kbd' or the form [(control
mouse-1)].
 
I didn't find a node that explained the various formats and their
different uses and limitations. I didn't find any general format
recommendations. I didn't find any link in Init Rebinding to another
node that might explain such things - the only link there sends you to
a node explaining details about keyboard encodings and binding
non-ASCII keys.
 
Where is the introductory, top-level explanation about recommended
ways to bind keys? Surely that's something that even lots of
non-expert users do. The Key Bindings node (from node Customization)
sends you immediately into the depths of understanding keymaps - no
introduction there about binding keys AFAICT.
 
I did find information about `kbd' in the Elisp manual, and even some
text that stresses its convenience and portability. But that
information is missing from the Emacs manual AFAICT. IIUC, this is
info that is quite important for most users. There are often questions
at help-gnu-emacs about how to bind keys, and the answer there is
typically: "Use kbd". If this is a FAQ, then the answer belongs in the
Emacs manual, no?
 
I this kind of info belongs in the Emacs manual and I hope that
someone can find the time to add it (or move it) there.

In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600)
 of 2009-07-29 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4)'








             reply	other threads:[~2009-09-17 22:51 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <87ws3ur5d5.fsf@cyd.mit.edu>
2009-09-17 22:51 ` Drew Adams [this message]
2009-09-19 21:35   ` bug#4472: marked as done (23.1; Emacs manual not too helpful about binding keys) Emacs bug Tracking System
2009-09-18 23:11 bug#4472: 23.1; Emacs manual not too helpful about binding keys Chong Yidong
2009-09-18 23:27 ` Drew Adams

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=E2306B43F9934BBEBEF5A949D82EEA5E@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=4472@emacsbugs.donarmstrong.com \
    --cc=bug-gnu-emacs@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).