doc/elinkskeys.5.txt

   1 elinkskeys(5)
   2 =============
   3 :Description:   ELinks keybindings
   4
   5 NAME
   6 ----
   7 elinkskeys - keybindings for ELinks
   8
   9 SYNOPSIS
  10 --------
  11 Information on how to configure keybinding and overview of the default
  12 keybindings.
  13
  14 DESCRIPTION
  15 -----------
  16
  17 Key binding for elinks should be placed in the file `~/.elinks/elinks.conf`.
  18 Note that any information regarding their format/structure may not be
  19 up-to-date. If you will discover that, please feed us with a patch.
  20
  21 Key binding statements are of the form:
  22
  23         bind <keymap> <keystroke> = <action>
  24
  25 where:
  26
  27 <keymap>::
  28
  29         is 'main', 'edit', or 'menu'.  The main keymap is used for general
  30         browsing.  The edit keymap is used for editing text fields.  The menu
  31         keymap is used for navigating menus.
  32
  33 <keystroke>::
  34
  35         is a case sensitive key, which you can prefix with 'Ctrl-', 'Alt-',
  36         or both.  'Ctrl-' must be followed by an uppercase key. See below for
  37         a list of valid keys.
  38
  39 <action>::
  40
  41         is what the key should do. The actions available are dependent on the
  42         keymap, and are listed separately below.
  43
  44 All words/strings may all be quoted "like so". Backslashes are escape
  45 characters, even if not between quotes. Lines beginning with a hash character
  46 (`#`) are comments.
  47
  48 Keys can be unbound just by binding them to the special 'none' action. It may
  49 be of use if you accidentally type a key often.
  50
  51 EXAMPLE BINDINGS
  52 ----------------
  53
  54 Some sample keybindings:
  55
  56         bind "main" "v" = "view-image"
  57         bind "main" "l" = "jump-to-link"
  58         bind "main" "L" = "link-menu"
  59         bind "main" "F10" = "file-menu"
  60         bind "main" "F9" = "menu"
  61         bind "main" "Escape" = "menu"
  62         bind "edit" "Ctrl-R" = "auto-complete-unambiguous"
  63         bind "edit" "Ctrl-W" = "auto-complete"
  64         bind "edit" "Ctrl-K" = "kill-to-eol"
  65         bind "menu" "Ctrl-B" = "page-up"
  66         bind "menu" "PageUp" = "page-up"
  67         bind "menu" "Ctrl-F" = "page-down"
  68         bind "menu" "PageDown" = "page-down"
  69         # ELinks with Lua support
  70         bind "main" "," = "lua-console"
  71
  72 KEYS
  73 ----
  74
  75 Valid keys are: alphanumeric characters, punctuation, 'Enter', 'Backspace',
  76 'Tab', 'Escape', 'Left', 'Right', 'Up', 'Down', 'Insert', 'Delete', 'Home',
  77 'End', 'PageUp', 'PageDown', 'F1' to 'F12'.
  78
  79 Some keys will need to be quoted or escaped. For example, space can be written
  80 as  `" "` (quote space quote), and the quote itself as `\"` (backslash quote).
  81 Backslash can be written as `\\` (double backslash).
  82
  83 /////////////////////////////////////////////////////////////////////////////
  84 FIXME:
  85
  86  - You may prefix each of these keys with a number, telling its repeat count
  87   (how many times to do it). You can also re-bind keys, see elinkskeys(5) for
  88   documentation and a more complete list of keys  bound by default.
  89
  90  - The following keys can be used while editing a line/jumping to a URL
  91 /////////////////////////////////////////////////////////////////////////////
  92
  93 KEYMAP ACTIONS
  94 --------------
  95
  96 include::{builddir}keymap-actions.txt[]
  97
  98 DEFAULT BINDINGS
  99 ----------------
 100
 101 The default bindings are shown below. Any bindings in `~/.elinks/elinks.conf`
 102 will override these.
 103
 104 include::{builddir}keymap-defaults.txt[]
 105
 106 AUTHOR
 107 ------
 108
 109 This manual page was finally written by Peter Wang (one and a half years after
 110 writing the binding code), using excerpts by David Mediavilla. You can thank
 111 Petr Baudis for the subtle requests for documentation. Updated by Zas.  Moved
 112 to asciidoc format and cleaned up by Jonas Fonseca.
 113
 114 SEE ALSO
 115 --------
 116
 117 man:elinks[1], man:elinks.conf[5]