Add hotkeys for switching tabs

[chorizo.git] / man1 / lariza.usage.1

diff --git a/man1/lariza.usage.1 b/man1/lariza.usage.1
index 7c720269dffdc0236a25b6d750455af3fba613ce..ebed6766d43e936913df2f42574af73765f38dd7 100644 (file)
--- a/man1/lariza.usage.1
+++ b/man1/lariza.usage.1
@@ -1,4 +1,4 @@
-.TH lariza 1 "2015-11-28" "lariza" "User Commands"
+.TH lariza 1 "2020-04-24" "lariza" "User Commands"

 .\" --------------------------------------------------------------------
 .SH NAME
 lariza.usage \- extended usage hints
 .\" --------------------------------------------------------------------
 .SH NAME
 lariza.usage \- extended usage hints


@@ -7,41 +7,6 @@ lariza.usage \- extended usage hints
 \fBlariza\fP is a simple web browser using GTK+ 3, GLib and WebKit2GTK+.
 This manpage contains additional hints and pointers regarding its usage.
 .\" --------------------------------------------------------------------
 \fBlariza\fP is a simple web browser using GTK+ 3, GLib and WebKit2GTK+.
 This manpage contains additional hints and pointers regarding its usage.
 .\" --------------------------------------------------------------------

-.SH "BUNDLED WEB EXTENSIONS"
-On startup, WebKit checks \fI~/.local/share/lariza/web_extensions\fP for
-any \fB.so\fP files. See
-.UR http://\:blogs.igalia.com/\:carlosgc/\:2013/\:09/\:10/\:webkit2gtk-\:web-\:process-\:extensions/
-this blog post
-.UE
-for further information on these extensions.
-.P
-\fBlariza\fP comes with the following extensions:
-.TP
-\fBwe_adblock.so\fP
-Generic adblock. Reads patterns from the file
-\fI~/.config/lariza/adblock.black\fP. Each line can contain a regular
-expression. These expressions match case-insensitive and partially, i.e.
-\fB.*foo.*\fP is the same as \fB.*FOO.*\fP and you can use anchors like
-\fB^https?://...\fP. Please refer to
-.UR https://\:developer.\:gnome.\:org/\:glib/\:stable/\:glib-\:regex-\:syntax.html
-the GLib reference
-.UE
-for more details. Lines starting with \fB#\fP are ignored.
-.P
-Those bundled web extensions are automatically compiled when you run
-\fBmake\fP. To use them, though, make sure to copy them to the directory
-mentioned above.
-.\" --------------------------------------------------------------------
-.SH "DOWNLOAD MANAGER"
-Open the download manager using the appropriate hotkey. A new window
-listing your downloads will appear. Clicking on an item will remove it
-from the list and \(em if needed \(em cancel the download.
-.P
-There's no file manager integration, nor does \fBlariza\fP delete,
-overwrite or resume downloads. If a file already exists, it won't be
-touched. Instead, the new file name will have a suffix such as \fB.1\fP,
-\fB.2\fP, \fB.3\fP, and so on.
-.\" --------------------------------------------------------------------

 .SH "HOTKEYS"
 .SS "Global hotkeys"
 These hotkeys work when either the location bar or the web view is being
 .SH "HOTKEYS"
 .SS "Global hotkeys"
 These hotkeys work when either the location bar or the web view is being


@@ -51,7 +16,9 @@ focused.
 Launch the external handler for the currently loaded URI.
 .TP
 \fBMod1\fP + \fBq\fP
 Launch the external handler for the currently loaded URI.
 .TP
 \fBMod1\fP + \fBq\fP

-Close the current window.
+Close the current window. Quits the entire program if this was the last
+window and if there are no more active downloads (download manager is
+shown otherwise).

 .TP
 \fBMod1\fP + \fBw\fP
 Go to your \(lqhomepage\(rq. See the environment variable
 .TP
 \fBMod1\fP + \fBw\fP
 Go to your \(lqhomepage\(rq. See the environment variable


@@ -84,6 +51,9 @@ Repeat the last search (backward).
 \fBMod1\fP + \fBc\fP
 Reload trusted certificates.
 .TP
 \fBMod1\fP + \fBc\fP
 Reload trusted certificates.
 .TP

+\fBMod1\fP + \fBa\fP / \fBMod1\fP + \fBs\fP
+Select tab to the left / right.
+.TP

 \fBF2\fP / \fBF3\fP
 Go backward and forward in current browser history.
 .P
 \fBF2\fP / \fBF3\fP
 Go backward and forward in current browser history.
 .P


@@ -124,7 +94,21 @@ Commit, i.e. begin searching, do a keyword based search or open the URI.
 .SS "Download manager"
 .TP
 \fBMod1\fP + \fBd\fP
 .SS "Download manager"
 .TP
 \fBMod1\fP + \fBd\fP

-Close the download manager (downloads are not aborted).
+.TQ
+\fBMod1\fP + \fBq\fP
+Close the download manager. Active downloads are never aborted. However,
+if there are no more active downloads and no more browsing windows, then
+the entire program will quit.
+.\" --------------------------------------------------------------------
+.SH "DOWNLOAD MANAGER"
+Open the download manager using the appropriate hotkey. A new window
+listing your downloads will appear. Clicking on an item will remove it
+from the list and \(em if needed \(em cancel the download.
+.P
+There's no file manager integration, nor does \fBlariza\fP delete,
+overwrite or resume downloads. If a file already exists, it won't be
+touched. Instead, the new file name will have a suffix such as \fB.1\fP,
+\fB.2\fP, \fB.3\fP, and so on.

 .\" --------------------------------------------------------------------
 .SH "KEYWORD BASED SEARCHING"
 In this file, you can configure keywords and the associated URIs:
 .\" --------------------------------------------------------------------
 .SH "KEYWORD BASED SEARCHING"
 In this file, you can configure keywords and the associated URIs:


@@ -143,39 +127,57 @@ is where your search term will be placed.
 .P
 Lines starting with \fB#\fP are ignored.
 .\" --------------------------------------------------------------------
 .P
 Lines starting with \fB#\fP are ignored.
 .\" --------------------------------------------------------------------

-.SH "TRUSTED CERTIFICATES"
-By default, \fBlariza\fP trusts whatever CAs are trusted by WebKit, i.e. by
-your GnuTLS installation. If you wish to trust additional certificates,
-such as self-signed certificates, the first thing you should do is try
-to add the appropriate CAs to your system-wide store.
+.SH "USER-SUPPLIED JAVASCRIPT FILES"
+After a page has been successfully loaded, the directory
+\fI~/.config\:/lariza\:/user-scripts\fP will be scanned and each file in
+it ending with \fB.js\fP will be run as a JavaScript file in the context
+of said page.

 .P
 .P

-If you wish to add simple exceptions, you can grab the certificate and
-store it in the directory \fI~/.config/lariza/certs\fP. The filename
-must be equal to the hostname:
+During development, you will most likely want to run \fBlariza\fP with
+$\fBLARIZA_ENABLE_CONSOLE_TO_STDOUT\fP enabled.

 .P
 .P

-.\f(CW
-.nf
-\&$ echo | openssl s_client -connect foo.de:443 | openssl x509 >foo.de
-.fi
-\fP
+\fBlariza\fP comes with the following scripts:
+.TP
+\fBhints.js\fP
+Press \fBf\fP (open link in current window) or \fBF\fP (open in new
+window) to activate link hints. After typing the characters for one of
+them, press \fBEnter\fP to confirm. Press \fBEscape\fP to abort.

 .P
 .P

-This tells \fBlariza\fP to trust the given certificate when connecting
-to host \fBfoo.de\fP.
+Those bundled scripts are automatically installed on \fBmake install\fP.
+To use them, though, make sure to link them to the directory mentioned
+above.
+.\" --------------------------------------------------------------------
+.SH "WEB EXTENSIONS"
+On startup, WebKit checks \fI~/.config/lariza/web_extensions\fP for any
+\fB.so\fP files. See
+.UR http://\:blogs.igalia.com/\:carlosgc/\:2013/\:09/\:10/\:webkit2gtk-\:web-\:process-\:extensions/
+this blog post
+.UE
+for further information on these extensions.

 .P
 .P

-You can reload these certificates at runtime by pressing the appropriate
-hotkey. Note that removed certificates will be kept in memory until you
-restart \fBlariza\fP.
+\fBlariza\fP comes with the following extensions:
+.TP
+\fBwe_adblock.so\fP
+Generic adblock. Reads patterns from the file
+\fI~/.config/lariza/adblock.black\fP. Each line can contain a regular
+expression. These expressions match case-insensitive and partially, i.e.
+\fB.*foo.*\fP is the same as \fB.*FOO.*\fP and you can use anchors like
+\fB^https?://...\fP. Please refer to
+.UR https://\:developer.\:gnome.\:org/\:glib/\:stable/\:glib-\:regex-\:syntax.html
+the GLib reference
+.UE
+for more details. Lines starting with \fB#\fP are ignored.

 .P
 .P

-Note: This is NOT equal to certificate pinning. WebKit ignores
-user-specified certificates if the server's certificate can be validated
-by any system-wide CA.
+Those bundled web extensions are automatically compiled when you run
+\fBmake\fP and installed on \fBmake install\fP. To use them, though,
+make sure to link them to the directory mentioned above.

 .\" --------------------------------------------------------------------
 .SH "EXTERNAL URI HANDLER"
 \fBlariza\fP can launch an executable called
 \fIlariza-external-handler\fP. It will be passed the \(lqselected\(rq
 URI as a command line argument:
 .P
 .\" --------------------------------------------------------------------
 .SH "EXTERNAL URI HANDLER"
 \fBlariza\fP can launch an executable called
 \fIlariza-external-handler\fP. It will be passed the \(lqselected\(rq
 URI as a command line argument:
 .P

-.\f(CW
+\f(CW

 .nf
 $ lariza-external-handler -u https://github.com
 .fi
 .nf
 $ lariza-external-handler -u https://github.com
 .fi


@@ -197,21 +199,32 @@ want to implement a bookmarking script or a password manager or you
 might simply load the current URI in a different browser. That's up to
 you.
 .\" --------------------------------------------------------------------
 might simply load the current URI in a different browser. That's up to
 you.
 .\" --------------------------------------------------------------------

-.SH "USING LARIZA WITH TABBED"
-By default, \fBlariza\fP automatically launches an instance of suckless'
-\fBtabbed\fP(1).
-.P
-You can turn this feature off (see command line arguments) or you can
-specify a command line argument to embed \fBlariza\fP into an arbitrary
-container (XEMBED). Note that \fBlariza\fP will also automatically embed
-new windows in the same container.
-.P
-When using the automatically launched \fBtabbed\fP(1) instance, you
-can't use \fBtabbed\fP(1)'s \fBCtrl + Shift + Return\fP hotkey. This is
-because \fBtabbed\fP(1) is launched with \fB\-d\fP, so it knows nothing
-about \fBlariza\fP. However, \fBlariza\fP provides its own hotkey to
-launch a new window which will be embedded in the same instance of
-\fBtabbed\fP(1).
+.SH "TRUSTED CERTIFICATES"
+By default, \fBlariza\fP trusts whatever CAs are trusted by WebKit, i.e.
+by your GnuTLS installation. If you wish to trust additional
+certificates, such as self-signed certificates, the first thing you
+should do is try to add the appropriate CAs to your system-wide store.
+.P
+If you wish to add simple exceptions, you can grab the certificate and
+store it in the directory \fI~/.config/lariza/certs\fP. The filename
+must be equal to the hostname:
+.P
+\f(CW
+.nf
+\&$ echo | openssl s_client -connect foo.de:443 | openssl x509 >foo.de
+.fi
+\fP
+.P
+This tells \fBlariza\fP to trust the given certificate when connecting
+to host \fBfoo.de\fP.
+.P
+You can reload these certificates at runtime by pressing the appropriate
+hotkey. Note that removed certificates will be kept in memory until you
+restart \fBlariza\fP.
+.P
+Note: This is NOT equal to certificate pinning. WebKit ignores
+user-specified certificates if the server's certificate can be validated
+by any system-wide CA.

 .\" --------------------------------------------------------------------
 .SH "WEBKIT LOCAL STORAGE"
 WebKit does create files in your $\fBXDG_*\fP directories, i.e.
 .\" --------------------------------------------------------------------
 .SH "WEBKIT LOCAL STORAGE"
 WebKit does create files in your $\fBXDG_*\fP directories, i.e.