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     - Indicator for web feeds
  22     - Optimized hotkeys: Left hand on keyboard, right hand on mouse
  23     - Keyword based searching: Opening "wi foo" will search wikipedia
  24     - Global content zoom
  25     - Cooperative instances using FIFOs
  26     - Certificate trust store
  27     - Bundled user-supplied JavaScripts (optional):
  28         - Link hints
  29     - Bundled web extensions (optional):
  30         - Adblock
  31
  32
  33 Installation
  34 ------------
  35
  36 The following C libraries are required:
  37
  38     - GTK+ 3
  39     - WebKit2 API for GTK+ 3
  40
  41 lariza expects to be run on a POSIX-ish operating system.
  42
  43 To build the program and install it to /usr/local:
  44
  45     $ make
  46     # make install
  47
  48 To use bundled web extensions, they must be copied or symlinked to the
  49 appropriate path. Please refer to the manpage.
  50
  51
  52 Running
  53 -------
  54
  55 You simply invoke the main program:
  56
  57     $ lariza
  58
  59 Refer to the manpage for all options.
  60
  61
  62 Background information
  63 ----------------------
  64
  65  What lariza is and what it's not
  66
  67   lariza does what I need. It won't do other things. I'm open for pull
  68   requests but please don't be upset if I turn them down -- which might
  69   happen if it's a feature that I simply don't need. That being said,
  70   you should have a look at the PATCHES file. :-)
  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
  78  About the name
  79
  80   "lariza" stems from a german sentence:
  81
  82       Alle anderen waren mir zu anstrengend.
  83        l   a         r    i  z  a
  84
  85   That phrase basically means: "It was too tiresome to deal with any
  86   other browser." I couldn't find a simple browser that does just what I
  87   need. Most of them are utterly bloated, others lack essential
  88   functions. Thus, I was forced to write scripts and tools and stuff to
  89   deal with these issues. That is what was tiresome. I don't want to
  90   work around bugs or nonsensical behavior anymore.
  91
  92   So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
  93   work.