]> git.armaanb.net Git - chorizo.git/blob - man1/lariza.usage.1
Add manpages, trim README
[chorizo.git] / man1 / lariza.usage.1
1 .TH lariza 1 "2015-11-28" "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 "BUNDLED WEB EXTENSIONS"
11 On startup, WebKit checks \fI~/.local/share/lariza/web_extensions\fP for
12 any \fB.so\fP files. See
13 .UR http://\:blogs.igalia.com/\:carlosgc/\:2013/\:09/\:10/\:webkit2gtk-\:web-\:process-\:extensions/
14 this blog post
15 .UE
16 for further information on these extensions.
17 .P
18 \fBlariza\fP comes with the following extensions:
19 .TP
20 \fBwe_adblock.so\fP
21 Generic adblock. Reads patterns from the file
22 \fI~/.config/lariza/adblock.black\fP. Each line can contain a regular
23 expression. These expressions match case-insensitive and partially, i.e.
24 \fB.*foo.*\fP is the same as \fB.*FOO.*\fP and you can use anchors like
25 \fB^https?://...\fP. Please refer to
26 .UR https://\:developer.\:gnome.\:org/\:glib/\:stable/\:glib-\:regex-\:syntax.html
27 the GLib reference
28 .UE
29 for more details. Lines starting with \fB#\fP are ignored.
30 .P
31 Those bundled web extensions are automatically compiled when you run
32 \fBmake\fP. To use them, though, make sure to copy them to the directory
33 mentioned above.
34 .\" --------------------------------------------------------------------
35 .SH "DOWNLOAD MANAGER"
36 Open the download manager using the appropriate hotkey. A new window
37 listing your downloads will appear. Clicking on an item will remove it
38 from the list and \(em if needed \(em cancel the download.
39 .P
40 There's no file manager integration, nor does \fBlariza\fP delete,
41 overwrite or resume downloads. If a file already exists, it won't be
42 touched. Instead, the new file name will have a suffix such as \fB.1\fP,
43 \fB.2\fP, \fB.3\fP, and so on.
44 .\" --------------------------------------------------------------------
45 .SH "HOTKEYS"
46 .SS "Main window \(em WebKit viewport focused"
47 .TP
48 \fBMod1\fP + \fBq\fP
49 Close the current window.
50 .TP
51 \fBMod1\fP + \fBw\fP
52 Go to your \(lqhomepage\(rq. See the environment variable
53 $\fBLARIZA_HOME_URI\fP.
54 .TP
55 \fBMod1\fP + \fBe\fP
56 Open a new window.
57 .TP
58 \fBMod1\fP + \fBr\fP
59 Reload the current page.
60 .TP
61 \fBMod1\fP + \fBd\fP
62 Open the download manager.
63 .TP
64 \fBMod1\fP + \fBl\fP
65 Focus the location bar.
66 .TP
67 \fBMod1\fP + \fBk\fP
68 Focus the location bar and set its text to \fB/\fP, allowing you to
69 easily initiate a search.
70 .TP
71 \fBMod1\fP + \fB2\fP
72 .TQ
73 \fBMod1\fP + \fBn\fP
74 Repeat the last search (forward).
75 .TP
76 \fBMod1\fP + \fB3\fP
77 Repeat the last search (backward).
78 .TP
79 \fBMod1\fP + \fBc\fP
80 Reload trusted certificates.
81 .TP
82 \fBEscape\fP
83 Stop loading.
84 .TP
85 \fBMiddle mouse\fP
86 Open the link under the pointer in a new window.
87 .TP
88 \fBBackward\fP / \fBforward\fP (mouse keys 8 and 9)
89 Does the obvious.
90 .TP
91 \fBMod1\fP + \fBScroll up\fP
92 .TQ
93 \fBCtrl\fP + \fBScroll up\fP
94 Increase zoom level of the current page.
95 .TP
96 \fBMod1\fP + \fBScroll down\fP
97 .TQ
98 \fBCtrl\fP + \fBScroll down\fP
99 Decrase zoom level of the current page.
100 .TP
101 \fBMod1\fP + \fBScroll horizontally\fP
102 .TQ
103 \fBCtrl\fP + \fBScroll horizontally\fP
104 Reset zoom to $\fBLARIZA_ZOOM\fP.
105 .P
106 .SS "Main window \(em location bar focused"
107 .TP
108 \fBMod1\fP + \fBq\fP
109 Close the current window.
110 .TP
111 \fBMod1\fP + \fBd\fP
112 Open the download manager.
113 .TP
114 \fBMod1\fP + \fBr\fP
115 Reload the current page.
116 .TP
117 \fBMod1\fP + \fBk\fP
118 Reset the content of the location bar to \fB/\fP.
119 .TP
120 \fBMod1\fP + \fBc\fP
121 Reload trusted certificates.
122 .TP
123 \fBEscape\fP
124 Reset the content of the location bar to the current URI.
125 .TP
126 \fBReturn\fP
127 Commit, i.e. begin searching, do a keyword based search or open the URI.
128 .SS "Download manager"
129 .TP
130 \fBMod1\fP + \fBd\fP
131 Close the download manager (downloads are not aborted).
132 .\" --------------------------------------------------------------------
133 .SH "KEYWORD BASED SEARCHING"
134 In this file, you can configure keywords and the associated URIs:
135 \fI~/.config\:/lariza\:/keywordsearch\fP. Each line has to look like
136 this:
137 .P
138 \f(CW
139 .nf
140 \&wi https://en.wikipedia.org/w/index.php?title=Special:Search&search=%s
141 .fi
142 \fP
143 .P
144 \fBwi\fP is the keyword, so when opening \fBwi foo\fP, \fBlariza\fP
145 will search in Wikipedia. Note the \fB%s\fP at the end of the URI: This
146 is where your search term will be placed.
147 .P
148 Lines starting with \fB#\fP are ignored.
149 .\" --------------------------------------------------------------------
150 .SH "TRUSTED CERTIFICATES"
151 By default, \fBlariza\fP trusts whatever CAs are trusted by WebKit, i.e. by
152 your GnuTLS installation. If you wish to trust additional certificates,
153 such as self-signed certificates, the first thing you should do is try
154 to add the appropriate CAs to your system-wide store.
155 .P
156 If you wish to add simple exceptions, you can grab the certificate and
157 store it in the directory \fI~/.config/lariza/certs\fP. The filename
158 must be equal to the hostname:
159 .P
160 .\f(CW
161 .nf
162 \&$ echo | openssl s_client -connect foo.de:443 | openssl x509 >foo.de
163 .fi
164 \fP
165 .P
166 This tells \fBlariza\fP to trust the given certificate when connecting
167 to host \fBfoo.de\fP.
168 .P
169 You can reload these certificates at runtime by pressing the appropriate
170 hotkey. Note that removed certificates will be kept in memory until you
171 restart \fBlariza\fP.
172 .P
173 Note: This is NOT equal to certificate pinning. WebKit ignores
174 user-specified certificates if the server's certificate can be validated
175 by any system-wide CA.
176 .\" --------------------------------------------------------------------
177 .SH "USING LARIZA WITH TABBED"
178 By default, \fBlariza\fP automatically launches an instance of suckless'
179 \fBtabbed\fP(1).
180 .P
181 You can turn this feature off (see command line arguments) or you can
182 specify a command line argument to embed \fBlariza\fP into an arbitrary
183 container (XEMBED). Note that \fBlariza\fP will also automatically embed
184 new windows in the same container.
185 .P
186 When using the automatically launched \fBtabbed\fP(1) instance, you
187 can't use \fBtabbed\fP(1)'s \fBCtrl + Shift + Return\fP hotkey. This is
188 because \fBtabbed\fP(1) is launched with \fB\-d\fP, so it knows nothing
189 about \fBlariza\fP. However, \fBlariza\fP provides its own hotkey to
190 launch a new window which will be embedded in the same instance of
191 \fBtabbed\fP(1).
192 .\" --------------------------------------------------------------------
193 .SH "WEBKIT LOCAL STORAGE"
194 WebKit does create files in your $\fBXDG_*\fP directories, i.e.
195 \fI~/.local/share\fP or \fI~/.cache\fP. It's up to you what you want to
196 do with this junk. I remove it regularly when no WebKit browser is
197 running. Another option would be to change the $\fBXDG_*\fP variables.
198 .P
199 I have explicitly not turned off the local storage feature in WebKit
200 because I don't know if this breaks web applications.
201 .\" --------------------------------------------------------------------
202 .SH "SEE ALSO"
203 .BR lariza (1).