summaryrefslogtreecommitdiff
path: root/README
blob: e8be2a0367cff4f6ae58265fdabced1394c62594 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
                                 ======
                                 lariza
                                 ======


A simple web browser using GTK+ 3, GLib and WebKit2GTK+.

Features:

    - A WebKit2 viewport
    - An input box to change the URI or to search the current page
    - Built-in launching of suckless' tabbed
    - Built-in download manager
    - Optimized hotkeys: Left hand on keyboard, right hand on mouse
    - Keyword based searching: Opening "wi foo" will search wikipedia
    - Global content zoom
    - Cooperative instances using FIFOs
    - Certificate trust store
    - Bundled web extensions:
        - Adblock


Installation
------------

The following C libraries are required:

    - GTK+ 3
    - WebKit2 API for GTK+ 3

lariza expects to be run on a POSIX-ish operating system.

To build the program and install it to /usr/local:

    $ make
    # make install

To use bundled web extensions, they must be copied or symlinked to the
appropriate path. Please refer to the manpage.


Running
-------

You simply invoke the main program:

    $ lariza

Refer to the manpage for all options.


Background information
----------------------

 What lariza is and what it's not

  lariza does what I need. It won't do other things. I'm open for pull
  requests but please don't be upset if I turn them down -- which might
  happen if it's a feature that I simply don't need.

  Especially, it's very likely that lariza will never have a "follow
  mode" like dwb, luakit or others have. I've used these browsers for
  quite some time and I've also used Firefox extensions that add a
  "follow mode". The point is, "follow mode" doesn't work anymore. This
  was a good thing ten years ago. Today, a lot of websites make heavy
  use of JavaScript or hovering. You NEED some kind of pointing device.
  I found using "follow mode" to be very frustrating today, because you
  still have to reach for the mouse all the time. So, you might as well
  just optimize your mousing workflow.

  lariza does not compete with powerful browsers like dwb or luakit, nor
  with monstrous applications like Firefox or Chromium. lariza won't
  have persistent storage, nor a plugin system, nor cloud sync, nor
  bookmarks.

  lariza tries not to exceed 1000 lines of code.


 About the name

  "lariza" stems from a german sentence:

      Alle anderen waren mir zu anstrengend.
       l   a         r    i  z  a

  That phrase basically means: "It was too tiresome to deal with any
  other browser." I couldn't find a simple browser that does just what I
  need. Most of them are utterly bloated, others lack essential
  functions. Thus, I was forced to write scripts and tools and stuff to
  deal with these issues. That is what was tiresome. I don't want to
  work around bugs or nonsensical behavior anymore.

  So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
  work.