]> git.armaanb.net Git - chorizo.git/blob - man1/lariza.1
Support WebKit "enable-write-console-messages-to-stdout" via env-variable.
[chorizo.git] / man1 / lariza.1
1 .TH lariza 1 "2015-11-28" "lariza" "User Commands"
2 .\" --------------------------------------------------------------------
3 .SH NAME
4 lariza \- simple web browser
5 .\" --------------------------------------------------------------------
6 .SH SYNOPSIS
7 \fBlariza\fP
8 [\fB\-e\fP \fIwid\fP]
9 [\fB\-C\fP]
10 [\fB\-T\fP]
11 [\fIURI ...\fP]
12 .\" --------------------------------------------------------------------
13 .SH DESCRIPTION
14 \fBlariza\fP is a simple web browser using GTK+ 3, GLib and WebKit2GTK+.
15 .\" --------------------------------------------------------------------
16 .SH OPTIONS
17 In addition to the standard arguments of GTK+ 3, \fBlariza\fP knows
18 about the following options:
19 .TP
20 \fB\-e\fP \fIwid\fP
21 Embeds the main window and all newly created windows in the window
22 specified by \fIwid\fP. The download manager is always a \(lqpopup\(rq.
23 .TP
24 \fB\-C\fP
25 Disables cooperative instances.
26 .TP
27 \fB\-T\fP
28 Disables automatic launching of suckless' \fBtabbed\fP(1).
29 .P
30 After these options there can be any number of URIs. If no URIs are
31 given, $\fBLARIZA_HOME_URI\fP will be opened.
32 .\" --------------------------------------------------------------------
33 .SH ENVIRONMENT
34 In addition to the standard variables of GTK+ 3, \fBlariza\fP knows
35 about the following environment variables:
36 .P
37 .TP
38 \fBLARIZA_ACCEPTED_LANGUAGE\fP
39 In HTTP requests, WebKit sets the \(lqAccepted-Language\(rq header to
40 this value. Defaults to \fBen-US\fP.
41 .TP
42 \fBLARIZA_DOWNLOAD_DIR\fP
43 All downloads are automatically stored in this directory. If you want to
44 stick to XDG directories, then you should configure your
45 \(lqxdg-user-dirs\(rq and use this:
46
47 \f(CW
48 .nf
49 \&LARIZA_DOWNLOAD_DIR=$(xdg-user-dir DOWNLOAD)
50 .fi
51 \fP
52
53 This variable defaults to \fB/var/tmp\fP.
54 .TP
55 \fBLARIZA_ENABLE_CONSOLE_TO_STDOUT\fP
56 Enable writing WebKit console messages to stdout.
57 .TP
58 \fBLARIZA_ENABLE_EXPERIMENTAL_WEBGL\fP
59 Enable WebGL support in WebKit if this variable is set. Note that this
60 is an \fBEXPERIMENTAL\fP feature. This setting could vanish from
61 \fBlariza\fP in future releases without notice.
62 .TP
63 \fBLARIZA_FIFO_SUFFIX\fP
64 Cooperative instances are implemented using a named pipe in the file
65 system. The name of this pipe usually is (at least on modern systems
66 following XDG \(lqstandards\(rq):
67 \fI/var\:/run\:/user\:/$UID\:/lariza.fifo\:-$LARIZA_FIFO_SUFFIX\fP.
68
69 $\fBUID\fP is the id of your user. $\fBLARIZA_FIFO_SUFFIX\fP defaults to
70 \fBmain\fP. If you change this variable, you can launch several
71 independent cooperative instances of \fBlariza\fP.
72 .TP
73 \fBLARIZA_HISTORY_FILE\fP
74 If set, \fBlariza\fP will write each visited URI to that file. This path
75 can point to a named pipe, but be aware that the browser will block
76 until a reader at the other end of the pipe has read all pending data.
77 .TP
78 \fBLARIZA_HOME_URI\fP
79 This URI will be opened by pressing the appropriate hotkeys
80 (\(lqhomepage\(rq or \(lqnew window\(rq) and if no URIs are specified on
81 the command line. Defaults to \fBabout:blank\fP.
82 .TP
83 \fBLARIZA_USER_AGENT\fP
84 \fBlariza\fP will identify itself with this string. Uses WebKit's
85 default value if unset.
86 .TP
87 \fBLARIZA_ZOOM
88 Zoom level for WebKit viewports. Defaults to \fB1.0\fP.
89 .\" --------------------------------------------------------------------
90 .SH FILES
91 XDG variables will be used to construct these paths.
92 .TP
93 \fI~/.config\:/lariza\:/adblock.black\fP
94 Adblock patterns. See \fBlariza.usage\fP(1).
95 .TP
96 \fI~/.config\:/lariza\:/certs\fP
97 Directory where trusted certificates are stored. See
98 \fBlariza.usage\fP(1).
99 .TP
100 \fI~/.config\:/lariza\:/keywordsearch\fP
101 Configuration file for keyword base searching. See
102 \fBlariza.usage\fP(1).
103 .TP
104 \fI~/.local\:/share\:/lariza\:/web_extensions\fP
105 Sets the directory where WebKit will look for web extensions. See
106 \fBlariza.usage\fP(1).
107 .P
108 The executable \fIlariza-external-handler\fP must be located somewhere
109 in your $\fBPATH\fP, if you want to make use of the external URI
110 handler. See \fBlariza.usage\fP(1) for details.
111 .\" --------------------------------------------------------------------
112 .SH LICENSE
113 \fBlariza\fP is released under the MIT license. See the accompanying
114 \fILICENSE\fP file.
115 .\" --------------------------------------------------------------------
116 .SH HISTORY
117 \fBlariza\fP was originally written by Peter Hofmann. The project
118 was started in June 2014.
119 .\" --------------------------------------------------------------------
120 .SH "SEE ALSO"
121 .BR lariza.usage (1),
122 .BR tabbed (1).