README

   1
   2                                ==========
   3                                  lariza
   4                                ==========
   5
   6
   7 A simple web browser using GTK+ 2, GLib and WebKitGTK+.
   8
   9 Features:
  10
  11         - A WebKit viewport
  12         - An input box to change the current URL
  13         - Global content zoom
  14         - Pluggability into suckless' tabbed
  15         - Built-in downloads
  16         - Optimized hotkeys: Left hand on keyboard, right hand on mouse
  17         - Searching the current page for a word
  18         - Keyword based searching (opening "wi foo" will search wikipedia)
  19         - Adblock
  20         - Support for Flash and Java
  21         - Cooperative instances using FIFOs (can be turned off)
  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 websites 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 lariza does not compete with powerful browsers like dwb or luakit, nor
  60 with monstrous applications like Firefox or Chromium. lariza won't have
  61 persistent storage, nor a plugin system, nor cloud sync, nor bookmarks.
  62
  63 lariza tries not to exceed 1000 lines of code.
  64
  65
  66 Using lariza with tabbed
  67 ========================
  68
  69 The order of arguments for lariza doesn't matter. This means you can run
  70 it like this:
  71
  72         $ tabbed -c lariza file:///home/hans/bookmarks.html -z 0.8 -e
  73
  74 Each new tab will then show your bookmarks and is scaled by a factor of
  75 0.8.
  76
  77 If "-e" is not specified, lariza will launch tabbed automatically. Note
  78 that you can't use tabbed's "Ctrl+Shift+Enter" hotkey to open a new tab
  79 this way (lariza will simply call "tabbed -c -d", so tabbed will know
  80 nothing about lariza). However, due to lariza's cooperative instances,
  81 you can simply start lariza a second time and it will create a new tab.
  82
  83
  84 Adblock
  85 =======
  86
  87 lariza has built-in adblock functionality. In each line of
  88
  89         ~/.config/lariza/adblock.black
  90
  91 you can store a regular expression. These expressions match
  92 case-insensitive and partially, i.e. ".*foo.*" is the same as ".*FOO.*"
  93 and you can use anchors like "^https?://...".
  94
  95
  96 WebKit local storage
  97 ====================
  98
  99 WebKit does create files in your $XDG_* directories, i.e. ~/.local/share
 100 or ~/.cache. It's up to you what you want to do with this junk. I remove
 101 it regularly if no WebKit browser is running. Another option would be to
 102 change the $XDG_* variables.
 103
 104 I have explicitly not turned off the local storage feature in WebKit
 105 because I don't know if this breaks web applications.
 106
 107
 108 Literature
 109 ==========
 110
 111 API references:
 112
 113         - http://webkitgtk.org/reference/webkitgtk/stable/index.html
 114         - https://developer.gnome.org/gtk2/stable/index.html
 115         - https://developer.gnome.org/glib/stable/index.html
 116
 117 Regular expressions supported by GRegex, you can use these in your
 118 adblock patterns:
 119
 120         - https://developer.gnome.org/glib/stable/glib-regex-syntax.html