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