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