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         - Downloading files using wget
  16         - vi-like scrolling (modified by CTRL)
  17         - Searching the current page for a word
  18         - Adblock
  19         - Support for Flash and Java
  20         - Cooperative instances using FIFOs (can be turned off)
  21
  22 Planned features:
  23
  24         - Keyword based searching (opening "wi foo" will search wikipedia)
  25
  26
  27 About the name
  28 ==============
  29
  30 "lariza" stems from a german sentence:
  31
  32         Alle anderen waren mir zu anstrengend.
  33          l   a         r    i  z  a
  34
  35 That phrase basically means: "It was too tiresome to deal with any other
  36 browser." I couldn't find a simple browser that does just what I need.
  37 Most of them are utterly bloated, others lack essential functions. Thus,
  38 I was forced to write scripts and tools and stuff to deal with these
  39 issues. That is what was tiresome. I don't want to work around bugs or
  40 nonsensical behavior anymore.
  41
  42 So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty work.
  43
  44
  45 What lariza is and what it's not
  46 ================================
  47
  48 lariza does what I need. It won't do other things. I'm open for pull
  49 requests but please don't be upset if I turn them down -- which might
  50 happen if it's a feature that I simply don't need.
  51
  52 Especially, it's very likely that lariza will never have a "follow
  53 mode" like dwb, luakit or others have. I've used these browsers for
  54 quite some time and I also used Firefox extensions that add a "follow
  55 mode". The point is, "follow mode" doesn't work anymore. This was a good
  56 thing ten years ago. Today, a lot of websites make heavy use of
  57 JavaScript or hovering. You NEED some kind of pointing device. I found
  58 using "follow mode" to be very frustrating today, because you still have
  59 to reach for the mouse all the time. So, you might as well just optimize
  60 your mousing workflow.
  61
  62 lariza does not compete with powerful browsers like dwb or luakit, nor
  63 with monstrous applications like Firefox or Chromium. lariza won't have
  64 persistent storage, nor a plugin system, nor cloud sync, nor bookmarks.
  65
  66 lariza tries not to exceed 1000 lines of code.
  67
  68
  69 Using lariza with tabbed
  70 ========================
  71
  72 The order of arguments for lariza doesn't matter. This means you can run
  73 it like this:
  74
  75         $ tabbed -c lariza file:///home/hans/bookmarks.html -z 0.8 -e
  76
  77 Each new tab will then show your bookmarks and is scaled by a factor of
  78 0.8.
  79
  80 If "-e" is not specified, lariza will launch tabbed automatically. Note
  81 that you can't use tabbed's "Ctrl+Shift+Enter" hotkey to open a new tab
  82 this way (lariza will simply call "tabbed -c -d", so tabbed will know
  83 nothing about lariza). However, due to lariza's cooperative instances,
  84 you can simply start lariza a second time and it will create a new tab.
  85
  86
  87 Adblock
  88 =======
  89
  90 lariza has built-in adblock functionality. In each line of
  91
  92         ~/.config/lariza/adblock.black
  93
  94 you can store a regular expression. These expressions match
  95 case-insensitive and partially, i.e. ".*foo.*" is the same as ".*FOO.*"
  96 and you can use anchors like "^https?://...".
  97
  98
  99 WebKit local storage
 100 ====================
 101
 102 WebKit does create files in your $XDG_* directories, i.e. ~/.local/share
 103 or ~/.cache. It's up to you what you want to do with this junk. I remove
 104 it regularly if no WebKit browser is running. Another option would be to
 105 change the $XDG_* variables.
 106
 107 I have explicitly not turned off the local storage feature in WebKit
 108 because I don't know if this breaks web applications.
 109
 110
 111 Literature
 112 ==========
 113
 114 API references:
 115
 116         - http://webkitgtk.org/reference/webkitgtk/stable/index.html
 117         - https://developer.gnome.org/gtk2/stable/index.html
 118         - https://developer.gnome.org/glib/stable/index.html
 119
 120 Regular expressions supported by GRegex, you can use these in your
 121 adblock patterns:
 122
 123         - https://developer.gnome.org/glib/stable/glib-regex-syntax.html