From b06f6eddf779b9a0d17b9ec19d9039089f04e400 Mon Sep 17 00:00:00 2001 From: Dan Hackney Date: Wed, 30 Dec 2009 17:00:37 -0500 Subject: Begin documenting EM requests. Finished "BIND" and "MODE_BIND" so far. Signed-off-by: Dan Hackney --- README | 88 ++++++++++++++++++++++++++++++++++-------------------------------- 1 file changed, 45 insertions(+), 43 deletions(-) (limited to 'README') diff --git a/README b/README index bb661f2..4482fcf 100644 --- a/README +++ b/README @@ -433,55 +433,57 @@ Basically all events have this format: * `EVENT [uzbl_instance_name] WEBINSPECTOR open`: Upon opening webinspector window. * `EVENT [uzbl_instance_name] WEBINSPECTOR close`: Upon closing webinspector window. * `EVENT [uzbl_instance_name] FOCUS_GAINED`: When `uzbl` window gains keyboard focus. -* `EVENT [uzbl_instance_name] FOCUS_LOST`: when uzbl window lost keyboard focus -* `EVENT [uzbl_instance_name] FORM_ACTIVE`: when a editable HTML is clicked -* `EVENT [uzbl_instance_name] ROOT_ACTIVE`: when the document body or any non-editable element is clicked -* `EVENT [uzbl_instance_name] FILE_INCLUDED /path/to/file`: when the include commands succesfully loads a file -* `EVENT [uzbl_instance_name] PLUG_CREATED plug-id`: when uzbl-core is in xembed mode -* `EVENT [uzbl_instance_name] BUILTINS command_list`: shows a list of all uzbl commands, whitespace separated, on startup - -* Events/requests which the EM and its plugins listens for: - - `BIND` and `MODE_BIND`: define global resp. per-mode key/button binds. - `request BIND = ` # set global binding (this is a shortcut for `request MODE_BIND global = `) - `request MODE_BIND = ` - The `` can be anything like 'command', 'insert,command', 'global', 'global,-insert'. - The `` has a special syntax: - * `` ends with an underscore: the command will only be invoked after pressing return/enter. If the user enters text where `` has the underscore, `%s` in the `` string will be replaced by this text. (optional) - * `` ends with an asterisk: similar behavior as with an underscore, but also makes the binding incremental (i.e. the command will be invoked on every keystroke). - * `` ends with an '!': the command will only be invoked after pressing return/enter, no replacement happens. this is useful for preventing 'x' to match when you want to bind 'xx' also. - * `` ends on a different character: you need to type the full string, which will trigger the command immediately, without pressing enter/return. - * TODO explain stacked bindings and multi-stage (is that the same?) and what else am i missing? modkeys, showing a prompt mid-bind. - The `` can be any representation of a key on your keyboard or a mousebutton. (note: not all mousebuttons work correctly yet) - examples: - * `event BIND o _ = uri %s` - - uzbl will load the url when you type: 'o ' - * `event BIND /* = search %s` - - a search command which is called on every character typed after the slash, letting you see the search narrow down while typing. - - Hitting return, enter or esc will terminate the search. - * `event BIND ZZ = exit` - - When you type `ZZ` and nothing else, the exit command will be triggered immediately. - - `MODE_CONFIG`: ?? - request MODE_CONFIG = = ` Set global binding (this is a shortcut for `request MODE_BIND global = `). + - `request MODE_BIND = ` Set a local binding for ``. The `` can be anything like `command`, `insert,command`, `global`, `global,-insert`. + + The `` has a special syntax: + - `` ends with an `_`: the command will only be invoked after pressing return/enter. If the user enters text where `` has the underscore, `%s` in the `` string will be replaced by this text (optional). + - `` ends with an `*`: similar behavior as with an underscore, but also makes the binding incremental (i.e. the command will be invoked on every keystroke). + - `` ends with an `!`: the command will only be invoked after pressing return/enter, no replacement happens. this is useful for preventing `x` to match when you want to bind `xx` also. + - `` ends on a different character: you need to type the full string, which will trigger the command immediately, without pressing enter/return. + - TODO explain stacked bindings and multi-stage (is that the same?) and what else am i missing? modkeys, showing a prompt mid-bind. + + The `` can be any representation of a key on your keyboard or a mousebutton. (note: not all mousebuttons work correctly yet). Examples: + + - `event BIND o _ = uri %s` + - `uzbl` will load the url when you type: `o ` + - `event BIND /* = search %s` + - A `search` command which is called on every character typed after the slash, letting you see the search narrow down while typing. + - Hitting return, enter or esc will terminate the search. + - `event BIND ZZ = exit` + - When you type `ZZ` and nothing else, the `exit` command will be triggered immediately. +* `MODE_CONFIG`: ?? + request MODE_CONFIG = +* `ON_EVENT`: allows you to bind misc commands to misc events request ON_EVENT - - `PROGRESS_CONFIG` +* `PROGRESS_CONFIG` request PROGRESS_CONFIG = - - `MODMAD` +* `MODMAD` request MODMAP From To - - `IGNORE_KEY` +* `IGNORE_KEY` request IGNORE_KEY - - `MODKEY_ADDITION` +* `MODKEY_ADDITION` request MODKEY_ADDITION - - `TOGGLE_MODES` +* `TOGGLE_MODES` event TOGGLE_MODES ... - - `APPEND_KEYCMD`: append ` to keycmd - - `INJECT_KEYCMD `: replace keycmd by `` - - `KEYCMD_DELETE` - - `KEYCMD_STRIP_WORD` - - `KEYCMD_EXEC_CURRENT`: (tries to) execute whatever is in the keycmd - - `SET_KEYCMD` - - `SET_CURSOR_POS` - - `START_COMPLETION`: TODO explain completion +* `APPEND_KEYCMD`: append ` to keycmd +* `INJECT_KEYCMD `: replace keycmd by `` +* `KEYCMD_DELETE` +* `KEYCMD_STRIP_WORD` +* `KEYCMD_EXEC_CURRENT`: (tries to) execute whatever is in the keycmd +* `SET_KEYCMD` +* `SET_CURSOR_POS` +* `START_COMPLETION`: TODO explain completion -- cgit v1.2.3