From fd99b43c5767b98910c8b72aa7a2b743af3d110b Mon Sep 17 00:00:00 2001 From: Dan Hackney Date: Wed, 30 Dec 2009 10:33:47 -0500 Subject: Remove excess/trailing whitespace. Signed-off-by: Dan Hackney --- README | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'README') diff --git a/README b/README index 0d6ed04..b36d2d8 100644 --- a/README +++ b/README @@ -15,8 +15,8 @@ In the future more things may come, but for now: #### uzbl-core: main component meant for integration with other tools and scripts * Uses WebkitGtk+ for rendering, network interaction (libsoup). Css, javascript, plugin support etc come for free - * Provides interfaces to get data in (commands/configuration) and out (events): stdin/stdout/fifo/unix sockets - * You see a webkit view and (optionally) a statusbar which gets popuplated externally + * Provides interfaces to get data in (commands/configuration) and out (events): stdin/stdout/fifo/unix sockets + * You see a webkit view and (optionally) a statusbar which gets popuplated externally * No built-in means for url changing, loading/saving of bookmarks, saving history, keybinds, downloads, ... * Extra functionality: many sample scripts come with it, on uzbl wiki or write them yourself * Entire configuration/state can be changed at runtime @@ -27,9 +27,9 @@ In the future more things may come, but for now: * Uses a set of scripts (mostly python) that will fit most people, so things work out of the box. Yet plenty of room for customisation * Brings everything you expect: url changing, history, downloads, form filling, link navigation, cookies, event management etc. However: one page per instance * Advanced, customizable keyboard interface with support for modes, modkeys, multichars, variables (keywords) etc. (eg you can tweak the interface to be vim-like, emacs-like or any-other-program-like) - * Adequate default configuration + * Adequate default configuration * Focus on plaintext storage for your data and configs in simple, parseable formats and adherence to the xdg basedir spec - * Visually, similar to uzbl-core except that the statusbar contains useful things. One window per webpage + * Visually, similar to uzbl-core except that the statusbar contains useful things. One window per webpage #### uzbl-tabbed: wraps around uzbl-browser and multiplexes it @@ -84,7 +84,7 @@ Uzbl will read commands via standard input, named fifo pipe (if `fifo_dir` is se For convenience, uzbl can also be instructed to read commands from a file on startup by using the `-c` option. Indeed, the config file is nothing more than a list of commands. Each command starts with the name of the command or an uzbl variable that expands to it. A command is terminated by a newline. -Empty lines and lines that start with the hash sign are ignored by the parser. Command names are always written in lowercase. +Empty lines and lines that start with the hash sign are ignored by the parser. Command names are always written in lowercase. The following commands are recognized: @@ -171,7 +171,7 @@ The following commands are recognized: ### VARIABLES AND CONSTANTS Uzbl has a lot of internal variables and constants. You can get the values (using the `print` command, see above), and for variables you can also change the value at -runtime. Some of the values can be passed at start up through commandline arguments, others need to be set by using commands (eg in config file). +runtime. Some of the values can be passed at start up through commandline arguments, others need to be set by using commands (eg in config file). Some of them have default values (see config.h) Some variables have callback functions which will get called after setting the variable to perform some additional logic (see below) @@ -300,7 +300,7 @@ the java script in @< >@. print The currently viewed document contains @@ links -The @<>@ substitution can also load JavaScript from a file, syntax: @<+filename>@ +The @<>@ substitution can also load JavaScript from a file, syntax: @<+filename>@ print JS return value from file: @<+/path/to/file.js>@ @@ -442,7 +442,7 @@ or by having the EM listen to a socket. - see example event_handler.py Note: cookie events are not sent to an event handler but handled internally through the cookie handler because of their synchronous nature. -Cookie events are really something completely different from all other events. Maybe someday we'll use HTTP proxies or something for cookies +Cookie events are really something completely different from all other events. Maybe someday we'll use HTTP proxies or something for cookies or synchronous events (which also have other nice use cases), but for now we still use the handler code) Basically all events have this format: -- cgit v1.2.3 From 4e1b8b55242b120a1c7cfe49ee92f4390c99ff3b Mon Sep 17 00:00:00 2001 From: Dan Hackney Date: Wed, 30 Dec 2009 10:34:30 -0500 Subject: Document download and cookie handler. Explain the arguments that are passed to the handler scripts. Signed-off-by: Dan Hackney --- README | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index b36d2d8..a5d6954 100644 --- a/README +++ b/README @@ -200,8 +200,15 @@ Besides the builtin variables you can also define your own ones and use them in - `always_insert_mode`: set this to true if you don't like modal (vim-like) interfaces TODO explain plugin variable - `reset_command_mode`: automatically revert to command mode on pageload (unless always_insert_mode is set) TODO explain plugin variable - `modkey`: modkey which can be pressed to activate keybind from inside insert mode - - `download_handler` - - `cookie_handler` + - `download_handler`: Handler called when page requests a download. In addition to the standard handler arguments, appends the following extra arguments: + - `url`: The URL of the item to be downloaded. + - `proxy`: (optional) The URL of an HTTP proxy. + - `cookie_handler`: Handler called when the page requests a cookie to be retrieved or set. Appends the following arguments to the standard handler arguments. + - `op`: Either "GET" if the browser requests a cookie to be sent to the server or "PUT" if the server requests the browser save a cookie. + - `scheme`: The request address scheme ("http" or "https"). + - `host`: The host requesting the cookie. + - `path`: The request address path. + - `data`: The cookie data. Only included for "PUT" requests. - `new_window`: handler to execute to invoke new uzbl window (TODO better name) - `scheme_handler`: handler to execute for each URI navigated to - the navigation request will be ignored if handler prints "USED\n" - `fifo_dir`: location to store fifo's -- cgit v1.2.3 From aca7f1909800ad379705386b8cbb34631812f629 Mon Sep 17 00:00:00 2001 From: Dan Hackney Date: Wed, 30 Dec 2009 11:22:36 -0500 Subject: Document last few variables Starting with "zoom_level" and going until "caret_browsing", in the order they are defined in "uzbl-core.c". Signed-off-by: Dan Hackney --- README | 47 ++++++++++++++++++++++++----------------------- 1 file changed, 24 insertions(+), 23 deletions(-) (limited to 'README') diff --git a/README b/README index a5d6954..143b3b2 100644 --- a/README +++ b/README @@ -218,30 +218,31 @@ Besides the builtin variables you can also define your own ones and use them in - `proxy_url`: http traffic socks proxy (eg: http://:) - `max_conns`: max simultaneous connections (default: 100) - `max_conns_host`: max simultaneous connections per hostname (default: 6) + - `view_source`: Set the browser in "view source" mode (default 0). Any URI visited while "view_source" is 1 will display the page source rather than the rendered content. - `useragent`: to be expanded string - - `zoom_level` - - `font_size` - - `monospace_size` - - `minimum_font_size` - - `disable_plugins` (TODO rename to enable) - - `disable_scripts` (TODO rename to enable) - - `autoload_images` - - `autoshrink_images`: shrink images to window size (default 0) - - `enable_spellcheck` - - `enable_private` - - `print_backgrounds`: print background images? (default 0) - - `stylesheet_uri`: use this to override the pagelayout with a custom stylesheet - - `resizable_text_areas` - - `default_encoding`: iso-8859-1 by default - - `enforce_96_dpi`: 1 by default - - `caret_browsing` - - `default_font_family` = sans-serif - - `monospace_font_family` = monospace (example "Aerial Mono" ) - - `cursive_font_family` = sans - - `fantasy_font_family` = "Pterra" - - `serif_font_family` = serif (example "DejaVu Serif") - - `sans_serif_font_family` = sans (example "DejaVu Sans") - + - `zoom_level`: The factor by which elements in the page are scaled with respect to their original size. Setting this will resize the currently displayed page. + - `zoom_type`: Whether to use "full-content" zoom (defaults to true). With full-content zoom on, all page content, not just text, is zoomed. When full-content zoom is off, only the text of a page is zoomed. + - `font_size`: The default font size. + - `default_font_family`: The default font family used to display text. + - `monospace_font_family`: The default font family used to display monospace text. + - `cursive_font_family`: The default Cursive font family used to display text. + - `sans_serif_font_family`: The default Sans Serif font family used to display text. + - `serif_font_family`: The default Serif font family used to display text. + - `fantasy_font_family`: The default Fantasy font family used to display text. + - `monospace_size`: The default size of monospaced font (default 1). + - `minimum_font_size`: The minimum font size used to display text (default 1). + - `disable_plugins`: (TODO rename to enable) + - `disable_scripts`: (TODO rename to enable) + - `autoload_images`: Automatically load images (default 1). + - `autoshrink_images`: Shrink images to window size (default 0). + - `enable_spellcheck`: + - `enable_private`: + - `print_backgrounds`: Print background images? (default 0). + - `stylesheet_uri`: Use this to override the pagelayout with a custom stylesheet. + - `resizable_text_areas`: Whether text areas can be resized (default 0). + - `default_encoding`: The default text encoding (default "iso-8859-1"). + - `enforce_96_dpi`: Enforce a resolution of 96 DPI (default 1). + - `caret_browsing`: Whether the caret is enabled in the text portion of pages (default 0). * Constants (not dumpable or writeable): - WEBKIT_MAJOR: set at compile time -- cgit v1.2.3 From ada5485e4f202ff0cc251357c471f569f369e077 Mon Sep 17 00:00:00 2001 From: Dan Hackney Date: Wed, 30 Dec 2009 11:26:04 -0500 Subject: Remove unused variables. The variables: - status_message - status_pbar_done - status_pbar_pending - status_pbar_width - insert_indicator - command_indicator - insert_mode - always_insert_mode - reset_command_mode - modkey Are no longer used in "uzbl-core.c", so remove them from the documentation. Signed-off-by: Dan Hackney --- README | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) (limited to 'README') diff --git a/README b/README index 143b3b2..f3ec3e9 100644 --- a/README +++ b/README @@ -178,28 +178,19 @@ Some variables have callback functions which will get called after setting the v Besides the builtin variables you can also define your own ones and use them in the exact same way as the builtin ones. * Variables: - - `uri`: (callback: load the uri) + - `uri`: The URI of the current page. (callback: load the uri) - `verbose`: affects output on stdout - - `inject_html` + - `inject_html`: Inject an HTML string, navigating to the URI "about:blank" and rendering the HTML sting given. + - `geometry`: Geometry and position of the Uzbl window. Format is "x++". - `keycmd`: holds the input buffer (callback: update input buffer) - - `status_message`: (callback: update title) - `show_status`: show statusbar or not - `status_top`: statusbar on top? - `status_format`: marked up, to be expanded string for statusbar (callback: update statusbar) - - `status_pbar_done`: character to denote done % of pageload - - `status_pbar_pending`: character to denote pending % of pageload - - `status_pbar_width`: width of progressbar - `status_background`: color which can be used to override Gtk theme. - - `insert_indicator`: string to denote insert mode TODO plugin variable - - `command_indicator`: string to denote command mode TODO plugin variable - `title_format_long`: titlebar string when no statusbar shown (will be expanded - `title_format_short`: titlebar string when statusbar shown (will be expanded) - `icon`: path to icon for Gtk - `forward_keys`: whether uzbl-core should send key events to the webkit view - - `insert_mode`: whether insert mode is active TODO explain plugin variable - - `always_insert_mode`: set this to true if you don't like modal (vim-like) interfaces TODO explain plugin variable - - `reset_command_mode`: automatically revert to command mode on pageload (unless always_insert_mode is set) TODO explain plugin variable - - `modkey`: modkey which can be pressed to activate keybind from inside insert mode - `download_handler`: Handler called when page requests a download. In addition to the standard handler arguments, appends the following extra arguments: - `url`: The URL of the item to be downloaded. - `proxy`: (optional) The URL of an HTTP proxy. -- cgit v1.2.3 From fbbb7ed7fdc089cc71a6ef22e1587c0bec1c1842 Mon Sep 17 00:00:00 2001 From: Dan Hackney Date: Wed, 30 Dec 2009 14:49:59 -0500 Subject: Variable doc matches command format. Variables are in a top-level list, similar to the list of commands. Formatting is made more consistent. Signed-off-by: Dan Hackney --- README | 133 ++++++++++++++++++++++++++++++++--------------------------------- 1 file changed, 66 insertions(+), 67 deletions(-) (limited to 'README') diff --git a/README b/README index f3ec3e9..85ab5b2 100644 --- a/README +++ b/README @@ -177,80 +177,79 @@ Some variables have callback functions which will get called after setting the v Besides the builtin variables you can also define your own ones and use them in the exact same way as the builtin ones. -* Variables: - - `uri`: The URI of the current page. (callback: load the uri) - - `verbose`: affects output on stdout - - `inject_html`: Inject an HTML string, navigating to the URI "about:blank" and rendering the HTML sting given. - - `geometry`: Geometry and position of the Uzbl window. Format is "x++". - - `keycmd`: holds the input buffer (callback: update input buffer) - - `show_status`: show statusbar or not - - `status_top`: statusbar on top? - - `status_format`: marked up, to be expanded string for statusbar (callback: update statusbar) - - `status_background`: color which can be used to override Gtk theme. - - `title_format_long`: titlebar string when no statusbar shown (will be expanded - - `title_format_short`: titlebar string when statusbar shown (will be expanded) - - `icon`: path to icon for Gtk - - `forward_keys`: whether uzbl-core should send key events to the webkit view - - `download_handler`: Handler called when page requests a download. In addition to the standard handler arguments, appends the following extra arguments: +#### Variables: + +* `uri`: The URI of the current page. (callback: load the uri) +* `verbose`: affects output on stdout +* `inject_html`: Inject an HTML string, navigating to the URI "about:blank" and rendering the HTML sting given. +* `geometry`: Geometry and position of the Uzbl window. Format is "x++". +* `keycmd`: holds the input buffer (callback: update input buffer) +* `show_status`: show statusbar or not +* `status_top`: statusbar on top? +* `status_format`: marked up, to be expanded string for statusbar (callback: update statusbar) +* `status_background`: color which can be used to override Gtk theme. +* `title_format_long`: titlebar string when no statusbar shown (will be expanded +* `title_format_short`: titlebar string when statusbar shown (will be expanded) +* `icon`: path to icon for Gtk +* `forward_keys`: whether uzbl-core should send key events to the webkit view +* `download_handler`: Handler called when page requests a download. In addition to the standard handler arguments, appends the following extra arguments: - `url`: The URL of the item to be downloaded. - `proxy`: (optional) The URL of an HTTP proxy. - - `cookie_handler`: Handler called when the page requests a cookie to be retrieved or set. Appends the following arguments to the standard handler arguments. +* `cookie_handler`: Handler called when the page requests a cookie to be retrieved or set. Appends the following arguments to the standard handler arguments. - `op`: Either "GET" if the browser requests a cookie to be sent to the server or "PUT" if the server requests the browser save a cookie. - `scheme`: The request address scheme ("http" or "https"). - `host`: The host requesting the cookie. - `path`: The request address path. - `data`: The cookie data. Only included for "PUT" requests. - - `new_window`: handler to execute to invoke new uzbl window (TODO better name) - - `scheme_handler`: handler to execute for each URI navigated to - the navigation request will be ignored if handler prints "USED\n" - - `fifo_dir`: location to store fifo's - - `socket_dir`: location to store sockets - - `http_debug`: http debug mode (value 0-3) - - `shell_cmd`: alias which will be expanded to use shell commands (eg sh -c) - - `proxy_url`: http traffic socks proxy (eg: http://:) - - `max_conns`: max simultaneous connections (default: 100) - - `max_conns_host`: max simultaneous connections per hostname (default: 6) - - `view_source`: Set the browser in "view source" mode (default 0). Any URI visited while "view_source" is 1 will display the page source rather than the rendered content. - - `useragent`: to be expanded string - - `zoom_level`: The factor by which elements in the page are scaled with respect to their original size. Setting this will resize the currently displayed page. - - `zoom_type`: Whether to use "full-content" zoom (defaults to true). With full-content zoom on, all page content, not just text, is zoomed. When full-content zoom is off, only the text of a page is zoomed. - - `font_size`: The default font size. - - `default_font_family`: The default font family used to display text. - - `monospace_font_family`: The default font family used to display monospace text. - - `cursive_font_family`: The default Cursive font family used to display text. - - `sans_serif_font_family`: The default Sans Serif font family used to display text. - - `serif_font_family`: The default Serif font family used to display text. - - `fantasy_font_family`: The default Fantasy font family used to display text. - - `monospace_size`: The default size of monospaced font (default 1). - - `minimum_font_size`: The minimum font size used to display text (default 1). - - `disable_plugins`: (TODO rename to enable) - - `disable_scripts`: (TODO rename to enable) - - `autoload_images`: Automatically load images (default 1). - - `autoshrink_images`: Shrink images to window size (default 0). - - `enable_spellcheck`: - - `enable_private`: - - `print_backgrounds`: Print background images? (default 0). - - `stylesheet_uri`: Use this to override the pagelayout with a custom stylesheet. - - `resizable_text_areas`: Whether text areas can be resized (default 0). - - `default_encoding`: The default text encoding (default "iso-8859-1"). - - `enforce_96_dpi`: Enforce a resolution of 96 DPI (default 1). - - `caret_browsing`: Whether the caret is enabled in the text portion of pages (default 0). - -* Constants (not dumpable or writeable): - - WEBKIT_MAJOR: set at compile time - - WEBKIT_MINOR: set at compile time - - WEBKIT_MICRO: set at compile time - - ARCH_UZBL: set at compile time - - COMMIT: set at compile time - - LOAD_PROGRESS - - LOAD_PROGRESSBAR - - TITLE - - SELECTED_URI - - MODE - - NAME: name of the uzbl instance (TODO: can't we make this a variable?) - * default: Xorg window id - * overridable with cmdline arg - * in GtkSocket mode, this is a random number to prevent name clashes - +* `new_window`: handler to execute to invoke new uzbl window (TODO better name) +* `scheme_handler`: handler to execute for each URI navigated to - the navigation request will be ignored if handler prints "USED\n" +* `fifo_dir`: location to store fifo's +* `socket_dir`: location to store sockets +* `http_debug`: http debug mode (value 0-3) +* `shell_cmd`: alias which will be expanded to use shell commands (eg sh -c) +* `proxy_url`: http traffic socks proxy (eg: http://:) +* `max_conns`: max simultaneous connections (default: 100) +* `max_conns_host`: max simultaneous connections per hostname (default: 6) +* `view_source`: Set the browser in "view source" mode (default 0). Any URI visited while "view_source" is 1 will display the page source rather than the rendered content. +* `useragent`: to be expanded string +* `zoom_level`: The factor by which elements in the page are scaled with respect to their original size. Setting this will resize the currently displayed page. +* `zoom_type`: Whether to use "full-content" zoom (defaults to true). With full-content zoom on, all page content, not just text, is zoomed. When full-content zoom is off, only the text of a page is zoomed. +* `font_size`: The default font size. +* `default_font_family`: The default font family used to display text. +* `monospace_font_family`: The default font family used to display monospace text. +* `cursive_font_family`: The default Cursive font family used to display text. +* `sans_serif_font_family`: The default Sans Serif font family used to display text. +* `serif_font_family`: The default Serif font family used to display text. +* `fantasy_font_family`: The default Fantasy font family used to display text. +* `monospace_size`: The default size of monospaced font (default 1). +* `minimum_font_size`: The minimum font size used to display text (default 1). +* `disable_plugins`: (TODO rename to enable) +* `disable_scripts`: (TODO rename to enable) +* `autoload_images`: Automatically load images (default 1). +* `autoshrink_images`: Shrink images to window size (default 0). +* `enable_spellcheck`: +* `enable_private`: +* `print_backgrounds`: Print background images? (default 0). +* `stylesheet_uri`: Use this to override the pagelayout with a custom stylesheet. +* `resizable_text_areas`: Whether text areas can be resized (default 0). +* `default_encoding`: The default text encoding (default "iso-8859-1"). +* `enforce_96_dpi`: Enforce a resolution of 96 DPI (default 1). +* `caret_browsing`: Whether the caret is enabled in the text portion of pages (default 0). + +#### Constants (not dumpable or writeable): + +* `WEBKIT_MAJOR`: WebKit major version number, set at compile time. +* `WEBKIT_MINOR`: WebKit minor version number, set at compile time. +* `WEBKIT_MICRO`: WebKit micro version number, set at compile time +* `ARCH_UZBL`: Processor architecture for which Uzbl is compiled, set at compile time. +* `COMMIT`: ID of the current Git commit, set at compile time. +* `TITLE`: The current page title or "(no title)" if no title exists for the current page. +* `SELECTED_URI`: The URL currently hovered over by the mouse. +* `NAME`: name of the uzbl instance (TODO: can't we make this a variable?) + - default: Xorg window id + - overridable with cmdline arg + - in GtkSocket mode, this is a random number to prevent name clashes +* `PID`: The process ID of this Uzbl instance. ### VARIABLE EXPANSION AND COMMAND/JAVA SCRIPT SUBSTITUTION -- cgit v1.2.3 From 7be1838969b8a08a6023e1b8990a3a5c121b6352 Mon Sep 17 00:00:00 2001 From: Dan Hackney Date: Wed, 30 Dec 2009 14:50:11 -0500 Subject: Fix paragraph wrapping. Signed-off-by: Dan Hackney --- README | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index 85ab5b2..444c48e 100644 --- a/README +++ b/README @@ -170,8 +170,7 @@ The following commands are recognized: ### VARIABLES AND CONSTANTS -Uzbl has a lot of internal variables and constants. You can get the values (using the `print` command, see above), and for variables you can also change the value at -runtime. Some of the values can be passed at start up through commandline arguments, others need to be set by using commands (eg in config file). +Uzbl has a lot of internal variables and constants. You can get the values (using the `print` command, see above), and for variables you can also change the value at runtime. Some of the values can be passed at start up through commandline arguments, others need to be set by using commands (eg in config file). Some of them have default values (see config.h) Some variables have callback functions which will get called after setting the variable to perform some additional logic (see below) -- cgit v1.2.3 From a90ac5578053f6ba66843b7c1fb62303bd142701 Mon Sep 17 00:00:00 2001 From: Dan Hackney Date: Wed, 30 Dec 2009 14:51:18 -0500 Subject: Indent second-level lists to be consistent. Second-level lists are indented 4 spaces rather than 3. Signed-off-by: Dan Hackney --- README | 72 +++++++++++++++++++++++++++++++++--------------------------------- 1 file changed, 36 insertions(+), 36 deletions(-) (limited to 'README') diff --git a/README b/README index 444c48e..b0298f3 100644 --- a/README +++ b/README @@ -89,17 +89,17 @@ Empty lines and lines that start with the hash sign are ignored by the parser. C 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` @@ -107,66 +107,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