-zea - zeig's einfach an
-=======================
+ _ _
+ | | __ _ _ __(_)______ _
+ | |/ _` | '__| |_ / _` |
+ | | (_| | | | |/ / (_| |
+ |_|\__,_|_| |_/___\__,_|
+ https://sr.ht/~armaan/lariza
-zea is a minimalistic web browser using Gtk2, GLib and WebKit. "Zeig's
-einfach an" is german and translates roughly to "just show it" (the damn
-web page).
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+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
+ - Full keyboard control
+ - Global content zoom
+ - Cooperative instances using FIFOs
+ - Certificate trust store
+ - User script support
+ - Extension support
+
+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.
- - A WebKit viewport
- - An input box to change the current URL
- - Global content zoom
- - Pluggability into suckless' tabbed
- - vi-like scrolling (modified by CTRL)
- - Searching the current page for a word
- - Adblock
- - Support for Flash and Java
- - Cooperative instances using FIFOs (can be turned off)
+To build the program and install it to /usr/local:
-Planned features:
+ $ make
+ # make install
- - Keyword based searching (opening "wi foo" will search wikipedia)
+To use bundled web extensions, they must be copied or symlinked to the
+appropriate path. Please refer to the manpage.
-Using zea with tabbed
-=====================
+Running
+-------
-The order of arguments for zea doesn't matter. This means you can run it
-like this:
+You simply invoke the main program:
- $ tabbed -c ./zea file:///home/hans/bookmarks.html -z 0.8 -e
+ $ lariza
-Each new tab will then show your bookmarks and is scaled by a factor of
-0.8.
+Refer to the manpage for all options.
-If "-e" is not specified, zea will launch tabbed automatically. Note
-that you can't use tabbed's "Ctrl+Shift+Enter" hotkey to open a new tab
-this way (zea will simply call "tabbed -c -d", so tabbed will know
-nothing about zea). However, due to zea's cooperative instances, you can
-simply start zea a second time and it will create a new tab.
+Background information
+----------------------
-Adblock
-=======
+ What lariza is and what it's not
-zea has built-in adblock functionality. In each line of
+ lariza does what I need. It won't do other things. I'm open for
+ contributions 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.
- ~/.config/zea/adblock.black
+ lariza does not compete with powerful browsers like dwb or luakit, nor
+ with monstrous applications like Firefox or Chromium.
-you can store a regular expression. These expressions match
-case-insensitive and partially, i.e. ".*foo.*" is the same as ".*FOO.*"
-and you can use anchors like "^https?://...".
+ About the name
+ "lariza" stems from a german sentence:
-Literature
-==========
+ Alle anderen waren mir zu anstrengend.
+ l a r i z a
-API references:
+ 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.
- - http://webkitgtk.org/reference/webkitgtk/stable/index.html
- - https://developer.gnome.org/gtk2/stable/index.html
- - https://developer.gnome.org/glib/stable/index.html
+ So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
+ work.
-Regular expressions supported by GRegex, you can use these in your
-adblock patterns:
+Copyright
+---------
+MIT License, see the LICENSE file for more information.
- - https://developer.gnome.org/glib/stable/glib-regex-syntax.html
+This codebase is a fork of the original lariza browser by Peter Hofmann.
\ No newline at end of file