README

   1                                  ======
   2                                  lariza
   3                                  ======
   4
   5
   6 A simple web browser using GTK+ 3, GLib and WebKit2GTK+.
   7
   8 Features:
   9
  10     - A WebKit2 viewport
  11     - An input box to change the URI or to search the current page
  12     - Built-in launching of suckless' tabbed
  13     - Built-in download manager
  14     - Optimized hotkeys: Left hand on keyboard, right hand on mouse
  15     - Keyword based searching: Opening "wi foo" will search wikipedia
  16     - Global content zoom
  17     - Cooperative instances using FIFOs
  18     - Certificate trust store
  19     - Support for Flash and Java
  20     - Bundled web extensions:
  21         - Adblock
  22
  23
  24 Installation
  25 ------------
  26
  27 The following C libraries are required:
  28
  29     - GTK+ 3
  30     - WebKit2 API for GTK+ 3
  31
  32 lariza expects to be run on a POSIX-ish operating system.
  33
  34 To build the program and install it to /usr/local:
  35
  36     $ make
  37     # make install
  38
  39 To use bundled web extensions, they must be copied or symlinked to the
  40 appropriate path. Please refer to the manpage.
  41
  42
  43 Running
  44 -------
  45
  46 You simply invoke the main program:
  47
  48     $ lariza
  49
  50 Refer to the manpage for all options.
  51
  52
  53 Background information
  54 ----------------------
  55
  56  What lariza is and what it's not
  57
  58   lariza does what I need. It won't do other things. I'm open for pull
  59   requests but please don't be upset if I turn them down -- which might
  60   happen if it's a feature that I simply don't need.
  61
  62   Especially, it's very likely that lariza will never have a "follow
  63   mode" like dwb, luakit or others have. I've used these browsers for
  64   quite some time and I've also used Firefox extensions that add a
  65   "follow mode". The point is, "follow mode" doesn't work anymore. This
  66   was a good thing ten years ago. Today, a lot of websites make heavy
  67   use of JavaScript or hovering. You NEED some kind of pointing device.
  68   I found using "follow mode" to be very frustrating today, because you
  69   still have to reach for the mouse all the time. So, you might as well
  70   just optimize your mousing workflow.
  71
  72   lariza does not compete with powerful browsers like dwb or luakit, nor
  73   with monstrous applications like Firefox or Chromium. lariza won't
  74   have persistent storage, nor a plugin system, nor cloud sync, nor
  75   bookmarks.
  76
  77   lariza tries not to exceed 1000 lines of code.
  78
  79
  80  About the name
  81
  82   "lariza" stems from a german sentence:
  83
  84       Alle anderen waren mir zu anstrengend.
  85        l   a         r    i  z  a
  86
  87   That phrase basically means: "It was too tiresome to deal with any
  88   other browser." I couldn't find a simple browser that does just what I
  89   need. Most of them are utterly bloated, others lack essential
  90   functions. Thus, I was forced to write scripts and tools and stuff to
  91   deal with these issues. That is what was tiresome. I don't want to
  92   work around bugs or nonsensical behavior anymore.
  93
  94   So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
  95   work.