]> git.armaanb.net Git - chorizo.git/blob - chorizo.1
e7ecd4c4dbe89d945a7dfdaef49cd2f6595b1966
[chorizo.git] / chorizo.1
1 .TH "chorizo" "1" "2021-10-11"
2 .P
3 .SH NAME
4 chorizo - simple web browser
5 .P
6 .SH SYNOPSIS
7 \fBchorizo\fR - [-C] [\fIURI .\&.\&.\&\fR]
8 .P
9 .SH DESCRIPTION
10 \fBchorizo\fR is a simple web browser using GTK+ 3, GLib and WebKit2GTK+.\&
11 .P
12 .SH OPTIONS
13 In addition to the standard arguments of GTK+ 3, \fBchorizo\fR knows about the
14 following options:
15 .P
16 \fB-C\fR
17 .RS 4
18 Disables cooperative instances.\&
19 .P
20 .RE
21 \fB-p\fR
22 .RS 4
23 Launch a private window.\&
24 .P
25 .RE
26 \fB-v\fR
27 .RS 4
28 Print version and exit.\&
29 .P
30 .RE
31 After these options there can be any number of URIs specified to open.\&
32 .P
33 .SH ENVIRONMENT
34 In addition to the standard variables of GTK+ 3, \fBchorizo\fR knows about the
35 following environment variable:
36 .P
37 \fBCHORIZO_FIFO_SUFFIX\fR
38 .RS 4
39 Cooperative instances are implemented using a named pipe in the file
40 system.\& The name of this pipe usually is (at least on modern systems following
41 XDG standards: /var/run/user/$UID/chorizo.\&fifo-$CHORIZO_FIFO_SUFFIX
42 .P
43 \fB$UID\fR is the id of your user.\& \fB$CHORIZO_FIFO_SUFFIX\fR defaults to \fBmain\fR.\& If you
44 change this variable, you can launch several independent cooperative instances
45 of \fBchorizo\fR.\&
46 .P
47 .RE
48 .SH FILES
49 XDG variables will be used to construct these paths.\&
50 \fB~/.\&config/chorizo/chorizo.\&ini\fR
51 .RS 4
52 Configuration file.\& See \fBchorizo-config\fR(5).\&
53 .P
54 .RE
55 \fB~/.\&config/chorizo/adblock\fR
56 .RS 4
57 Adblock patterns.\& See \fBchorizo-usage\fR(1).\&
58 .P
59 .RE
60 \fB~/.\&local/share/chorizo/certs\fR
61 .RS 4
62 Directory where trusted certificates are stored.\& See \fBchorizo-usage\fR(1).\&
63 .P
64 .RE
65 \fB~/.\&local/share/chorizo/cookies.\&db\fR
66 .RS 4
67 Database where cookies are stored.\& It is kept in the same format as Firefox,
68 so the file can easily be copied over.\&
69 .P
70 .RE
71 \fB~/.\&local/share/chorizo/user-scripts\fR
72 .RS 4
73 Directory to store user-supplied JavaScript snippets.\& See \fBchorizo-usage\fR(1).\&
74 .P
75 .RE
76 \fB~/.\&local/share/chorizo/user-styles\fR
77 .RS 4
78 Directory to store user-supplied CSS snippets.\& See \fBchorizo-usage\fR(1).\&
79 .P
80 .RE
81 \fB~/.\&local/share/chorizo/web-extensions\fR
82 .RS 4
83 Sets the directory where WebKit will look for web extensions.\& See
84 \fBchorizo-usage\fR(1).\&
85 .P
86 .RE
87 \fB~/.\&cache/chorizo\fR
88 \fB~/.\&cache/webkitgtk\fR
89 .RS 4
90 General caches.\&
91 .P
92 .RE
93 \fB~/.\&local/share/webkitgtk\fR
94 .RS 4
95 WebKitGTK will dump its caches and local storage here.\& It is probably wise to
96 clean those directories regularly or to mount them as \fBtmpfs\fR(5).\&
97 .P
98 .RE
99 .SH LICENSE
100 \fBchorizo\fR is released under the MIT license.\& See the accompanying LICENSE file.\&
101 .P
102 .SH HISTORY
103 chorizo is a fork of the lariza browser by Peter Hofmann.\& The project was
104 started in June 2014.\& This fork is maintained by Armaan Bhojwani.\&
105 .P
106 .SH SEE ALSO
107 \fBchorizo-usage\fR(1), \fBchorizo-config\fR(5)