1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-01-06 08:24:14 +01:00

Fix incorrectly formatted key strings in |key-sequence| help.

This commit is contained in:
Doug Kearns
2009-08-04 17:52:22 +10:00
parent ec4982d50b
commit ba905609c4
2 changed files with 36 additions and 36 deletions

View File

@@ -140,38 +140,38 @@ For most keys, the key-sequence is the same as the character you see when you
type that key, however there are some exceptions which allow for a much larger
number of keys to be used in mappings.
* [c]<lt>[c], [c]\<[c], [c]<Space>[c], [c]\ [c] allow a literal [c]<[c] or space character.
* [c]\'[c], [c]\"[c] and [c]\\[c] must be used to avoid escaping issues when mapping a quote or backslash.
* [c]<Left>[c] [c]<Right>[c] [c]<Up>[c] [c]<Down>[c] [c]<PageUp>[c] [c]<PageDown>[c] [c]<Esc>[c] [c]<CR>[c] (for carriage return/enter)
* [c]<CapsLock>[c] [c]<NumLock>[c] [c]<Ins>[c] [c]<Del>[c] [c]<Tab>[c] [c]<BS>[c] (for a backspace)
* [c]<F1>[c] through [c]<F12>[c] work as expected
* *<lt>*, *\<*, *<Space>*, *\ * allow a literal *<* or space character.
* *\'*, *\"* and *\\* must be used to avoid escaping issues when mapping a quote or backslash.
* *<Left>* *<Right>* *<Up>* *<Down>* *<PageUp>* *<PageDown>* *<Esc>* *<CR>* (for carriage return/enter)
* *<CapsLock>* *<NumLock>* *<Ins>* *<Del>* *<Tab>* *<BS>* (for a backspace)
* *<F1>* through *<F12>* work as expected
Most keyboards have some modifiers such as the control, alt or meta keys. In
order to create a mapping that uses these keys the correct prefix must be used
within the angle brackets.
* [c]<C-x>[c]: The control or ctrl key.
* [c]<A-x>[c]: The alt key.
* [c]<M-x>[c]: The meta key, windows key, or command key
* [c]<S-x>[c]: The shift key.
* *<C-x>*: The control or ctrl key.
* *<A-x>*: The alt key.
* *<M-x>*: The meta key, windows key, or command key
* *<S-x>*: The shift key.
These prefixes can be combined however you see fit, though you should note that
within angle brackets all alphabetic characters are read as lowercase. In order
to force them to be uppercase, you must specify the S- prefix as well.
Additionally, you should never use the S- prefix with a number of piece of
Additionally, you should never use the S- prefix with a number or piece of
punctuation, even if you require a shift to type that character; doing so will
give you a mapping that cannot be typed. With non-character keys, tab and
space, the S- modifier works just like C- A- and M-. Some examples may clarify
the situation:
* [c]xc[c]: type x, and then type c
* [c]<C-x>c[c]: hold control and type x, then type c without control
* [c]<C-2>[c]: type 2 while holding control
* [c]<C-@>[c]: type @ while holding control
* [c]<S-Space>[c]: press space while holding shift
* [c]<C-A-j>[c]: press j while holding control and alt
* [c]<C-A-J>[c]: exactly the same as above
* [c]<C-A-S-j>[c]: press J while holding control and alt
* *xc*: type x, and then type c
* *<C-x>c*: hold control and type x, then type c without control
* *<C-2>*: type 2 while holding control
* *<C-@>*: type @ while holding control
* *<S-Space>*: press space while holding shift
* *<C-A-j>*: press j while holding control and alt
* *<C-A-J>*: exactly the same as above
* *<C-A-S-j>*: press J while holding control and alt
subsection:Special{nbsp}characters[:map-special-chars]