mirror of
https://github.com/rkd77/elinks.git
synced 2024-12-04 14:46:47 -05:00
ba6221c6f6
You can now use: make {all-docs,pdf,html,man,api,update-man}
instead of: make {all-docs,pdf-docs,html-docs,man-docs}
Away is building into separate dirs. This makes make able to actually get
dependencies right, since there are now a collection of 'common' build
rules, some of which have even been moved to use the cmd infrastructure.
To update the man pages there is a new update-man rule. It builds the
manual pages and copies them to their proper place under man/ while doing
the final preformatting.
As good thing is that the (two) man pages are moved to .txt files and
include the generated content.
The API building thing is also refined. It builds into api/ and builds it's
list of files dynamically by searching throught the .h files in the src/
directory. Documented header files must contain a comment like this:
/* API Doc :: <api-name> */
where <api-name> is the name used for the file under api/, for example
dom-scanner.
107 lines
2.8 KiB
Plaintext
107 lines
2.8 KiB
Plaintext
elinkskeys(5)
|
|
=============
|
|
|
|
NAME
|
|
----
|
|
elinkskeys - keybindings for ELinks
|
|
|
|
SYNOPSIS
|
|
--------
|
|
Information on how to configure keybinding and overview of the default
|
|
keybindings.
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
Key binding for elinks should be placed in the file `~/.elinks/elinks.conf`.
|
|
Note that any information regarding their format/structure may not be
|
|
up-to-date. If you will discover that, please feed us with a patch.
|
|
|
|
Key binding statements are of the form:
|
|
|
|
bind <keymap> <keystroke> = <action>
|
|
|
|
where:
|
|
|
|
<keymap>::
|
|
|
|
is 'main', 'edit', or 'menu'. The main keymap is used for general
|
|
browsing. The edit keymap is used for editing text fields. The menu
|
|
keymap is used for navigating menus.
|
|
|
|
<keystroke>::
|
|
|
|
is a case sensitive key, which you can prefix with 'Ctrl-' or 'Alt-'.
|
|
'Ctrl-' must be followed by an uppercase key. See below for a list of
|
|
valid keys.
|
|
|
|
<action>::
|
|
|
|
is what the key should do. The actions available are dependent on the
|
|
keymap, and are listed separately below.
|
|
|
|
All words/strings may all be quoted "like so". Backslashes are escape
|
|
characters, even if not between quotes. Lines beginning with a hash character
|
|
(`#`) are comments.
|
|
|
|
Keys can be unbound just by binding them to the special 'none' action. It may
|
|
be of use if you accidentally type a key often.
|
|
|
|
EXAMPLE BINDINGS
|
|
----------------
|
|
|
|
Some sample keybindings:
|
|
|
|
bind "main" "v" = "view-image"
|
|
bind "main" "l" = "jump-to-link"
|
|
bind "main" "L" = "link-menu"
|
|
bind "main" "F10" = "file-menu"
|
|
bind "main" "F9" = "menu"
|
|
bind "main" "Escape" = "menu"
|
|
bind "edit" "Ctrl-R" = "auto-complete-unambiguous"
|
|
bind "edit" "Ctrl-W" = "auto-complete"
|
|
bind "edit" "Ctrl-K" = "kill-to-eol"
|
|
bind "menu" "Ctrl-B" = "page-up"
|
|
bind "menu" "PageUp" = "page-up"
|
|
bind "menu" "Ctrl-F" = "page-down"
|
|
bind "menu" "PageDown" = "page-down"
|
|
# ELinks with Lua support
|
|
bind "main" "," = "lua-console"
|
|
|
|
KEYS
|
|
----
|
|
|
|
Valid keys are: alphanumeric characters, punctuation, 'Enter', 'Backspace',
|
|
'Tab', 'Escape', 'Left', 'Right', 'Up', 'Down', 'Insert', 'Delete', 'Home',
|
|
'End', 'PageUp', 'PageDown', 'F1' to 'F12'.
|
|
|
|
Some keys will need to be quoted or escaped. For example, space can be written
|
|
as `" "` (quote space quote), and the quote itself as `\"` (backslash quote).
|
|
Backslash can be written as `\\` (double backslash).
|
|
|
|
KEYMAP ACTIONS
|
|
--------------
|
|
|
|
include::keymap-actions.txt[]
|
|
|
|
DEFAULT BINDINGS
|
|
----------------
|
|
|
|
The default bindings are shown below. Any bindings in `~/.elinks/elinks.conf`
|
|
will override these.
|
|
|
|
include::keymap-defaults.txt[]
|
|
|
|
AUTHOR
|
|
------
|
|
|
|
This manual page was finally written by Peter Wang (one and a half years after
|
|
writing the binding code), using excerpts by David Mediavilla. You can thank
|
|
Petr Baudis for the subtle requests for documentation. Updated by Zas. Moved
|
|
to asciidoc format and cleaned up by Jonas Fonseca.
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
man:elinks[1], elinks.conf(5)
|