post-history-handler-deprecation documentation update
[uzbl-mobile] / docs / FAQ
index 31912ac..f8e6e8a 100644 (file)
--- a/docs/FAQ
+++ b/docs/FAQ
@@ -4,11 +4,35 @@ FAQ
 ### I just installed uzbl but it doesn't do much.  What now?
 Uzbl includes very limited default settings (statusbar settings, but no keybinds, history/download handlers etc.)
 Look at /usr/share/uzbl/docs/config.h to see the default settings.
-Neither does uzbl create a default config file on startup like some other programs do.
-Because we want to give you the freedom to place your config where you want, and to use a config or not.
-Have a look in /usr/share/uzbl/examples/configs to see what you can do. You will probably want to create your own config based on an example config
-so you can add keybinds and to use scripts.
-Use the --config parameter or save your config as $XDG\_CONFIG\_HOME/uzbl/config to have it auto-loaded.
+Have a look in /usr/share/uzbl/examples/configs to see what you can do.
+
+If you save a config as $XDG\_CONFIG\_HOME/uzbl/config it will be loaded automatically.
+Running with the `--verbose` flag on a command line can also be interesting.
+To get you started, try this:
+`XDG_DATA_HOME=/usr/share/uzbl/examples/data XDG_CONFIG_HOME=/usr/share/uzbl/examples/config uzbl`
+It will temporarily override your $XDG\_CONFIG\_HOME and $XDG\_DATA\_HOME
+variables so you can try the sample stuff directly in /usr/share/uzbl/examples.
+If you like what you can do, you can copy the sample stuff into your ~ and edit to your liking.
+
+### Why don't you just use a reasonable config by default?
+We actually did some attempts to make uzbl "usable by default" but in the
+end we had to conclude it cannot be done because of the following reasons:
+
+ * We don't want to store anything "automagically" in the users home.
+   Some people prefer different file/directory layouts, most of just want to
+   control the files in $HOME themselves.
+ * We considered the option of having a global '/etc/uzbl' which user
+   specific ones could override but that would overcomplicate things.
+ * We adhere to the [FHS](http://www.pathname.com/fhs/) (`man hier`), so
+   `uzbl -c /usr/share/...` is not an option.
+
+So even though we would like to make uzbl more usable by default, we think
+there is no sensible way to do it.  Maybe downstream packagers could provide
+a note that users could copy the examples from /usr/share/uzbl/examples into
+their homes, because really, that's all that is needed if you want it to
+just "work" without controlling how yourself. (unless you have no
+xdg variables set, in which case you should be smart enough to edit the sample
+config yourself).
 
 ### Where is the location bar? How do I change the URL ?
 Uzbl has no location bar.  All changes to the uri (editing of current uri, typing new uri, loading of uri from bookmarks/history/...) happens *outside* of uzbl.
@@ -17,12 +41,28 @@ useful with history/bookmarks) with a limited set of keystrokes.  see man dmenu.
 You can also use it to make edits to a uri (press tab to load it into the
 search field) or type a url from scratch, though dmenu
 is not the most suitable editor. We're looking into a better way to make edits.
-Zenity is also an option, if you want copy-paste support.
+Tools such as Zenity are also quite suited for this.
+And you can always make keybinds to load the current uri in the command field, paste/load urls from
+clipboard etc.
 
 ### Where are the widgets (forward, back,.. button etc)
 Uzbl's layout only contains what you really need to see.  we only have a statusbar, which even can also be disabled.  There are no buttons, but we do
 have lots of keybinding possibilities.
 
+### No tabs? Why do you need a new window for each page?
+We stick to "one page per uzbl instance" because that's a simple, clean and flexible method.  We believe "multiple instances management" is something that must
+be handled outside of uzbl by a separate/different program.  Here are some solutions:
+
+ * Many window managers can (and should) handle this by default.  Xmonads tabbed layout, Wmii's stacked layout, fluxbox or kwin tabs and so on.
+ * Uzbl supports acting as a GtkPlug to plug into GtkSockets (Xembed) so you can embed uzbl instances in other Gtk applications.
+   This allows several implementatinos, a popular one is [uzbl_tabbed.py](http://www.uzbl.org/wiki/uzbl_tabbed)
+ * If you want highest customizablity, you need the 3rd option:
+   You can also write a custom script.  The only thing you need to do is focus/maximize the instance you want,
+   keep the others out of sight and use tools like dmenu and wmctrl to switch instances.
+   This allows you to use application-specific properties (such as uzbl tag, name etc).
+   For more information about this approach, see docs/multiple-instances-management.
+   (If you want to work on such script, let us know and we might include it along with the other sample scripts)
+
 ### What?  No support for bookmarks/history/downloads/cookies/... ? Your project sucks!
 We do not support *management* of those things, because we believe a browser should only do browsing.  We are firm believers in the unix philosophy.
 You have to look at the bigger picture.  In fact, we do support all these things.  Take bookmarks as an example:
@@ -76,6 +116,14 @@ They both have advantages and disadvantages:
 
 So, when writing scripts, using fifo's is usually the fastest method (because you do not need to fork another process), so fifo is preferred unless you need a response.
 
+### What the hell is this 'XDG' stuff??
+You'll notice our example scripts and configs use variables such as `$XDG_CONFIG_HOME` and `$XDG_DATA_HOME`.
+Most of us really like the [xdg basedir spec](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html)
+so our example material folows it.  Basically it helps you keeping a clean `$HOME` and it separates config, data and cache.
+If these variables are not defined on your system, it could be that you need to install an xdg package.
+If you don't like this, no one is stopping you from changing the scripts and configs to point to a single `$HOME/.uzbl` directory or whatever you want.
+
+
 ### Does the world really need another browser?
 We did try a lot of browsers, and we do not suffer [NIH](http://en.wikipedia.org/wiki/Not_Invented_Here).
 We believe that the approach taken by way too many browsers is wrong.  We do not want browsers that try to do everything,
@@ -84,7 +132,3 @@ We also like open source.  We take a lot of things from other projects and we al
 
 ### What? You call all of this user-friendly?
 Yes.  If you don't agree, don't use it :)
-
-### Why can't I get uzbl to work on Ubuntu?
-Instead of using the old version in the apt repository (1.0.1), 
-[download the latest webkit](http://webkitgtk.org/?page=download), compile, and install.