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 "Global hotkeys"
  47 These hotkeys work when either the location bar or the web view is being
  48 focused.
  49 .TP
  50 \fBMod1\fP + \fBx\fP
  51 Launch the external handler for the currently loaded URI.
  52 .TP
  53 \fBMod1\fP + \fBq\fP
  54 Close the current window. Quits the entire program if this was the last
  55 window and if there are no more active downloads (download manager is
  56 shown otherwise).
  57 .TP
  58 \fBMod1\fP + \fBw\fP
  59 Go to your \(lqhomepage\(rq. See the environment variable
  60 $\fBLARIZA_HOME_URI\fP.
  61 .TP
  62 \fBMod1\fP + \fBe\fP
  63 Open a new window.
  64 .TP
  65 \fBMod1\fP + \fBr\fP
  66 Reload the current page.
  67 .TP
  68 \fBMod1\fP + \fBd\fP
  69 Open the download manager.
  70 .TP
  71 \fBMod1\fP + \fBl\fP
  72 Focus the location bar.
  73 .TP
  74 \fBMod1\fP + \fBk\fP
  75 Focus the location bar and set its text to \fB:/\fP, allowing you to
  76 easily initiate a search.
  77 .TP
  78 \fBMod1\fP + \fB2\fP
  79 .TQ
  80 \fBMod1\fP + \fBn\fP
  81 Repeat the last search (forward).
  82 .TP
  83 \fBMod1\fP + \fB3\fP
  84 Repeat the last search (backward).
  85 .TP
  86 \fBMod1\fP + \fBc\fP
  87 Reload trusted certificates.
  88 .TP
  89 \fBF2\fP / \fBF3\fP
  90 Go backward and forward in current browser history.
  91 .P
  92 .SS "Main window \(em WebKit viewport focused"
  93 .TP
  94 \fBEscape\fP
  95 Stop loading.
  96 .TP
  97 \fBMiddle mouse\fP
  98 Open the link under the pointer in a new window.
  99 .TP
 100 \fBBackward\fP / \fBforward\fP (mouse keys 8 and 9)
 101 Same as \fBF2\fP and \fBF3\fP.
 102 .TP
 103 \fBMod1\fP + \fBScroll up\fP
 104 .TQ
 105 \fBCtrl\fP + \fBScroll up\fP
 106 Increase zoom level of the current page.
 107 .TP
 108 \fBMod1\fP + \fBScroll down\fP
 109 .TQ
 110 \fBCtrl\fP + \fBScroll down\fP
 111 Decrase zoom level of the current page.
 112 .TP
 113 \fBMod1\fP + \fBScroll horizontally\fP
 114 .TQ
 115 \fBCtrl\fP + \fBScroll horizontally\fP
 116 Reset zoom to $\fBLARIZA_ZOOM\fP.
 117 .P
 118 .SS "Main window \(em location bar focused"
 119 .TP
 120 \fBEscape\fP
 121 Reset the content of the location bar to the current URI.
 122 .TP
 123 \fBReturn\fP
 124 Commit, i.e. begin searching, do a keyword based search or open the URI.
 125 .P
 126 .SS "Download manager"
 127 .TP
 128 \fBMod1\fP + \fBd\fP
 129 .TQ
 130 \fBMod1\fP + \fBq\fP
 131 Close the download manager. Active downloads are never aborted. However,
 132 if there are no more active downloads and no more browsing windows, then
 133 the entire program will quit.
 134 .\" --------------------------------------------------------------------
 135 .SH "KEYWORD BASED SEARCHING"
 136 In this file, you can configure keywords and the associated URIs:
 137 \fI~/.config\:/lariza\:/keywordsearch\fP. Each line has to look like
 138 this:
 139 .P
 140 \f(CW
 141 .nf
 142 \&wi https://en.wikipedia.org/w/index.php?title=Special:Search&search=%s
 143 .fi
 144 \fP
 145 .P
 146 \fBwi\fP is the keyword, so when opening \fBwi foo\fP, \fBlariza\fP
 147 will search in Wikipedia. Note the \fB%s\fP at the end of the URI: This
 148 is where your search term will be placed.
 149 .P
 150 Lines starting with \fB#\fP are ignored.
 151 .\" --------------------------------------------------------------------
 152 .SH "USER-SUPPLIED JAVASCRIPT FILES"
 153 After a page has been successfully loaded, the directory
 154 \fI~/.config\:/lariza\:/scripts\fP will be scanned and each file in it
 155 ending with \fB.js\fP will be run as a JavaScript file in the context of
 156 said page.
 157 .P
 158 During development, you will most likely want to run \fBlariza\fP with
 159 $\fBLARIZA_ENABLE_CONSOLE_TO_STDOUT\fP enabled.
 160 .\" --------------------------------------------------------------------
 161 .SH "TRUSTED CERTIFICATES"
 162 By default, \fBlariza\fP trusts whatever CAs are trusted by WebKit, i.e. by
 163 your GnuTLS installation. If you wish to trust additional certificates,
 164 such as self-signed certificates, the first thing you should do is try
 165 to add the appropriate CAs to your system-wide store.
 166 .P
 167 If you wish to add simple exceptions, you can grab the certificate and
 168 store it in the directory \fI~/.config/lariza/certs\fP. The filename
 169 must be equal to the hostname:
 170 .P
 171 .\f(CW
 172 .nf
 173 \&$ echo | openssl s_client -connect foo.de:443 | openssl x509 >foo.de
 174 .fi
 175 \fP
 176 .P
 177 This tells \fBlariza\fP to trust the given certificate when connecting
 178 to host \fBfoo.de\fP.
 179 .P
 180 You can reload these certificates at runtime by pressing the appropriate
 181 hotkey. Note that removed certificates will be kept in memory until you
 182 restart \fBlariza\fP.
 183 .P
 184 Note: This is NOT equal to certificate pinning. WebKit ignores
 185 user-specified certificates if the server's certificate can be validated
 186 by any system-wide CA.
 187 .\" --------------------------------------------------------------------
 188 .SH "EXTERNAL URI HANDLER"
 189 \fBlariza\fP can launch an executable called
 190 \fIlariza-external-handler\fP. It will be passed the \(lqselected\(rq
 191 URI as a command line argument:
 192 .P
 193 .\f(CW
 194 .nf
 195 $ lariza-external-handler -u https://github.com
 196 .fi
 197 \fP
 198 .P
 199 This executable must be a user-supplied program. It can do anything it
 200 wants to with that URI. \fBlariza\fP ignores the exit code of the
 201 handler.
 202 .P
 203 The \fB\-u\fP will always be set. This allows you to use \fBgetopt\fP(1)
 204 like parameter parsing in your program.
 205 .P
 206 You can either use the appropriate hotkey (see list above) to launch the
 207 handler with the currently loaded URI, or you can perform a right click
 208 on any link, image or media file to use that URI.
 209 .P
 210 This mechanism allows you to implement a variety of functions. You might
 211 want to implement a bookmarking script or a password manager or you
 212 might simply load the current URI in a different browser. That's up to
 213 you.
 214 .\" --------------------------------------------------------------------
 215 .SH "USING LARIZA WITH TABBED"
 216 By default, \fBlariza\fP automatically launches an instance of suckless'
 217 \fBtabbed\fP(1).
 218 .P
 219 You can turn this feature off (see command line arguments) or you can
 220 specify a command line argument to embed \fBlariza\fP into an arbitrary
 221 container (XEMBED). Note that \fBlariza\fP will also automatically embed
 222 new windows in the same container.
 223 .P
 224 When using the automatically launched \fBtabbed\fP(1) instance, you
 225 can't use \fBtabbed\fP(1)'s \fBCtrl + Shift + Return\fP hotkey. This is
 226 because \fBtabbed\fP(1) is launched with \fB\-d\fP, so it knows nothing
 227 about \fBlariza\fP. However, \fBlariza\fP provides its own hotkey to
 228 launch a new window which will be embedded in the same instance of
 229 \fBtabbed\fP(1).
 230 .\" --------------------------------------------------------------------
 231 .SH "WEBKIT LOCAL STORAGE"
 232 WebKit does create files in your $\fBXDG_*\fP directories, i.e.
 233 \fI~/.local/share\fP or \fI~/.cache\fP. It's up to you what you want to
 234 do with this junk. I remove it regularly when no WebKit browser is
 235 running. Another option would be to change the $\fBXDG_*\fP variables.
 236 .P
 237 I have explicitly not turned off the local storage feature in WebKit
 238 because I don't know if this breaks web applications.
 239 .\" --------------------------------------------------------------------
 240 .SH "SEE ALSO"
 241 .BR lariza (1).