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