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