X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=chorizo-usage.1;fp=chorizo-usage.1;h=7f1199345982557ec5bb833886b88e57c37c3cfc;hb=a682737372af005d3be78248296680f131e39858;hp=d8a71fb549d1811417da87aa97c8d97dc4bff8c5;hpb=1e1cff8509043df4dbd5856b579c5cf2bb0cb0ba;p=chorizo.git diff --git a/chorizo-usage.1 b/chorizo-usage.1 index d8a71fb..7f11993 100644 --- a/chorizo-usage.1 +++ b/chorizo-usage.1 @@ -1,93 +1,107 @@ -.TH "chorizo-usage" "1" "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 - -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) +.Dd $Mdocdate$ +.Dt CHORIZO 1 +.Os +. +.Sh NAME +.Nm chorizo-usage +.Nd extended usage hints +. +.Sh UI ELEMENTS +.Ss DOWNLOAD MANAGER +The download manager lets you view in-progress and completed downloads. +Launch it with ^y. To manage downloads, just click on them. +. +.Ss THE TAB STACK +Tabs are presented vertically on the left side of the window. +Tabs can be dragged to be reordered, +and middle clicked to close. +Muted tabs are given the "[M]" prefix. +. +.Ss THE URL AND SEARCH BARS +At the bottom of the screen are the URL and the search bars. +Focus the URL bar with ^s, and the search bar with ^d. +. +.Ss THE ISEARCH BAR +Hit ^f to open up the isearch bar. +This lets you search for text within the page. +Enter and shift-enter will cycle through matches. +Escape or ^g will close it. +. +.Sh USER CONTENT +.Ss JAVASCRIPT +When a new web process is launched, +.Pa ~/.local/share/chorizo/user-scripts +is scanned for files with the .js suffix. +These scripts will be run every time a page is loaded. +.Pp +The chorizo repository contains the following optional scripts: +.Bl -tag +.It hints.js +Provides link hints. +Press "f" to activate link hints for opening in the current tab, +or "F" for a new tab. +After entering the according code, +press enter to confirm or escape to abort. +.It privacy-redirect.js +Redirects social media sites to privacy respecting alternatives. +.It darkreader.js +Makes webpages dark. +.El +.Pp +These scripts are installed by default to +.Pa /usr/local/share/chorizo/user-scripts +. +.Ss CSS +When a new web process is launched, +.Pa ~/.local/share/chorizo/user-styles +is scanned for files with the .css suffix. +These styles will be applied every time a page is loaded. +. +.Ss WEB EXTENSIONS +When a new web process is launched, +.Pa ~/.local/share/chorizo/web-extensions +for webkit2gtk web extensions. +See +http://blog.igalia.com/carlosgc/2013/09/10/webkit2gtk-web-process-extensions/ +for more informatino. +.Pp +NB: these are different than Firefox/Chromium WebExtensions. +.Pp +The chorizo repository contains the following optional web extensions: +.Bl -tag +.It we_adblock.so +Generic adblocker. +Reads patterns from +.Pa ~/.config/chorizo/adblock +Each line can contain a regular expression. +These expressions match case insesitively, +and anchors like ^https?://.... can be used. +.Pp +Eg: +*foo.* is the same as .*FOO.* +.Pp +See +https://developer.gnome.org/glib/stable/glib-regex-syntax.html +for more information. +Lines starting with "#" are ignored. +.El +.Pp +These web extensions are installed by default to +.Pa /usr/local/share/chorizo/web-extensions +. +.Sh TRUSTED CERTIFICATES +By default, +.Nm +trusts whatever CAs are trusted by Webkit. +If you wish to trust additional certificates, +and you cannot add it to the system-wide store, +then you can store the certificate in +.Pa ~/.local/share/chorizo/certs/ +The filename must be the same as the hostname. +.Pp +NB: 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. +. +.Sh SEE ALSO +.Xr chorizo 1