chorizo-usage.1

   1 .Dd $Mdocdate$
   2 .Dt CHORIZO 1
   3 .Os
   4 .
   5 .Sh NAME
   6 .Nm chorizo-usage
   7 .Nd extended usage hints
   8 .
   9 .Sh UI ELEMENTS
  10 .Ss DOWNLOAD MANAGER
  11 The download manager lets you view in-progress and completed downloads.
  12 Launch it with ^y. To manage downloads, just click on them.
  13 .
  14 .Ss THE TAB STACK
  15 Tabs are presented vertically on the left side of the window.
  16 Tabs can be dragged to be reordered,
  17 and middle clicked to close.
  18 Muted tabs are given the "[M]" prefix.
  19 .
  20 .Ss THE URL AND SEARCH BARS
  21 At the bottom of the screen are the URL and the search bars.
  22 Focus the URL bar with ^s, and the search bar with ^d.
  23 .
  24 .Ss THE ISEARCH BAR
  25 Hit ^f to open up the isearch bar.
  26 This lets you search for text within the page.
  27 Enter and shift-enter will cycle through matches.
  28 Escape or ^g will close it.
  29 .
  30 .Sh USER CONTENT
  31 .Ss JAVASCRIPT
  32 When a new web process is launched,
  33 .Pa ~/.local/share/chorizo/user-scripts
  34 is scanned for files with the .js suffix.
  35 These scripts will be run every time a page is loaded.
  36 .Pp
  37 The chorizo repository contains the following optional scripts:
  38 .Bl -tag
  39 .It hints.js
  40 Provides link hints.
  41 Press "f" to activate link hints for opening in the current tab,
  42 or "F" for a new tab.
  43 After entering the according code,
  44 press enter to confirm or escape to abort.
  45 .It privacy-redirect.js
  46 Redirects social media sites to privacy respecting alternatives.
  47 .It darkreader.js
  48 Makes webpages dark.
  49 .El
  50 .Pp
  51 These scripts are installed by default to
  52 .Pa /usr/local/share/chorizo/user-scripts
  53 .
  54 .Ss CSS
  55 When a new web process is launched,
  56 .Pa ~/.local/share/chorizo/user-styles
  57 is scanned for files with the .css suffix.
  58 These styles will be applied  every time a page is loaded.
  59 .
  60 .Ss WEB EXTENSIONS
  61 When a new web process is launched,
  62 .Pa ~/.local/share/chorizo/web-extensions
  63 for webkit2gtk web extensions.
  64 See
  65 http://blog.igalia.com/carlosgc/2013/09/10/webkit2gtk-web-process-extensions/
  66 for more informatino.
  67 .Pp
  68 NB: these are different than Firefox/Chromium WebExtensions.
  69 .Pp
  70 The chorizo repository contains the following optional web extensions:
  71 .Bl -tag
  72 .It we_adblock.so
  73 Generic adblocker.
  74 Reads patterns from
  75 .Pa ~/.config/chorizo/adblock
  76 Each line can contain a regular expression.
  77 These expressions match case insesitively,
  78 and anchors like ^https?://.... can be used.
  79 .Pp
  80 Eg:
  81 *foo.* is the same as .*FOO.*
  82 .Pp
  83 See
  84 https://developer.gnome.org/glib/stable/glib-regex-syntax.html
  85 for more information.
  86 Lines starting with "#" are ignored.
  87 .El
  88 .Pp
  89 These web extensions are installed by default to
  90 .Pa /usr/local/share/chorizo/web-extensions
  91 .
  92 .Sh TRUSTED CERTIFICATES
  93 By default,
  94 .Nm
  95 trusts whatever CAs are trusted by Webkit.
  96 If you wish to trust additional certificates,
  97 and you cannot add it to the system-wide store,
  98 then you can store the certificate in
  99 .Pa ~/.local/share/chorizo/certs/
 100 The filename must be the same as the hostname.
 101 .Pp
 102 NB: This is NOT equal to certificate pinning.
 103 WebKit ignores user-specified certificates if the server's certificate can be
 104 validated by any system-wide CA.
 105 .
 106 .Sh SEE ALSO
 107 .Xr chorizo 1