+ _ _
+ | | __ _ _ __(_)______ _
+ | |/ _` | '__| |_ / _` |
+ | | (_| | | | |/ / (_| |
+ |_|\__,_|_| |_/___\__,_|
+ https://uninformativ.de/git/lariza
+ https://uninformativ.de/bugs.html
- ==========
- lariza
- ==========
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-A simple web browser using GTK+ 2, GLib and WebKitGTK+.
-Features:
-
- - A WebKit viewport
- - An input box to change the current URL
- - Global content zoom
- - Pluggability into suckless' tabbed
- - Built-in downloads
- - Optimized hotkeys: Left hand on keyboard, right hand on mouse
- - Searching the current page for a word
- - Adblock
- - Support for Flash and Java
- - Cooperative instances using FIFOs (can be turned off)
-
-Planned features:
-
- - Keyword based searching (opening "wi foo" will search wikipedia)
-
-
-About the name
-==============
+A simple web browser using GTK+ 3, GLib and WebKit2GTK+.
-"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.
-
-
-What lariza is and what it's not
-================================
+Features:
-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.
+ - 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
-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 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.
+Installation
+------------
-lariza tries not to exceed 1000 lines of code.
+The following C libraries are required:
+ - GTK+ 3
+ - WebKit2 API for GTK+ 3
-Using lariza with tabbed
-========================
+lariza expects to be run on a POSIX-ish operating system.
-The order of arguments for lariza doesn't matter. This means you can run
-it like this:
+To build the program and install it to /usr/local:
- $ tabbed -c lariza file:///home/hans/bookmarks.html -z 0.8 -e
+ $ make
+ # make install
-Each new tab will then show your bookmarks and is scaled by a factor of
-0.8.
+To use bundled web extensions, they must be copied or symlinked to the
+appropriate path. Please refer to the manpage.
-If "-e" is not specified, lariza will launch tabbed automatically. Note
-that you can't use tabbed's "Ctrl+Shift+Enter" hotkey to open a new tab
-this way (lariza will simply call "tabbed -c -d", so tabbed will know
-nothing about lariza). However, due to lariza's cooperative instances,
-you can simply start lariza a second time and it will create a new tab.
+Running
+-------
-Adblock
-=======
+You simply invoke the main program:
-lariza has built-in adblock functionality. In each line of
+ $ lariza
- ~/.config/lariza/adblock.black
+Refer to the manpage for all options.
-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?://...".
+Background information
+----------------------
-WebKit local storage
-====================
+ What lariza is and what it's not
-WebKit does create files in your $XDG_* directories, i.e. ~/.local/share
-or ~/.cache. It's up to you what you want to do with this junk. I remove
-it regularly if no WebKit browser is running. Another option would be to
-change the $XDG_* variables.
+ 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. :-)
-I have explicitly not turned off the local storage feature in WebKit
-because I don't know if this breaks web applications.
+ 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.
-Literature
-==========
+ About the name
-API references:
+ "lariza" stems from a german sentence:
- - http://webkitgtk.org/reference/webkitgtk/stable/index.html
- - https://developer.gnome.org/gtk2/stable/index.html
- - https://developer.gnome.org/glib/stable/index.html
+ Alle anderen waren mir zu anstrengend.
+ l a r i z a
-Regular expressions supported by GRegex, you can use these in your
-adblock patterns:
+ 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.
- - https://developer.gnome.org/glib/stable/glib-regex-syntax.html
+ So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
+ work.
projects / chorizo.git / blobdiff