README

   1                                ==========
   2                                  lariza
   3                                ==========
   4
   5 A simple web browser using Gtk2, GLib and WebKitGtk.
   6
   7 Features:
   8
   9         - A WebKit viewport
  10         - An input box to change the current URL
  11         - Global content zoom
  12         - Pluggability into suckless' tabbed
  13         - vi-like scrolling (modified by CTRL)
  14         - Searching the current page for a word
  15         - Adblock
  16         - Support for Flash and Java
  17         - Cooperative instances using FIFOs (can be turned off)
  18
  19 Planned features:
  20
  21         - Keyword based searching (opening "wi foo" will search wikipedia)
  22
  23
  24 About the name
  25 ==============
  26
  27 "lariza" stems from a german sentence:
  28
  29         Alle anderen waren mir zu anstrengend.
  30          l   a         r    i  z  a
  31
  32 That phrase basically means: "It was too tiresome to deal with any other
  33 browser." I couldn't find a simple browser that does just what I need.
  34 Most of them are utterly bloated, others lack essential functions. Thus,
  35 I was forced to write scripts and tools and stuff to deal with these
  36 issues. That is what was tiresome. I don't want to work around bugs or
  37 nonsensical behavior anymore.
  38
  39 So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty work.
  40
  41
  42 What lariza is and what it's not
  43 ================================
  44
  45 lariza does what I need. It won't do other things. I'm open for pull
  46 requests but please don't be upset if I turn them down -- which might
  47 happen if it's a feature that I simply don't need.
  48
  49 Especially, it's very likely that lariza will never have a "follow
  50 mode" like dwb, luakit or others have. I've used these browsers for
  51 quite some time and I also used Firefox extensions that add a "follow
  52 mode". The point is, "follow mode" doesn't work anymore. This was a good
  53 thing ten years ago. Today, a lot of website make heavy use of
  54 JavaScript or hovering. You NEED some kind of pointing device. I found
  55 using "follow mode" to be very frustrating today, because you still have
  56 to reach for the mouse all the time. So, you might as well just optimize
  57 your mousing workflow.
  58
  59
  60 Using lariza with tabbed
  61 ========================
  62
  63 The order of arguments for lariza doesn't matter. This means you can run
  64 it like this:
  65
  66         $ tabbed -c lariza file:///home/hans/bookmarks.html -z 0.8 -e
  67
  68 Each new tab will then show your bookmarks and is scaled by a factor of
  69 0.8.
  70
  71 If "-e" is not specified, lariza will launch tabbed automatically. Note
  72 that you can't use tabbed's "Ctrl+Shift+Enter" hotkey to open a new tab
  73 this way (lariza will simply call "tabbed -c -d", so tabbed will know
  74 nothing about lariza). However, due to lariza's cooperative instances,
  75 you can simply start lariza a second time and it will create a new tab.
  76
  77
  78 Adblock
  79 =======
  80
  81 lariza has built-in adblock functionality. In each line of
  82
  83         ~/.config/lariza/adblock.black
  84
  85 you can store a regular expression. These expressions match
  86 case-insensitive and partially, i.e. ".*foo.*" is the same as ".*FOO.*"
  87 and you can use anchors like "^https?://...".
  88
  89
  90 Literature
  91 ==========
  92
  93 API references:
  94
  95         - http://webkitgtk.org/reference/webkitgtk/stable/index.html
  96         - https://developer.gnome.org/gtk2/stable/index.html
  97         - https://developer.gnome.org/glib/stable/index.html
  98
  99 Regular expressions supported by GRegex, you can use these in your
 100 adblock patterns:
 101
 102         - https://developer.gnome.org/glib/stable/glib-regex-syntax.html