]> git.armaanb.net Git - chorizo.git/blobdiff - chorizo-usage.7
draft
[chorizo.git] / chorizo-usage.7
diff --git a/chorizo-usage.7 b/chorizo-usage.7
new file mode 100644 (file)
index 0000000..5857863
--- /dev/null
@@ -0,0 +1,93 @@
+.TH "chorizo-usage" "7" "2021-10-11"
+.P
+.SH NAME
+chorizo-usage - extended usage hints
+.P
+.SH DESCRIPTION
+\fBchorizo\fR is a simple web browser using GTK+ 3, GLib and WebKit2GTK+.\& This
+manpage contains additional hints and pointers regarding its usage.\&
+.P
+.SH DOWNLOAD MANAGER
+Open the download manager using the appropriate hotkey.\& A new window listing
+your downloads will appear.\& Clicking on an item will remove it from the list and
+\fB\fRif needed\fB\fR cancel the download.\&
+.P
+There's no file manager integration, nor does \fBchorizo\fR delete, overwrite or
+resume downloads.\& If a file already exists, it won't be touched.\& Instead, the
+new file name will have a suffix such as \fB.\&1\fR, \fB.\&2\fR, \fB.\&3\fR, and so on.\&
+.P
+.SH USER-SUPPLIED JAVASCRIPT FILES
+When a page is being loaded, the directory \fI~/.\&local/share/chorizo/user-scripts\fR
+will be scanned and each file in it ending with \fB.\&js\fR will be run as a
+JavaScript file in the context of said page.\&
+.P
+\fBchorizo\fR comes with the following scripts:
+.P
+\fBhints.\&js\fR
+.RS 4
+Press \fBf\fR (open link in current window) or \fBF\fR (open in new window) to
+activate link hints.\& After typing the characters for one of them, press
+\fBEnter\fR to confirm.\& Press \fBEscape\fR to abort.\&
+.P
+.RE
+\fBprivacy-redirect.\&js\fR
+.RS 4
+Redirects YouTube, Reddit, etc to privacy respecting alternatives.\&
+.P
+.RE
+\fBdarkreader.\&js\fR
+.RS 4
+See https://darkreader.\&org.\&
+.P
+.RE
+Those bundled scripts are automatically installed on \fBmake install\fR.\& To use
+them, though, make sure to link them to the directory mentioned above.\&
+.P
+.SH USER-SUPPLIED CSS FILES
+User supplied CSS files will be scanned for from
+\fI~/.\&local/share/chorizo/user-styles\fR, and be applied every time a page
+loads.\& The rules in these files override any rules provided by the website.\&
+.P
+.SH WEB EXTENSIONS
+On startup, WebKit checks \fI~/.\&local/share/chorizo/web-extensions\fR for any \fB.\&so\fR
+files.\& See
+<http://blogs.\&igalia.\&com/carlosgc/2013/09/10/webkit2gtk-web-process-extensions/>
+this blog post for further information on these extensions.\&
+.P
+\fBchorizo\fR comes with the following extensions:
+.P
+\fBwe_adblock.\&so\fR
+.RS 4
+Generic adblock.\& Reads patterns from the file \fI~/.\&config/chorizo/adblock\fR.\& Each
+line can contain a regular expression.\& These expressions match
+case-insensitive and partially, i.\&e.\&\fB*foo.\&*\fR is the same as \fB.\&*FOO.\&*\fR and
+you can use anchors like \fB^https?\&://.\&.\&.\&\fR.\& Please refer to
+https://developer.\&gnome.\&org/glib/stable/glib-regex-syntax.\&html the GLib
+reference for more details.\& Lines starting with "#" are ignored.\&
+.P
+Those bundled web extensions are automatically compiled when you run \fBmake\fR
+and installed on \fBmake install\fR.\& To use them, though, make sure to link them
+to the directory mentioned above.\&
+.P
+.RE
+.SH TRUSTED CERTIFICATES
+By default, \fBchorizo\fR trusts whatever CAs are trusted by WebKit.\& If you wish to
+trust additional certificates, such as self-signed certificates, the first thing
+you should do is try to add the appropriate CAs to your system-wide store.\&
+.P
+If you wish to add simple exceptions, you can grab the certificate and store it
+in the directory \fI~/.\&local/share/chorizo/certs\fR.\& The filename must be equal to
+the hostname:
+.P
+.RS 4
+$ echo | openssl s_client -connect foo.\&de:443 | openssl x509 >foo.\&de
+.P
+.RE
+This tells \fBchorizo\fR to trust the given certificate when connecting to host
+\fBfoo.\&de\fR.\&
+.P
+Note: This is NOT equal to certificate pinning.\& WebKit ignores user-specified
+certificates if the server's certificate can be validated by any system-wide CA.\&
+.P
+.SH SEE ALSO
+\fBchorizo\fR(1), \fBchorizo-config\fR(5)