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