]> git.armaanb.net Git - chorizo.git/blobdiff - man1/lariza.usage.1
"adblock.black" has been renamed to "adblock"
[chorizo.git] / man1 / lariza.usage.1
index 9db7a2cb50810fd0f1206c7871e179b63a1f76af..d193eaf7618dc9680ebfaeeae02b385487c71d0b 100644 (file)
@@ -1,4 +1,4 @@
-.TH lariza 1 "2020-03-14" "lariza" "User Commands"
+.TH lariza 1 "2020-05-03" "lariza" "User Commands"
 .\" --------------------------------------------------------------------
 .SH NAME
 lariza.usage \- extended usage hints
@@ -12,9 +12,6 @@ This manpage contains additional hints and pointers regarding its usage.
 These hotkeys work when either the location bar or the web view is being
 focused.
 .TP
-\fBMod1\fP + \fBx\fP
-Launch the external handler for the currently loaded URI.
-.TP
 \fBMod1\fP + \fBq\fP
 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
@@ -51,6 +48,9 @@ Repeat the last search (backward).
 \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
@@ -86,7 +86,7 @@ Reset zoom to $\fBLARIZA_ZOOM\fP.
 Reset the content of the location bar to the current URI.
 .TP
 \fBReturn\fP
-Commit, i.e. begin searching, do a keyword based search or open the URI.
+Commit, i.e. begin searching or open the URI.
 .P
 .SS "Download manager"
 .TP
@@ -107,35 +107,29 @@ 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:
-\fI~/.config\:/lariza\:/keywordsearch\fP. Each line has to look like
-this:
-.P
-\f(CW
-.nf
-\&wi https://en.wikipedia.org/w/index.php?title=Special:Search&search=%s
-.fi
-\fP
-.P
-\fBwi\fP is the keyword, so when opening \fBwi foo\fP, \fBlariza\fP
-will search in Wikipedia. Note the \fB%s\fP at the end of the URI: This
-is where your search term will be placed.
-.P
-Lines starting with \fB#\fP are ignored.
-.\" --------------------------------------------------------------------
 .SH "USER-SUPPLIED JAVASCRIPT FILES"
 After a page has been successfully loaded, the directory
-\fI~/.config\:/lariza\:/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.
+\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
 During development, you will most likely want to run \fBlariza\fP with
 $\fBLARIZA_ENABLE_CONSOLE_TO_STDOUT\fP enabled.
+.P
+\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
+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~/.local/share/lariza/web_extensions\fP for
-any \fB.so\fP files. See
+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
@@ -145,7 +139,7 @@ for further information on these 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
+\fI~/.config/lariza/adblock\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
@@ -155,47 +149,20 @@ the GLib reference
 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 "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
-.nf
-$ lariza-external-handler -u https://github.com
-.fi
-\fP
-.P
-This executable must be a user-supplied program. It can do anything it
-wants to with that URI. \fBlariza\fP ignores the exit code of the
-handler.
-.P
-The \fB\-u\fP will always be set. This allows you to use \fBgetopt\fP(1)
-like parameter parsing in your program.
-.P
-You can either use the appropriate hotkey (see list above) to launch the
-handler with the currently loaded URI, or you can perform a right click
-on any link, image or media file to use that URI.
-.P
-This mechanism allows you to implement a variety of functions. You might
-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.
+\fBmake\fP and installed on \fBmake install\fP. To use them, though,
+make sure to link them to the directory mentioned above.
 .\" --------------------------------------------------------------------
 .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.
+By default, \fBlariza\fP trusts whatever CAs are trusted by WebKit. 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
+\f(CW
 .nf
 \&$ echo | openssl s_client -connect foo.de:443 | openssl x509 >foo.de
 .fi
@@ -212,30 +179,5 @@ 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 "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 "WEBKIT LOCAL STORAGE"
-WebKit does create files in your $\fBXDG_*\fP directories, i.e.
-\fI~/.local/share\fP or \fI~/.cache\fP. It's up to you what you want to
-do with this junk. I remove it regularly when no WebKit browser is
-running. Another option would be to change the $\fBXDG_*\fP variables.
-.P
-I have explicitly not turned off the local storage feature in WebKit
-because I don't know if this breaks web applications.
-.\" --------------------------------------------------------------------
 .SH "SEE ALSO"
 .BR lariza (1).