]> git.armaanb.net Git - chorizo.git/blob - man1/lariza-usage.1
Add darkreader userscript
[chorizo.git] / man1 / lariza-usage.1
1 .TH lariza 1 "2021-01-03" "lariza" "User Commands"
2 .\" --------------------------------------------------------------------
3 .SH NAME
4 lariza-usage \- extended usage hints
5 .\" --------------------------------------------------------------------
6 .SH DESCRIPTION
7 \fBlariza\fP is a simple web browser using GTK+ 3, GLib and WebKit2GTK+.
8 This manpage contains additional hints and pointers regarding its usage.
9 .\" --------------------------------------------------------------------
10 .SH "HOTKEYS"
11 .SS "Global hotkeys"
12 These hotkeys work when either the location bar or the web view is being
13 focused.
14 .TP
15 \fBControl\fP + \fBq\fP
16 Close the current tab. Quits the entire program if this was the last
17 tab and if there are no more active downloads (download manager is
18 shown otherwise).
19 .TP
20 \fBControl\fP + \fBw\fP
21 Open a new tab.
22 .TP
23 \fBControl\fP + \fBe\fP
24 Reload the current page.
25 .TP
26 \fBControl\fP + \fBy\fP
27 Open the download manager.
28 .TP
29 \fBControl\fP + \fBd\fP
30 Initiate a web search.
31 .TP
32 \fBControl\fP + \fBt\fP
33 Focus the location bar.
34 .TP
35 \fBControl\fP + \fBs\fP / \fBControl\fP + \fBr\fP
36 Search forwards/backwards.
37 .TP
38 \fBControl\fP + \fBu\fP / \fBControl\fP + \fBi\fP
39 Select tab to the left / right.
40 .TP
41 \fBControl\fP + \fBh\fP / \fBControl\fP + \fBl\fP
42 Go backward and forward in current browser history.
43 .TP
44 \fBControl\fP + \fB=\fP / \fBControl\fP + \fB-\fP
45 Zoom in / out.
46 .TP
47 \fBControl\fP + \fB0\fP
48 Reset zoom.
49 .P
50 .SS "Main window \(em WebKit viewport focused"
51 .TP
52 \fBEscape\fP
53 Stop loading.
54 .TP
55 \fBMiddle mouse\fP
56 Open the link under the pointer in a new window.
57 .TP
58 \fBBackward\fP / \fBforward\fP (mouse keys 8 and 9)
59 Same as \fBF2\fP and \fBF3\fP.
60 .TP
61 \fBControl\fP + \fBScroll up\fP
62 .TQ
63 \fBCtrl\fP + \fBScroll up\fP
64 Increase zoom level of the current page.
65 .TP
66 \fBControl\fP + \fBScroll down\fP
67 .TQ
68 \fBCtrl\fP + \fBScroll down\fP
69 Decrase zoom level of the current page.
70 .TP
71 \fBControl\fP + \fBScroll horizontally\fP
72 .TQ
73 \fBCtrl\fP + \fBScroll horizontally\fP
74 Reset zoom to $\fBLARIZA_ZOOM\fP.
75 .P
76 .SS "Main window \(em location bar focused"
77 .TP
78 \fBEscape\fP
79 Reset the content of the location bar to the current URI.
80 .TP
81 \fBReturn\fP
82 Commit, i.e. begin searching or open the URI.
83 .P
84 .SS "Download manager"
85 .TP
86 \fBControl\fP + \fBy\fP
87 .TQ
88 \fBControl\fP + \fBq\fP
89 Close the download manager. Active downloads are never aborted. However,
90 if there are no more active downloads and no more browsing windows, then
91 the entire program will quit.
92 .\" --------------------------------------------------------------------
93 .SH "DOWNLOAD MANAGER"
94 Open the download manager using the appropriate hotkey. A new window
95 listing your downloads will appear. Clicking on an item will remove it
96 from the list and \(em if needed \(em cancel the download.
97 .P
98 There's no file manager integration, nor does \fBlariza\fP delete,
99 overwrite or resume downloads. If a file already exists, it won't be
100 touched. Instead, the new file name will have a suffix such as \fB.1\fP,
101 \fB.2\fP, \fB.3\fP, and so on.
102 .\" --------------------------------------------------------------------
103 .SH "USER-SUPPLIED JAVASCRIPT FILES"
104 After a page has been successfully loaded, the directory
105 \fI~/.config\:/lariza\:/user-scripts\fP will be scanned and each file in
106 it ending with \fB.js\fP will be run as a JavaScript file in the
107 context of said page.
108 .P
109 During development, you will most likely want to run \fBlariza\fP with
110 $\fBLARIZA_ENABLE_CONSOLE_TO_STDOUT\fP enabled.
111 .P
112 \fBlariza\fP comes with the following scripts:
113 .TP
114 \fBhints.js\fP
115 Press \fBf\fP (open link in current window) or \fBF\fP (open in new
116 window) to activate link hints. After typing the characters for one of
117 them, press \fBEnter\fP to confirm. Press \fBEscape\fP to abort.
118 .TP
119 \fBprivacy-redirect.js\fP
120 Redirects YouTube, Reddit, etc to privacy respecting alternatives.
121 .TP
122 \fBdarkreader.js\fP
123 See https://darkreader.org.
124 .P
125 Those bundled scripts are automatically installed on \fBmake install\fP.
126 To use them, though, make sure to link them to the directory mentioned
127 above.
128 .\" --------------------------------------------------------------------
129 .SH "WEB EXTENSIONS"
130 On startup, WebKit checks \fI~/.config/lariza/web_extensions\fP for any
131 \fB.so\fP files. See
132 .UR http://\:blogs.igalia.com/\:carlosgc/\:2013/\:09/\:10/\:webkit2gtk-\:web-\:process-\:extensions/
133 this blog post
134 .UE
135 for further information on these extensions.
136 .P
137 \fBlariza\fP comes with the following extensions:
138 .TP
139 \fBwe_adblock.so\fP
140 Generic adblock. Reads patterns from the file
141 \fI~/.config/lariza/adblock\fP. Each line can contain a regular
142 expression. These expressions match case-insensitive and partially, i.e.
143 \fB.*foo.*\fP is the same as \fB.*FOO.*\fP and you can use anchors like
144 \fB^https?://...\fP. Please refer to
145 .UR https://\:developer.\:gnome.\:org/\:glib/\:stable/\:glib-\:regex-\:syntax.html
146 the GLib reference
147 .UE
148 for more details. Lines starting with \fB#\fP are ignored.
149 .P
150 Those bundled web extensions are automatically compiled when you run
151 \fBmake\fP and installed on \fBmake install\fP. To use them, though,
152 make sure to link them to the directory mentioned above.
153 .\" --------------------------------------------------------------------
154 .SH "TRUSTED CERTIFICATES"
155 By default, \fBlariza\fP trusts whatever CAs are trusted by WebKit. If
156 you wish to trust additional certificates, such as self-signed
157 certificates, the first thing you should do is try to add the
158 appropriate CAs to your system-wide store.
159 .P
160 If you wish to add simple exceptions, you can grab the certificate and
161 store it in the directory \fI~/.config/lariza/certs\fP. The filename
162 must be equal to the hostname:
163 .P
164 \f(CW
165 .nf
166 \&$ echo | openssl s_client -connect foo.de:443 | openssl x509 >foo.de
167 .fi
168 \fP
169 .P
170 This tells \fBlariza\fP to trust the given certificate when connecting
171 to host \fBfoo.de\fP.
172 .P
173 You can reload these certificates at runtime by pressing the appropriate
174 hotkey. Note that removed certificates will be kept in memory until you
175 restart \fBlariza\fP.
176 .P
177 Note: This is NOT equal to certificate pinning. WebKit ignores
178 user-specified certificates if the server's certificate can be validated
179 by any system-wide CA.
180 .\" --------------------------------------------------------------------
181 .SH "SEE ALSO"
182 .BR lariza (1).