summaryrefslogtreecommitdiff
path: root/README
blob: 4391663e7d41944b144bd191a7282f4afd7a71b4 (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
95
96
97
98
99
100
101
102
103
104
This is my personal build of lariza. I have changed some keybindings and added
a couple features to fit my needs:

- Search engine functionality [Ctrl+S]
- File chooser for downloads
- Permission handling dialogues
- Cookie support

The manual pages have been updated to reflect all of these changes.

Original README
---------------

   _            _
  | | __ _ _ __(_)______ _
  | |/ _` | '__| |_  / _` |
  | | (_| | |  | |/ / (_| |
  |_|\__,_|_|  |_/___\__,_|
  https://uninformativ.de/git/lariza
  https://uninformativ.de/bugs.html


- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -


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 download manager
    - Indicator for web feeds
    - Optimized hotkeys: Left hand on keyboard, right hand on mouse
    - Global content zoom
    - Cooperative instances using FIFOs
    - Certificate trust store
    - Bundled user-supplied JavaScripts (optional):
        - Link hints
    - Bundled web extensions (optional):
        - 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. That being said,
  you should have a look at the PATCHES file. :-)

  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.


 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.