* src/keymap.c (define-key) add practical example to docstring

* src/keymap.c (define-key) add practical example to docstring

[Arne Babenhauserheide]

[-- Attachment #1.1: Type: text/plain, Size: 230 bytes --]

Hi,

Based on a discussion in #emacs, I’d like to contribute the attached patch.

It adds documentation for defining keys in a keymap which would have
helped me a lot when I wrote my last minor mode.

Best wishes,
Arne

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: define-key-example.diff --]
[-- Type: text/x-patch; name="define-key-example.diff", Size: 2581 bytes --]

# Bazaar merge directive format 2 (Bazaar 0.90)
# revision_id: arne_bab@web.de-20130107114658-r7tm2oqdmanez2ps
# target_branch: bzr://bzr.savannah.gnu.org/emacs/trunk/
# testament_sha1: 423a0e7828e9bdddd00b37d04a7da41effaee0af
# timestamp: 2013-01-07 12:51:40 +0100
# base_revision_id: eliz@gnu.org-20121019064312-moqbalgi86m1r07g
# 
# Begin patch
=== modified file 'src/keymap.c'
--- src/keymap.c	2012-10-10 20:09:47 +0000
+++ src/keymap.c	2013-01-07 11:46:58 +0000
@@ -1088,7 +1088,10 @@
 
 KEY is a string or a vector of symbols and characters, representing a
 sequence of keystrokes and events.  Non-ASCII characters with codes
-above 127 (such as ISO Latin-1) can be represented by vectors.
+above 127 (such as ISO Latin-1) can be represented by vectors. With
+`C-h c` you can get a string representation of any key sequence. Use
+(kbd string) to get the representation for the keymap. For example use
+(kbd "<f6>") to bind F6.
 Two types of vector have special meanings:
  [remap COMMAND] remaps any key binding for COMMAND.
  [t] creates a default definition, which applies to any event with no

# Begin bundle
IyBCYXphYXIgcmV2aXNpb24gYnVuZGxlIHY0CiMKQlpoOTFBWSZTWW1rjiYAAYRfgAAQUHP/93sk
ioD/7//wUAPNeB10e9gDpw0QpsUMmgxABk0MjJoMgAhFNPSeiD1PaUyBiGTIMQBhGDQEKeiDakeo
wQBhGgDAmQaaSjyg0PKANGRoAAAAAkkE0NJiZMiZqMmQNTKek0YahtRsLT62CAP8Q+MT2Gk3QBTj
Wm8yFMVFC8sKWmZjtUPClmDphsVGg4q67dSCdv11XsVxX3t+77stnJITV7XijtmNRCOtxQW+8wzZ
XsGbLkx2STiVSASBGDlutvwTRZrxGosAJB7xyh5LuyVorcPHz+KobpQDcl23qjO+yvGOq2Qs213M
F8PIWuAPYTBIcqKz0goi7kxFM3oovTsIPsIMSZ/04T4MqUqF4nPrTWqK1iKcvKrFSDGx2+va8X1e
tbsU8Wk3Vddm1jNTVCq63bfhYULbuVTCIKAQeYPe2F+++AbC4sF8is1lAmTA1Seny33v4GrZVq0x
ZqrNdaytqTFKnZWtquKhVw4bRxEjNM4ffGimkldq1CaDGzQKEHDXaKgnHC57OtSxbASJZCzNnBIo
xGSAmYRN0E5g4mqlmK6usTa7Kol2m5PmRp1Vm0o2kcHuC6jqSgZJMooJAxKY5pY0BXXWihiWkzWC
B0I3NiQUSbfy6nnv8dlj3FH2uhLktiWc4gxZ+PeDw+P04ele02Dr7POk5adtAXDtxnhwil319fTw
424aGMQwmumWXMiUWCmyPG1HccRu78Skviw4Z/zbkk2mbc9YHQ/5L2TeHzBuhi2fqM2zAG+QXh8I
KoV0pCiAlbyLlY6qUvJ9VIXGxAal+S46slEx1NopQ2mmbg2dkQLmD9YHJxqBdlMc2WRprxt8Dc4g
KGj+kDK8mQ3N7eko5nm6xKdIW/KU7i6+txumvbv043rtubyxljhus4tR+nEg8NniUrJOE6nfm8v7
+MloQHByJLFLEVHLhs9vFfQY3nkriOlvZqcuwcta3VHRDbJFPRU+azx+7HYEYFttyeV2KD2oq9VQ
6OhsTi5sN4QsmuuV0KS8O4PntzUGyKzZfg318mbMN+0JhNwT3cOQxJRTY86eKyFRoL8o3qrsmbee
ajEYi0GZzBnXCCKWZKLxPB8JW/RPAiywTlLtuVKurs2Ui8IF69xfmcw9U5O3MscumtFd2bMnFDFO
cclRaLuVKCDVN6p6zFXALNCSJqKno8kqjtsJS5XCK1nnVGQNzJhExikaPGNObqVbXsBi7jAOY4Ny
p0rKQtgc364m12DvuYuHNZUc73FOWquwguoqFYFE05NjS5V188WIJ0uX276oWW+qm+tbA9UuK1K+
CJtWeWAoHEI9KZCr/F3JFOFCQbWuOJg=

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 554 bytes --]