X-Git-Url: https://vcs.maemo.org/git/?a=blobdiff_plain;f=README;h=cb7974b95b9b5eecf3d82fc281bac4dd3ef8e01b;hb=HEAD;hp=143acf12cb91d0771cb0b1087620ea984eae9861;hpb=df134cbafaf42ecaba2412613a96b92e43adb2c9;p=uzbl-mobile diff --git a/README b/README index 143acf1..cb7974b 100644 --- a/README +++ b/README @@ -2,32 +2,31 @@ * people want a browser that does everything * people who want a browser with things like a built-in bookmark manager, address bar, forward/back buttons, ... * people who expect something that works by default. You'll need to read configs and write/edit scripts - +* people who like nothing from this list: mpd, moc, wmii, dwm, awesome, mutt, pine, vim, dmenu, screen, irssi, weechat, bitlbee ### TO NEW PEOPLE: * please read the documentation in /usr/share/uzbl/docs * invoke uzbl --help -* to get you started: uzbl --uri 'http://www.archlinux.org' --config /usr/share/uzbl/examples/configs/sampleconfig -* study the sample config, have a look at all the bindings, and note how you can call the scripts to load new url from history and the bookmarks file -* note that there is no url bar. all url editing is supposed to happen _outside_ of uzbl. - For now, you can use the `load_from_*` dmenu based scripts to pick a url or type a new one or write commands into the fifo (see /usr/share/uzbl/docs/CHECKLIST) +* to get you started: `XDG_DATA_HOME=/usr/share/uzbl/examples/data XDG_CONFIG_HOME=/usr/share/uzbl/examples/config uzbl --uri www.archlinux.org` +* try and study the sample config, read the readme to find out how it works. +* You can change the url with commands (if you have setup the appropriate keybinds) but to be most effective it's better to do url editing/changing _outside_ of uzbl. + Eg, you can use the `load_from_*` dmenu based scripts to pick/edit a url or type a new one. * If you have questions, you are likely to find answers in the FAQ or in the other documentation. ### INTRODUCTION - In my opinion, any program can only be really useful if it complies to the unix philosophy. + Any program can only be really useful if it complies to the unix philosophy. Web browsers are frequent violators of this principle: -* They build in way too much things into the browser, dramatically decreasing the options to do things the way you want. +* They build in way too much things into the browser, dramatically decreasing the options to do things the way you want. * They store things in way too fancy formats (xml, rdf, sqlite, ... ) which are hard to store under version control, reuse in other scripts, ... Time to change that! - Here are the general ideas: + Here are the general ideas (not all of these are implemented perfectly yet): * each instance of uzbl renders 1 page (eg it's a small wrapper around webkit), no tabbing, tab previews, or speed dial things. - For "multiple instances management" use your window managers, or scripts. - This way you can get something much more useful than tabbing (see rationale in docs) + For "multiple instances management" use your window managers, scripts or wrappers. * very simple, plaintext , changeable at runtime configuration * various interfaces for (programmatic) interaction with uzbl (see below) * customizable keyboard shortcuts in vim or emacs style (whatever user wants) @@ -53,18 +52,19 @@ Time to change that! ### CONFIGURATION / CONTROL: -The general idea is that uzbl by default is very bare bones. you can send it commands to update settings and perform actions, through various interfaces. (TODO: some default settings) -For examples, please see the sample config(s). +The general idea is that uzbl by default is very bare bones. you can send it commands to update settings and perform actions, through various interfaces. +There is a limited default configuration. Please see config.h to see what it contains. +By default, there are *no* keybinds defined at all. (Default keybinds would work counterproductive when you try to customize) +For examples of the possibilities what you can do, please see the sample config(s), and uzbl wiki page. There are several interfaces to interact with uzbl: * uzbl --config : will be read line by line, and the commands in it will be executed. useful to configure uzbl at startup. If you have a file in `$XDG_CONFIG_HOME/uzbl/config` (this expands to ~/.config/uzbl/config on most systems) it will be automatically recognized -* stdin: you can also write commands into stdin +* stdin: to write commands into stdin, use `--config -` (or `-c -`) * 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 - Press ESC/i to toggle command/insert mode But if you don't like modal interfaces, you can set `always_insert_mode` and configure a modkey to execute the commands. (emacs style). 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) @@ -81,104 +81,260 @@ When uzbl forks a new instance (eg "open in new window") it will use the same co If you made changes to the configuration at runtime, these are not pased on to the child. ### COMMAND SYNTAX -Commands are used for: - -* creating keybindings -* altering variables -* getting the values of variables -* running actions -* setting the input buffer - Uzbl will read commands via standard input, named fifo pipe (if `fifo_dir` is set) and IPC socket (when `socket_dir` is set). 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, which must be the first thing on a line; preceding whitespace is not allowed. -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 not case sensitive. +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. The following commands are recognized: - SET = -Set is used for changing variables. Every variable can be changed on the fly and for some variables, some additional logic is performed. -For example, setting the variable `uri` will make uzbl start loading it, and changing the format of the statusbar/windowtitle/user agent/.. will be effective immediately. -If you want to unset a string, use SET with one space after the equals sign. - - GET -Use this to print the value of a key. (and TODO, get the value through the socket) - - BIND = -Makes the character sequence `` invoke `` when typed interactively in uzbl. -There are a few tricks you can do: - -* `` ends with an underscore: the action 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 action will be invoked on every keystroke). -* `` ends on a different character: you need to type the full string, which will trigger the action immediately, without pressing enter/return. - -Examples: - - # uzbl will load the url when you type: 'o ' - bind o _ = uri %s - # a search action which is called on every character you type after the slash, letting you see the search narrow down on the words as you type it. Hitting return, enter or esc will terminate the search. - bind /* = search %s - # when you type `ZZ` and nothing else, the exit action will be triggered immediately. - bind ZZ = exit - - ACT -This tells uzbl to execute an action immediately. The simplest example of this would be `act exit`; you know what that'll do. - - KEYCMD -This sets the interactive command buffer to ``. Keycmd is primarily useful for scripts that help you type a command while still letting you edit it before execution. -For example, if you have a binding like "o _" that opens an URL, then you could create a binding `O` that spawns a script which will set the command buffer to "o current-uri-here", letting you enter relative URLs easily. -(See sample config) - -### ACTIONS -Actions are invoked via bindings and by the ACT command. Most actions are self-explanatory, though a few need to be clarified. A list of action follows: - - * `back` - * `forward` - * `scroll_vert ` - * `scroll_horiz ` - * `scroll_begin` - * `scroll_end` - * `reload` - * `reload_ign_cache` - * `stop` - * `zoom_in` - * `zoom_out` - * `uri
` - * `script ` - - execute the javascript in `` - - remember that the commands, and thus actions, must not contain line breaks - * `toggle_status` - * `spawn ` - - runs a command; see EXTERNAL SCRIPTS for details - - PATH is searched so giving the full path to commands is not neccessary - * `sh