X-Git-Url: https://git.armaanb.net/?p=chorizo.git;a=blobdiff_plain;f=README;h=373d692a0d7d09a965c3f75a23f2b5303f044a87;hp=f92c08552fecf1cbfd50081c2540d9cdce82c5b7;hb=HEAD;hpb=3bf5e9826fe54ef64bbecd9cdb407fab40207835 diff --git a/README b/README index f92c085..373d692 100644 --- a/README +++ b/README @@ -1,123 +1,108 @@ + _ _ + ___| |__ ___ _ __(_)_______ + / __| '_ \ / _ \| '__| |_ / _ \ + | (__| | | | (_) | | | |/ / (_) | + \___|_| |_|\___/|_| |_/___\___/ + https://sr.ht/~armaan/chorizo - ========== - lariza - ========== +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -A simple web browser using GTK+ 2, GLib and WebKitGTK+. +A simple web browser using GTK+ 3, GLib and WebKit2GTK+. Features: + - A WebKit2 viewport + - An input box to change the URI, search the current page, or + search the web + - Tab management + - Full keyboard control + - An ini configuration file + - Built-in download manager + - Web feeds indicator + - Global content zoom + - Cooperative instances using FIFOs + - Certificate trust store + - User script support + - Extensions - - A WebKit viewport - - An input box to change the current URL - - Global content zoom - - Pluggability into suckless' tabbed - - Built-in downloads - - 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) - -Planned features: - - - Keyword based searching (opening "wi foo" will search wikipedia) - - -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. - - -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 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. +Refer to the manpages chorizo(1), chorizo-usage(1), and +chorizo-config(5), for more information. -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 + - gst-libav, gst-plugins-good - for media playback -Using lariza with tabbed -======================== +To generate the manpages, scdoc is required. This isn't necesary on +release tarballs. -The order of arguments for lariza doesn't matter. This means you can run -it like this: +chorizo expects to be run on a POSIX-ish operating system. - $ tabbed -c lariza file:///home/hans/bookmarks.html -z 0.8 -e +To build and install the program: -Each new tab will then show your bookmarks and is scaled by a factor of -0.8. + $ make + # make install -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. +Background information +---------------------- -Adblock -======= +What chorizo is and what it's not -lariza has built-in adblock functionality. In each line of + chorizo 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/lariza/adblock.black + chorizo does not compete with powerful browsers like dwb or luakit, nor + with monstrous applications like Firefox or Chromium. Because under + the hood chorizo is powered by WebKit, however, it is on par with + browsers like Safari for page rendering features. -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?://...". +How is chorizo related to lariza? + chorizo is a fork of the lariza browser by Peter Hofmann. I wanted + to take it in a slightly different direction (mostly just adding + features not considered to be in the spirit of lariza), so I forked + it. The name was changed in order to reduce confusion between the + two browsers as they grew apart. The versioning scheme was also + moved away from being calendar-based. -WebKit local storage -==================== + Features that this fork has that lariza is missing: + - Configuration file + - Revamped download manager + - New, ergonomic keybindings inspire by both Emacs and Vim + - Better default directories + - Easily togglable images and JavaScript + - Cleaned up source code + - Easy web searching + - User stylesheet support + - A variety of tweaks and adjustments that make the experience nicer -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. +Migrating from another browser +------------------------------ -I have explicitly not turned off the local storage feature in WebKit -because I don't know if this breaks web applications. +From lariza: + 1. Copy the relevant paths from ~/.config/lariza to + ~/.local/share/chorizo. Read chorizo(1) for full details on the + correct paths. + 2. Your symlinks from /usr will broken, so you should relink everything. -Literature -========== + 3. Read lariza-config(5), as the keybindings are radically different + out of the box. Everything is configurable, however, and you can + reconfigure the bindings to act just like your previous browser. -API references: +From Firefox/Chromium/Brave/etc: + 1. Set your expectations right. Read the background information + section of the README. - - http://webkitgtk.org/reference/webkitgtk/stable/index.html - - https://developer.gnome.org/gtk2/stable/index.html - - https://developer.gnome.org/glib/stable/index.html + 2. Copy the cookie database into ~/.local/share/lariza/cookies.db. -Regular expressions supported by GRegex, you can use these in your -adblock patterns: + 3. Read all the manpages. - - https://developer.gnome.org/glib/stable/glib-regex-syntax.html +Copyright +--------- +MIT License, see the LICENSE file for more information.