README

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