README

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