diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/COMMUNITY | 34 | ||||
| -rw-r--r-- | docs/CONTRIBUTING | 20 | ||||
| -rw-r--r-- | docs/FAQ | 8 | ||||
| -rw-r--r-- | docs/INSTALL | 8 | ||||
| -rw-r--r-- | docs/TODO | 4 | ||||
| -rw-r--r-- | docs/config-syntax | 45 | ||||
| -rw-r--r-- | docs/url-editing | 2 | ||||
| -rw-r--r-- | docs/widgets | 33 |
8 files changed, 75 insertions, 79 deletions
diff --git a/docs/COMMUNITY b/docs/COMMUNITY new file mode 100644 index 0000000..f3159ad --- /dev/null +++ b/docs/COMMUNITY @@ -0,0 +1,34 @@ +COMMUNITY +------ + +### Mailing list + +* Address: uzbl-dev@lists.uzbl.org +* [Page](http://lists.uzbl.org/listinfo.cgi/uzbl-dev-uzbl.org) +* [Archives](http://lists.uzbl.org/pipermail/uzbl-dev-uzbl.org/) + +### IRC + +* `#uzbl` on irc.freenode.net + +### Website + +* http://www.uzbl.org + +### Bugtracker + +* http://www.uzbl.org/bugs/ + +### Code repositories +Remember: dieter/master = official stable branch. +If you want to develop, develop against dieter/experimental + +* http://github.com/Dieterbe/uzbl/ +* http://github.com/anydot/uzbl/ +* http://github.com/Barrucadu/uzbl/ +* http://github.com/dusanx/uzbl/ +* http://github.com/robm/uzbl/ + +There are more contributors who have forks. See: + +[Uzbl Network graph](http://github.com/Dieterbe/uzbl/network) diff --git a/docs/CONTRIBUTING b/docs/CONTRIBUTING index 196cda4..74d1b36 100644 --- a/docs/CONTRIBUTING +++ b/docs/CONTRIBUTING @@ -20,8 +20,28 @@ workable then submitting plain patches. Git is good in merging in branches even if the base code has changed in the meanwhile. This does not work with patches. +If you're new to Git/github, have no fear: + +* [Github guides (highly recommended)](http://github.com/guides/home) +* [Guides: Fork a project and submit your modifications](http://github.com/guides/fork-a-project-and-submit-your-modifications) + +Our convention is to develop in the *experimental* branch, and keep only stable, tested stuff in *master*. +So ideally, all contributors develop in their experimental, that gets merged into the mainline experimental, and after QA it gets merged into the main master. + + ### VALGRIND PROFILING $ add this to Makefile header: CFLAGS=-g $ recompile $ valgrind --tool=callgrind ./uzbl .... $ kcachegrind callgrind.out.foo + +### MEMORY LEAK CHECKING + valgrind --tool=memcheck --leak-check=full ./uzbl + +### DEBUGGING / BACKTRACES + +* compile with -ggdb (enabled by default on experimental tree) +* run: `gdb ./uzbl` +* `(gdb) run -c /path/to/config` +* `bt` if it segfaults to see a backtrace +* you'll find more info on the interwebs @@ -1,10 +1,12 @@ FAQ --- -### I just installed uzbl but it doesn't do much. I can load one uri and quit the program but that's it. -You did not load a configuration. Uzbl does not create a default config file on startup like some other programs do. +### I just installed uzbl but it doesn't do much. What now? +Uzbl does not 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. +Uzbl includes *some* default settings hardcoded, but these are rather limited (some navigation keybinds, statusbar settings, but no history/download handlers etc.) +Look at config.h to see the default settings. +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. Use the --config parameter or save your config as $XDG\_CONFIG\_HOME/uzbl/config to have it auto-loaded. ### Where is the location bar? How do I change the URL ? diff --git a/docs/INSTALL b/docs/INSTALL index 270c343..440157a 100644 --- a/docs/INSTALL +++ b/docs/INSTALL @@ -8,6 +8,8 @@ branch you want. From source ----------- +You can pull the code from git or get a tagged tarball. + $ git clone git://github.com/Dieterbe/uzbl.git [ $ git checkout master/experimental ] # optional. see below $ cd uzbl @@ -17,6 +19,10 @@ If you want to remove uzbl again, you can issue: $ make uninstall +Tarballs can be pulled from [github.com/Dieterbe/uzbl/downloads](http://github.com/Dieterbe/uzbl/downloads) + +Though you can only get tagged versions from the master branch, which may be older then what you'll have through git. + Dependencies ------------ * git (for downloading) @@ -30,7 +36,7 @@ Optional/Recommended The following tools are quite useful, and some of them are used in the sample scripts: -* dmenu (with vertical patch +* dmenu (with vertical patch) * zenity * bash @@ -5,9 +5,8 @@ More or less in order of importance/urgency * allow to tag , to group instances together * store uri/tag/name/state in xorg window properties * split up uzbl.c into multiple files -* define a basic, simple default config so uzbl is a bit uzbl by default * shortcuts to focus other instances (see docs/multiple-instances-management) - +* password handler (manager) * recognize -h with GOption? * implement a vimperator-like link following scheme. @@ -42,6 +41,7 @@ More or less in order of importance/urgency * regex style page searching? so you can do 'or' and 'and' things. flags like case sensitive etc. * check for real command name, not just the first letter. * let users attach handlers to the most common events/signals in uzbl. + great use case: automatically calling formfiller for certain sites * write little script to open new urls with the urxvt url thing +document. SOMEDAY: diff --git a/docs/config-syntax b/docs/config-syntax index 30cf91f..9894401 100644 --- a/docs/config-syntax +++ b/docs/config-syntax @@ -1,42 +1,5 @@ -Configuration setting at startup and changing at runtime happens through one of these: -- stdin at startup (TODO: see if we can keep listening while running) (write command to it + "\n") -- fifo (write command to it + "\n") -- socket (uzblctrl -s <file> -c <comand> - -Lines written to the above starting with '#' or being empty, are ignored. - -** Command syntax: -commands can have no, one or 2 arguments. - -<command>[\t<arg1>[\t<arg2>]] - -The 'bind' command is a special command, where argument 1 is a keyboard character (combo) and argument 2 is a command as specified above. -You can also use a '_' in the <chars> part to denote where you pass on whatever you want, which will be replaced into the specififed command whereever %s is mentioned - -** commands -Commands where one of the arguments is "parameter" expect this arugment to be a valid variable identifier (eg uzbl.behave.status_format) - -set parameter value # make sure the value complies with the datatype. -toggle parameter # expects parameter to be a gboolean. (eg status, insert_mode, ..) -get parameter -bind <chars> <command> -script <JS code to execute> -script_file <filename containing JS code to execute> -back -forward -scroll_vert <int> -scroll_horz <int> -reload -reload_ign_cache -stop -zoom_in -zoom_out -spawn <filename for process to start asynchronously> -exit -search <string> - -The 'set' command may do more then just set the variable. eg 'set uri' commands will also cause uzbl to navigate to the uri. - +here: design notes +readme: end-user instructions Rationale. AKA "why not config files?" @@ -53,4 +16,6 @@ issues - iterate over state structs and generate appropriate commands to bring an instance in this state. - plaintext :) - user editable - - also useful for saving state if we need to update/shutdown/..
\ No newline at end of file + - also useful for saving state if we need to update/shutdown/.. + -> all of this is overkill. for now we just decided to live with the fact we pass on '--config' flags, + it's up to the user to tweak his setup so it works. diff --git a/docs/url-editing b/docs/url-editing index 1059fc5..d8943fb 100644 --- a/docs/url-editing +++ b/docs/url-editing @@ -5,3 +5,5 @@ Use cases: * edit current url or one from history/bookmarks: dmenu-vertical is relatively good for this, though it would be better if we had: - minimal editing helper key shortcuts (eg to go to beginning/end of input buffer, erase search string, undo) - copy/paste support + +* Though you can obviously type new urls and edit the current ones with the appropriate statusbar stuff/binds/xclip commands, this is sometimes enough.
\ No newline at end of file diff --git a/docs/widgets b/docs/widgets deleted file mode 100644 index dc7127a..0000000 --- a/docs/widgets +++ /dev/null @@ -1,33 +0,0 @@ - -* statusbar? (the bar you see in pretty much every gtk program at the -* bottom. eg firefox) - consumes too much space (if always visible) for the little it is used. (+ -* you can put only 1 message in it at a time!) - -> option 1: no statusbar at all. when hovering over a link (or pressing - -> key to preview the url without changing page) -> show url in tooltip on - -> page. - -> option 2: toggle visibility of statusbar on/off when hovering over a - -> link. since it's at the bottom I don't think it will disturb too much. -* viewing progress/state of pageload? most programs use statusbar for this. - -> option 1: titlebar can show a percentage when it's loading a new page. - -> option 2: toggle a statusbar everytime we start loading a new page. -* uri bar -> yes, even though we can write stuff to the fifo, it can still -* be convenient to change the url manually and stuff, so a widget in uzbl -* itself is good. -* tabs -> yes. you don't have to use them, but you can. -* back/forward/.. buttons? -> no: use keyboard shortcuts. -* searching in a page? not sure.. maybe we can abuse the statusbar for that -* too. - eg toggle it on when the user wants to search for something and then do -* searching in some vim-like fashion. - we don't need a gtk text entry widget, just a feedback display of what the -* current command is. -* scrollbar? no: use keyboard shortcuts. we should however have some info -* about the page length and where we are. - -> option 1: put a percentage in the window title - -> option 2: everytime you hit a key to change position, temporarily make - -> a statusbar visible and put the percentage in the statusbar. - what will we do with pages who are too wide? horizontal scrolling? -all of the above goes in 1 bar at the top of the program. there should be a -key to toggle visibility of it and one to toggle visibilety + focus on the -entrybar at once. |