README: Flash crashes gone since WebKit2 2.6.3

[chorizo.git] / README

diff --git a/README b/README
index 994c03f7e145a13cbd1b0fa2383577d9738588ca..218e07fd1be363700aca58e6518b52d1f1556648 100644 (file)
--- a/README
+++ b/README
@@ -4,23 +4,49 @@
                                ==========
 
 
-A simple web browser using GTK+ 2, GLib and WebKitGTK+.
+A simple web browser using GTK+ 3, GLib and WebKit2GTK+.
 
 Features:
 
-    - A WebKit viewport
+    - A WebKit2 viewport
     - An input box to change the URI or to search the current page
     - Built-in launching of suckless' tabbed
-    - Built-in adblock
     - 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
-    - View source mode
     - Cooperative instances using FIFOs
     - Support for Flash and Java
 
 
+==============================================
+IMPORTANT: Current state of the WebKit2 branch
+==============================================
+
+WebKit1 is essentially dead. Sooner or later, we have to jump to
+WebKit2. See also:
+
+http://blogs.igalia.com/carlosgc/2014/08/01/webkitgtk-2-5-1-good-bye-webkit1/
+
+There's a number of issues on this branch:
+
+    - No adblock support. As stated in commit f1174ff, this has to be
+      implemented as a "WebKit2 web extension". Maybe do this in a
+      project of its own?
+    - "View source" mode is not yet ported. This feature has been
+      removed from WebKit2, so we have to invent some way to re-create
+      this...
+    - There's an annoying border around the WebView widget.
+    - There may be a hell lot of other issues that I have not yet
+      encountered.
+
+However, important issues of the original WebKit1 lariza have been
+fixed:
+
+    - Those pages that crash all WebKit1 browsers do work now.
+    - The "back" button works reliably.
+
+
 ==============
 About the name
 ==============
@@ -64,6 +90,12 @@ persistent storage, nor a plugin system, nor cloud sync, nor bookmarks.
 
 lariza tries not to exceed 1000 lines of code.
 
+That being said, this kind of minimalism is not for everyone. If you're
+looking for more features (and a more open feature policy), then you
+might want to check out okraits' fork:
+
+    https://github.com/okraits/lariza/
+
 
 ========================
 Using lariza with tabbed
@@ -102,11 +134,6 @@ Main windows
         Mod1 + e
             Open a new window.
 
-        Mod1 + s
-            Toggles "view source mode". This will display the web pages
-            source code. Note that the page will be reloaded (which is
-            annoying but WebKit enforces this).
-
         Mod1 + r
             Reload the current page.
 
@@ -135,12 +162,15 @@ Main windows
         Backward / forward (mouse keys 8 and 9)
             Does the obvious.
 
-        Mod1 + Wheel up  or  Ctrl + Wheel up
+        Mod1 + Scroll up  or  Ctrl + Scroll up
             Increase zoom level of the current page.
 
-        Mod1 + Wheel down  or  Ctrl + Wheel down
+        Mod1 + Scroll down  or  Ctrl + Scroll down
             Decrase zoom level of the current page.
 
+        Mod1 + Scroll horizontally  or  Ctrl + Scroll horizontally
+            Reset zoom to $LARIZA_ZOOM.
+
 
     When the location bar is focused:
 
@@ -178,7 +208,7 @@ Usage:
 
     lariza [OPTION]... [URI]...
 
-In addition to the standard arguments of GTK+ 2, lariza knows about the
+In addition to the standard arguments of GTK+ 3, lariza knows about the
 following options:
 
     -e <wid>
@@ -186,9 +216,6 @@ following options:
         window specified by <wid>. The download manager is always a
         "popup".
 
-    -r
-        Print all navigation requests on STDERR.
-
     -C
         Disables cooperative instances.
 
@@ -203,7 +230,7 @@ given, $LARIZA_HOME_URI will be opened.
 Environment variables
 =====================
 
-In addition to the standard variables of GTK+ 2, lariza knows about the
+In addition to the standard variables of GTK+ 3, lariza knows about the
 following environment variables:
 
     LARIZA_ACCEPTED_LANGUAGE
@@ -230,25 +257,14 @@ following environment variables:
         ("homepage" or "new window") and if no URIs are specified on the
         command line. Defaults to "about:blank".
 
+    LARIZA_USER_AGENT
+        Lariza will identify itself with this string. Uses WebKit's
+        default value if unset.
+
     LARIZA_ZOOM
         Zoom level for WebKit viewports. Defaults to 1.0.
 
 
-=======
-Adblock
-=======
-
-lariza has built-in adblock functionality. In each line of
-
-    ~/.config/lariza/adblock.black
-
-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?://...".
-
-Lines starting with "#" are ignored.
-
-
 =======================
 Keyword based searching
 =======================
@@ -301,8 +317,8 @@ Dependencies
 
 lariza needs the following Arch Linux packages:
 
-    - gtk2
-    - webkitgtk2
+    - gtk3
+    - webkit2gtk (WebKit2 API for GTK+ 3)
 
 
 ==========
@@ -311,11 +327,6 @@ Literature
 
 API references:
 
-    - http://webkitgtk.org/reference/webkitgtk/stable/index.html
-    - https://developer.gnome.org/gtk2/stable/index.html
+    - http://webkitgtk.org/reference/webkit2gtk/stable/index.html
+    - https://developer.gnome.org/gtk3/stable/index.html
     - https://developer.gnome.org/glib/stable/index.html
-
-Regular expressions supported by GRegex, you can use these in your
-adblock patterns:
-
-    - https://developer.gnome.org/glib/stable/glib-regex-syntax.html