README

   1 zea - zeig's einfach an
   2 =======================
   3
   4 zea is a minimalistic web browser using Gtk2, GLib and WebKit. "Zeig's
   5 einfach an" is german and translates roughly to "just show it" (the damn
   6 web page).
   7
   8 Features:
   9
  10         - A WebKit viewport
  11         - An input box to change the current URL
  12         - Global content zoom
  13         - Pluggability into suckless' tabbed
  14         - vi-like scrolling (modified by CTRL)
  15         - Searching the current page for a word
  16         - Adblock
  17         - Support for Flash and Java
  18         - Cooperative instances using FIFOs (can be turned off)
  19
  20 Planned features:
  21
  22         - Keyword based searching (opening "wi foo" will search wikipedia)
  23
  24
  25 Using zea with tabbed
  26 =====================
  27
  28 The order of arguments for zea doesn't matter. This means you can run it
  29 like this:
  30
  31         $ tabbed -c ./zea file:///home/hans/bookmarks.html -z 0.8 -e
  32
  33 Each new tab will then show your bookmarks and is scaled by a factor of
  34 0.8.
  35
  36 If "-e" is not specified, zea will launch tabbed automatically. Note
  37 that you can't use tabbed's "Ctrl+Shift+Enter" hotkey to open a new tab
  38 this way (zea will simply call "tabbed -c -d", so tabbed will know
  39 nothing about zea). However, due to zea's cooperative instances, you can
  40 simply start zea a second time and it will create a new tab.
  41
  42
  43 Adblock
  44 =======
  45
  46 zea has built-in adblock functionality. In each line of
  47
  48         ~/.config/zea/adblock.black
  49
  50 you can store a regular expression. These expressions match
  51 case-insensitive and partially, i.e. ".*foo.*" is the same as ".*FOO.*"
  52 and you can use anchors like "^https?://...".
  53
  54
  55 Literature
  56 ==========
  57
  58 API references:
  59
  60         - http://webkitgtk.org/reference/webkitgtk/stable/index.html
  61         - https://developer.gnome.org/gtk2/stable/index.html
  62         - https://developer.gnome.org/glib/stable/index.html
  63
  64 Regular expressions supported by GRegex, you can use these in your
  65 adblock patterns:
  66
  67         - https://developer.gnome.org/glib/stable/glib-regex-syntax.html