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