]> git.armaanb.net Git - chorizo.git/blobdiff - chorizo.1
draft 8
[chorizo.git] / chorizo.1
index e7ecd4c4dbe89d945a7dfdaef49cd2f6595b1966..c540fc063a946ea22b3ed2fb4585e08f1806779f 100644 (file)
--- a/chorizo.1
+++ b/chorizo.1
-.TH "chorizo" "1" "2021-10-11"
-.P
-.SH NAME
-chorizo - simple web browser
-.P
-.SH SYNOPSIS
-\fBchorizo\fR - [-C] [\fIURI .\&.\&.\&\fR]
-.P
-.SH DESCRIPTION
-\fBchorizo\fR is a simple web browser using GTK+ 3, GLib and WebKit2GTK+.\&
-.P
-.SH OPTIONS
-In addition to the standard arguments of GTK+ 3, \fBchorizo\fR knows about the
-following options:
-.P
-\fB-C\fR
-.RS 4
-Disables cooperative instances.\&
-.P
-.RE
-\fB-p\fR
-.RS 4
-Launch a private window.\&
-.P
-.RE
-\fB-v\fR
-.RS 4
-Print version and exit.\&
-.P
-.RE
-After these options there can be any number of URIs specified to open.\&
-.P
-.SH ENVIRONMENT
-In addition to the standard variables of GTK+ 3, \fBchorizo\fR knows about the
-following environment variable:
-.P
-\fBCHORIZO_FIFO_SUFFIX\fR
-.RS 4
-Cooperative instances are implemented using a named pipe in the file
-system.\& The name of this pipe usually is (at least on modern systems following
-XDG standards: /var/run/user/$UID/chorizo.\&fifo-$CHORIZO_FIFO_SUFFIX
-.P
-\fB$UID\fR is the id of your user.\& \fB$CHORIZO_FIFO_SUFFIX\fR defaults to \fBmain\fR.\& If you
-change this variable, you can launch several independent cooperative instances
-of \fBchorizo\fR.\&
-.P
-.RE
-.SH FILES
-XDG variables will be used to construct these paths.\&
-\fB~/.\&config/chorizo/chorizo.\&ini\fR
-.RS 4
-Configuration file.\& See \fBchorizo-config\fR(5).\&
-.P
-.RE
-\fB~/.\&config/chorizo/adblock\fR
-.RS 4
-Adblock patterns.\& See \fBchorizo-usage\fR(1).\&
-.P
-.RE
-\fB~/.\&local/share/chorizo/certs\fR
-.RS 4
-Directory where trusted certificates are stored.\& See \fBchorizo-usage\fR(1).\&
-.P
-.RE
-\fB~/.\&local/share/chorizo/cookies.\&db\fR
-.RS 4
-Database where cookies are stored.\& It is kept in the same format as Firefox,
-so the file can easily be copied over.\&
-.P
-.RE
-\fB~/.\&local/share/chorizo/user-scripts\fR
-.RS 4
-Directory to store user-supplied JavaScript snippets.\& See \fBchorizo-usage\fR(1).\&
-.P
-.RE
-\fB~/.\&local/share/chorizo/user-styles\fR
-.RS 4
-Directory to store user-supplied CSS snippets.\& See \fBchorizo-usage\fR(1).\&
-.P
-.RE
-\fB~/.\&local/share/chorizo/web-extensions\fR
-.RS 4
-Sets the directory where WebKit will look for web extensions.\& See
-\fBchorizo-usage\fR(1).\&
-.P
-.RE
-\fB~/.\&cache/chorizo\fR
-\fB~/.\&cache/webkitgtk\fR
-.RS 4
-General caches.\&
-.P
-.RE
-\fB~/.\&local/share/webkitgtk\fR
-.RS 4
-WebKitGTK will dump its caches and local storage here.\& It is probably wise to
-clean those directories regularly or to mount them as \fBtmpfs\fR(5).\&
-.P
-.RE
-.SH LICENSE
-\fBchorizo\fR is released under the MIT license.\& See the accompanying LICENSE file.\&
-.P
-.SH HISTORY
-chorizo is a fork of the lariza browser by Peter Hofmann.\& The project was
-started in June 2014.\& This fork is maintained by Armaan Bhojwani.\&
-.P
-.SH SEE ALSO
-\fBchorizo-usage\fR(1), \fBchorizo-config\fR(5)
+.Dd $Mdocdate$
+.Dt CHORIZO 1
+.Os
+.
+.Sh NAME
+.Nm chorizo
+.Nd simple web browser
+.
+.Sh SYNOPSIS
+.Nm chorizo
+.Op Fl cpvV
+.Ar URL
+.
+.Sh DESCRIPTION
+.Nm
+is a simple web browser based on GTK+3 and WebKit2GTK+.
+.Pp
+The options are as follows:
+.Bl -tag
+.It Fl c
+Disable cooperative instances.
+.It Fl p
+Open in private mode.
+.It Fl v
+Print version and exit.
+.It Fl V
+Launch in verbose mode.
+.El
+.Pp
+After these options, an arbitary number of URIs can be provided to open.
+.
+.Sh ENVIRONMENT
+.Bl -tag
+.It Ev CHORIZO_FIFO_SUFFIX
+Suffix for named pipe. Useful for seperating coopertative instances.
+.El
+.
+.Sh FILES
+.Pp
+These paths are constructed using XDG environment variables.
+.Bl -tag
+.It Pa ~/.config/chorizo/adblock
+Adblock patterns.
+.It Pa ~/.local/share/chorizo/certs
+Directory where trusted certificates are stored.
+.It Pa ~/.local/share/chorizo/cookies.db
+Cookie databse. Same format as Firefox.
+.It Pa ~/.local/share/chorizo/user-scripts/
+Directory to stop user-supplied JavaScript snippets.
+.It Pa ~/.local/share/chorizo/user-styles/
+Directory to stop user-supplied CSS snippets.
+.It Pa ~/.local/share/chorizo/web-extensions/
+Directory to stop user-supplied web extensions.
+.It Pa ~/.cache/chorizo/
+.It Pa ~/.cache/webkitgtk/
+General caches.
+.It Pa ~/.local/share/webkitgtk/
+WebkitGTK's dumping ground.
+.El
+.
+.Sh SEE ALSO
+.Xr chorizo-usage 1
+.
+.Sh HISTORY
+.Nm
+is a fork of the lariza browser by Peter Hoffman.
+The project was started in June 2014,
+and was forked into Chorizo in May 2021.
+
+This fork is maintained by Armaan Bhojwani.