man/chorizo-usage.1.scd

   1 chorizo-usage(1)
   2
   3 # NAME
   4 chorizo-usage - extended usage hints
   5
   6 # DESCRIPTION
   7 *chorizo* is a simple web browser using GTK+ 3, GLib and WebKit2GTK+. This
   8 manpage contains additional hints and pointers regarding its usage.
   9
  10 # KEYBINDINGS AND CONFIGURATION
  11 For this information, please refer to *chorizo-configuration*(1).
  12
  13 # DOWNLOAD MANAGER
  14 Open the download manager using the appropriate hotkey. A new window listing
  15 your downloads will appear. Clicking on an item will remove it from the list and
  16 **if needed** cancel the download.
  17
  18 There's no file manager integration, nor does *chorizo* delete, overwrite or
  19 resume downloads. If a file already exists, it won't be touched. Instead, the
  20 new file name will have a suffix such as *.1*, *.2*, *.3*, and so on.
  21
  22 # USER-SUPPLIED JAVASCRIPT FILES
  23 After a page has been successfully loaded, the directory
  24 _~/.local/share/chorizo/user-scripts_ will be scanned and each file in it ending
  25 with *.js* will be run as a JavaScript file in the context of said page.
  26
  27 *chorizo* comes with the following scripts:
  28
  29 *hints.js*
  30         Press *f* (open link in current window) or *F* (open in new window) to
  31         activate link hints. After typing the characters for one of them, press
  32         *Enter* to confirm. Press *Escape* to abort.
  33
  34 *privacy-redirect.js*
  35         Redirects YouTube, Reddit, etc to privacy respecting alternatives.
  36
  37 *darkreader.js*
  38         See https://darkreader.org.
  39
  40 Those bundled scripts are automatically installed on *make install*. To use
  41 them, though, make sure to link them to the directory mentioned above.
  42
  43 # WEB EXTENSIONS
  44 On startup, WebKit checks _~/.local/share/chorizo/web_extensions_ for any *.so*
  45 files. See
  46 <http://blogs.igalia.com/carlosgc/2013/09/10/webkit2gtk-web-process-extensions/>
  47 this blog post for further information on these extensions.
  48
  49 *chorizo* comes with the following extensions:
  50
  51 *we_adblock.so*
  52         Generic adblock. Reads patterns from the file _~/.config/chorizo/adblock_. Each
  53         line can contain a regular expression. These expressions match
  54         case-insensitive and partially, i.e.*\*foo.\** is the same as *.\*FOO.\** and
  55         you can use anchors like *^https?://...*. Please refer to
  56         https://developer.gnome.org/glib/stable/glib-regex-syntax.html the GLib
  57         reference for more details. Lines starting with "#" are ignored.
  58
  59         Those bundled web extensions are automatically compiled when you run *make*
  60         and installed on *make install*. To use them, though, make sure to link them
  61         to the directory mentioned above.
  62
  63 # TRUSTED CERTIFICATES
  64 By default, *chorizo* trusts whatever CAs are trusted by WebKit. If you wish to
  65 trust additional certificates, such as self-signed certificates, the first thing
  66 you should do is try to add the appropriate CAs to your system-wide store.
  67
  68 If you wish to add simple exceptions, you can grab the certificate and store it
  69 in the directory _~/.local/share/chorizo/certs_. The filename must be equal to
  70 the hostname:
  71
  72         $ echo | openssl s_client -connect foo.de:443 | openssl x509 >foo.de
  73
  74 This tells *chorizo* to trust the given certificate when connecting to host
  75 *foo.de*.
  76
  77 Note: This is NOT equal to certificate pinning. WebKit ignores user-specified
  78 certificates if the server's certificate can be validated by any system-wide CA.
  79
  80 # SEE ALSO
  81 *chorizo*(1), *chorizo-config*(1)