From b7e582fdcde64af773f886e5aed8da6f02282793 Mon Sep 17 00:00:00 2001 From: Dan Hackney Date: Wed, 30 Dec 2009 18:16:57 -0500 Subject: Use 2 spaces for list indentation rather than 4. Avoids confusion with code blocks and wastes less horizontal space. Signed-off-by: Dan Hackney --- README | 176 ++++++++++++++++++++++++++++++++--------------------------------- 1 file changed, 88 insertions(+), 88 deletions(-) (limited to 'README') diff --git a/README b/README index 613f25f..40518c2 100644 --- a/README +++ b/README @@ -48,21 +48,21 @@ There are several interfaces to interact with Uzbl: * Interactive: you can enter commands (and bind them to shortcuts, even at runtime) By default, the behaviour is modal (vi style): - - command mode: every keystroke is interpreted to run commands - - insert mode: keystrokes are not interpreted so you can enter text into html forms + - command mode: every keystroke is interpreted to run commands + - insert mode: keystrokes are not interpreted so you can enter text into html forms There is also support for "chained" commands (multiple characters long) (with backspace/esc shortcuts), and keyworded commands. Also you can have incremental matching on commands or match after pressing return. (see sampleconfig for more info) Also, copy paste works when typing commands: - - insert (paste X cliboard) - - shift insert (paste primary selection buffer) + - insert (paste X cliboard) + - shift insert (paste primary selection buffer) * FIFO & socket file: If enabled by setting their paths through one of the above means, you can have socket and fifo files available which are very useful to programmatically control `uzbl` (from scripts etc). - - The advantage of the fifo is you can write plaintxt commands to it, but it's half duplex only (`uzbl` cannot send a response to you). - - The socket is full duplex but you need a socket-compatible wrapper such as socat to work with it. - - For example: `echo | socat - unix-connect:` + - The advantage of the fifo is you can write plaintxt commands to it, but it's half duplex only (`uzbl` cannot send a response to you). + - The socket is full duplex but you need a socket-compatible wrapper such as socat to work with it. + - For example: `echo | socat - unix-connect:` When uzbl forks a new instance (eg "open in new window") it will use the same commandline arguments (eg the same `--config `), except `--uri` and `--name`. If you made changes to the configuration at runtime, these are not passed on to the child. @@ -86,17 +86,17 @@ Each command starts with the name of the command or an uzbl variable that expand The following commands are recognized: * `set = ` - - used for changing variables on the fly - - the changes are effective immediately; for example, setting the variable `uri` will make uzbl start loading, and changing `status_format` will make the status bar react immediately - - if you want to unset a string, use `set` with one space after the equals sign + - used for changing variables on the fly + - the changes are effective immediately; for example, setting the variable `uri` will make uzbl start loading, and changing `status_format` will make the status bar react immediately + - if you want to unset a string, use `set` with one space after the equals sign * `print @` - - use this to print the value of a variable. + - use this to print the value of a variable. * `back` * `forward` * `scroll ` - - argument can be `begin`, `end`, or an amount given in pixels(?) + - argument can be `begin`, `end`, or an amount given in pixels(?) or as a percentage of the size of the view - - set the amount to 100% to scroll a whole page + - set the amount to 100% to scroll a whole page * `reload` * `reload_ign_cache` * `stop` @@ -104,66 +104,66 @@ The following commands are recognized: * `zoom_out` * `uri
` * `js ` - - execute the javascript in `` - - remember that the commands must not contain line breaks + - execute the javascript in `` + - remember that the commands must not contain line breaks * `script ` - - execute the javascript in `` + - execute the javascript in `` * `toggle_status` * `spawn ` TODO explain path-alike expansion - - runs a command; see EXTERNAL SCRIPTS for details - - PATH is searched so giving the full path to commands is not necessary - - note that the arguments as specified in "EXTERNAL SCRIPTS" are appended at the end, so the argument numbers will be higher. + - runs a command; see EXTERNAL SCRIPTS for details + - PATH is searched so giving the full path to commands is not necessary + - note that the arguments as specified in "EXTERNAL SCRIPTS" are appended at the end, so the argument numbers will be higher. * `sh ` - - runs a shell command by expanding `%s` in the `shell_cmd` variable with the specified command; primarily useful as a shortcut for `spawn sh -c ` - - note that the arguments as specified in "EXTERNAL SCRIPTS" are appended at the end, so the argument numbers will be higher. + - runs a shell command by expanding `%s` in the `shell_cmd` variable with the specified command; primarily useful as a shortcut for `spawn sh -c ` + - note that the arguments as specified in "EXTERNAL SCRIPTS" are appended at the end, so the argument numbers will be higher. * `sync_spawn ` * `sync_sh ` - - these are synchronous variants of `spawn` and `sh`, which means uzbl will wait for them to return - - you should only need to use these manually if you want to use a chain command in a handler that wants output from the command it runs + - these are synchronous variants of `spawn` and `sh`, which means uzbl will wait for them to return + - you should only need to use these manually if you want to use a chain command in a handler that wants output from the command it runs * `talk_to_socket ` - - lets uzbl talk to a socketfile + - lets uzbl talk to a socketfile * `exit` * `search ` * `search_reverse ` - - search with no string will search for the next/previous occurrence of the string previously searched for + - search with no string will search for the next/previous occurrence of the string previously searched for * `search_clear` - - unmark and clear the search string + - unmark and clear the search string * `toggle_insert_mode ` TODO new plugin based syntax - - if the optional state is 0, disable insert mode. If 1, enable insert mode. + - if the optional state is 0, disable insert mode. If 1, enable insert mode. * `dump_config` - - dumps your current config (which may have been changed at runtime) to stdout, in a format you can use to pipe into uzbl again (or use as config file) + - dumps your current config (which may have been changed at runtime) to stdout, in a format you can use to pipe into uzbl again (or use as config file) * `keycmd ` * `keycmd_nl ` - - keycmd sets the interactive command buffer to ``. If the given string is a valid binding, it will execute. `Keycmd_nl` is like `keycmd`, but it also emulates a press of return, causing bindings with a parameter to execute. For example, `keycmd_nl o google.com` would load the said url if you have a binding like `bind o _ = uri %s`. + - keycmd sets the interactive command buffer to ``. If the given string is a valid binding, it will execute. `Keycmd_nl` is like `keycmd`, but it also emulates a press of return, causing bindings with a parameter to execute. For example, `keycmd_nl o google.com` would load the said url if you have a binding like `bind o _ = uri %s`. * `keycmd_bs` - - erase (backspace) one character from the command buffer + - erase (backspace) one character from the command buffer * `chain ..` - - use for chaining multiple commands - - remember to quote the commands; one command must come as one parameter - - if you use `chain` with a handler script which must return some output (such as a cookie handler -- uzbl will wait for and use its output), use sync_spawn or sync_sh instead of spawn or sh in the command that should give the output + - use for chaining multiple commands + - remember to quote the commands; one command must come as one parameter + - if you use `chain` with a handler script which must return some output (such as a cookie handler -- uzbl will wait for and use its output), use sync_spawn or sync_sh instead of spawn or sh in the command that should give the output * `event [event_details]` - - send custom event + - send custom event * `request [request_details]` - - send custom request (same idea as events, but to be processed by EM, not uzbl-core) + - send custom request (same idea as events, but to be processed by EM, not uzbl-core) * `menu_add