xemacs-beta: man/lispref/keymaps.texi comparison

comparison man/lispref/keymaps.texi @ 412:697ef44129c6 r21-2-14

Import from CVS: tag r21-2-14

author	cvs
date	Mon, 13 Aug 2007 11:20:41 +0200
parents	74fd4e045ea6
children

comparison

equal deleted inserted replaced

-:12e008d41344
+:697ef44129c6
 @node Key Sequences
 @section Key Sequences
 @cindex key sequences
-Contrary to popular belief, the world is not @sc{ascii}.  When running
+Contrary to popular belief, the world is not @sc{ASCII}.  When running
 under a window manager, XEmacs can tell the difference between, for
 example, the keystrokes @kbd{control-h}, @kbd{control-shift-h}, and
 @kbd{backspace}.  You can, in fact, bind different commands to each of
 these.
 A @dfn{key sequence} is a set of keystrokes.  A @dfn{keystroke} is a
 keysym and some set of modifiers (such as @key{CONTROL} and @key{META}).
 A @dfn{keysym} is what is printed on the keys on your keyboard.
 A keysym may be represented by a symbol, or (if and only if it is
-equivalent to an @sc{ascii} character in the range 32 - 255) by a
+equivalent to an @sc{ASCII} character in the range 32 - 255) by a
-character or its equivalent @sc{ascii} code.  The @kbd{A} key may be
+character or its equivalent @sc{ASCII} code.  The @kbd{A} key may be
 represented by the symbol @code{A}, the character @code{?A}, or by the
 number 65.  The @kbd{break} key may be represented only by the symbol
 @code{break}.
 A keystroke may be represented by a list: the last element of the list
 @code{(control b)}, @code{(control ?b)}, and @code{(control 98)}.  A
 keystroke may also be represented by an event object, as returned by the
 @code{next-command-event} and @code{read-key-sequence} functions.
 Note that in this context, the keystroke @kbd{control-b} is @emph{not}
-represented by the number 2 (the @sc{ascii} code for @samp{^B}) or the
+represented by the number 2 (the @sc{ASCII} code for @samp{^B}) or the
 character @code{?\^B}.  See below.
 The @key{SHIFT} modifier is somewhat of a special case.  You should
 not (and cannot) use @code{(meta shift a)} to mean @code{(meta A)},
-since for characters that have @sc{ascii} equivalents, the state of the
+since for characters that have @sc{ASCII} equivalents, the state of the
 shift key is implicit in the keysym (@samp{a} vs. @samp{A}).  You also
 cannot say @code{(shift =)} to mean @code{+}, as that sort of thing
 varies from keyboard to keyboard.  The @key{SHIFT} modifier is for use
 only with characters that do not have a second keysym on the same key,
 such as @code{backspace} and @code{tab}.
 A key sequence is a vector of keystrokes.  As a degenerate case,
 elements of this vector may also be keysyms if they have no modifiers.
 That is, the @kbd{A} keystroke is represented by all of these forms:
 @example
-A       ?A      65      (A)     (?A)    (65)
+	A	?A	65	(A)	(?A)	(65)
-[A]     [?A]    [65]    [(A)]   [(?A)]  [(65)]
+	[A]	[?A]	[65]	[(A)]	[(?A)]	[(65)]
 @end example
 the @kbd{control-a} keystroke is represented by these forms:
 @example
-(control A)     (control ?A)    (control 65)
+	(control A)	(control ?A)	(control 65)
-[(control A)]   [(control ?A)]  [(control 65)]
+	[(control A)]	[(control ?A)]	[(control 65)]
 @end example
 the key sequence @kbd{control-c control-a} is represented by these
 forms:
 @example
-[(control c) (control a)]       [(control ?c) (control ?a)]
+	[(control c) (control a)]	[(control ?c) (control ?a)]
-[(control 99) (control 65)]     etc.
+	[(control 99) (control 65)]	etc.
 @end example
 Mouse button clicks work just like keypresses: @code{(control
 button1)} means pressing the left mouse button while holding down the
 control key.  @code{[(control c) (shift button3)]} means
 to the up and down strokes, though that is probably not what you want,
 so be careful.
 For backward compatibility, a key sequence may also be represented by
 a string.  In this case, it represents the key sequence(s) that would
-produce that sequence of @sc{ascii} characters in a purely @sc{ascii}
+produce that sequence of @sc{ASCII} characters in a purely @sc{ASCII}
-world.  For example, a string containing the @sc{ascii} backspace
+world.  For example, a string containing the @sc{ASCII} backspace
 character, @code{"\^H"}, would represent two key sequences:
 @code{(control h)} and @code{backspace}.  Binding a command to this will
 actually bind both of those key sequences.  Likewise for the following
 pairs:
 @example
-control h       backspace
+		control h	backspace
-control i       tab
+		control i   	tab
-control m       return
+		control m   	return
-control j       linefeed
+		control j   	linefeed
-control [       escape
+		control [   	escape
-control @@      control space
+		control @@	control space
 @end example
 After binding a command to two key sequences with a form like
 @example
-(define-key global-map "\^X\^I" 'command-1)
+	(define-key global-map "\^X\^I" 'command-1)
 @end example
 @noindent
 it is possible to redefine only one of those sequences like so:
 @example
-(define-key global-map [(control x) (control i)] 'command-2)
+	(define-key global-map [(control x) (control i)] 'command-2)
-(define-key global-map [(control x) tab] 'command-3)
+	(define-key global-map [(control x) tab] 'command-3)
 @end example
 Of course, all of this applies only when running under a window
-system.  If you're talking to XEmacs through a @sc{tty} connection, you
+system.  If you're talking to XEmacs through a @sc{TTY} connection, you
 don't get any of these features.
 @defun event-matches-key-specifier-p event key-specifier
 This function returns non-@code{nil} if @var{event} matches
 @var{key-specifier}, which can be any valid form representing a key
 @group
 (current-local-map)
 @result{} #<keymap lisp-interaction-mode-map 5 entries 0x558>
 (describe-bindings-internal (current-local-map))
 @result{}  ; @r{Inserted into the buffer:}
-backspace       backward-delete-char-untabify
+backspace	backward-delete-char-untabify
-linefeed        eval-print-last-sexp
+linefeed	eval-print-last-sexp
-delete          delete-char
+delete		delete-char
-C-j             eval-print-last-sexp
+C-j		eval-print-last-sexp
-C-x             << Prefix Command >>
+C-x		<< Prefix Command >>
-M-tab           lisp-complete-symbol
+M-tab		lisp-complete-symbol
-M-;             lisp-indent-for-comment
+M-;		lisp-indent-for-comment
-M-C-i           lisp-complete-symbol
+M-C-i		lisp-complete-symbol
-M-C-q           indent-sexp
+M-C-q		indent-sexp
-M-C-x           eval-defun
+M-C-x		eval-defun
-Alt-backspace   backward-kill-sexp
+Alt-backspace	backward-kill-sexp
-Alt-delete      kill-sexp
+Alt-delete	kill-sexp
 @end group
 @group
-C-x x           edebug-defun
+C-x x		edebug-defun
 @end group
 @end example
 @end defun
 @defun current-minor-mode-maps
 @cindex @key{ESC}
 This variable is the meta-prefix character code.  It is used when
 translating a two-character sequence to a meta character so it can be
 looked up in a keymap.  For useful results, the value should be a prefix
 event (@pxref{Prefix Keys}).  The default value is @code{?\^[} (integer
-27), which is the @sc{ascii} character usually produced by the @key{ESC}
+27), which is the @sc{ASCII} character usually produced by the @key{ESC}
 key.
 As long as the value of @code{meta-prefix-char} remains @code{?\^[},
 key lookup translates @kbd{@key{ESC} b} into @kbd{M-b}, which is
 normally defined as the @code{backward-word} command.  However, if you
 set @code{meta-prefix-char} to @code{?\^X} (i.e. the keystroke
-@kbd{C-x}) or its equivalent @sc{ascii} code @code{24}, then XEmacs will
+@kbd{C-x}) or its equivalent @sc{ASCII} code @code{24}, then XEmacs will
 translate @kbd{C-x b} (whose standard binding is the
 @code{switch-to-buffer} command) into @kbd{M-b}.
 @smallexample
 @group
 @ignore @c #### Should fix where-is to be more like FSF
 If @var{firstonly} is @code{non-ascii}, then the value is a single
 string representing the first key sequence found, rather than a list of
 all possible key sequences.  If @var{firstonly} is @code{t}, then the
 value is the first key sequence, except that key sequences consisting
-entirely of @sc{ascii} characters (or meta variants of @sc{ascii}
+entirely of @sc{ASCII} characters (or meta variants of @sc{ASCII}
 characters) are preferred to all other key sequences.
 @end ignore
 If @var{noindirect} is non-@code{nil}, @code{where-is-internal} doesn't
 follow indirect keymap bindings.  This makes it possible to search for
 displays it in a window.
 If @var{prefix} is non-@code{nil}, it should be a prefix key; then the
 listing includes only keys that start with @var{prefix}.
-When several characters with consecutive @sc{ascii} codes have the
+When several characters with consecutive @sc{ASCII} codes have the
 same definition, they are shown together, as
 @samp{@var{firstchar}..@var{lastchar}}.  In this instance, you need to
-know the @sc{ascii} codes to understand which characters this means.
+know the @sc{ASCII} codes to understand which characters this means.
 For example, in the default global map, the characters @samp{@key{SPC}
-..@: ~} are described by a single line.  @key{SPC} is @sc{ascii} 32,
+..@: ~} are described by a single line.  @key{SPC} is @sc{ASCII} 32,
-@kbd{~} is @sc{ascii} 126, and the characters between them include all
+@kbd{~} is @sc{ASCII} 126, and the characters between them include all
 the normal printing characters, (e.g., letters, digits, punctuation,
 etc.@:); all these characters are bound to @code{self-insert-command}.
 If the second argument (prefix arg, interactively) is non-@code{nil}
 then only the mouse bindings are displayed.

Mercurial > hg > xemacs-beta

comparison man/lispref/keymaps.texi @ 412:697ef44129c6 r21-2-14