diff options
Diffstat (limited to 'man1/lariza.1')
-rw-r--r-- | man1/lariza.1 | 215 |
1 files changed, 102 insertions, 113 deletions
diff --git a/man1/lariza.1 b/man1/lariza.1 index e0294db..3b169d1 100644 --- a/man1/lariza.1 +++ b/man1/lariza.1 @@ -1,119 +1,108 @@ -.TH lariza 1 "2021-01-03" "lariza" "User Commands" -.\" -------------------------------------------------------------------- -.SH NAME -lariza \- simple web browser -.\" -------------------------------------------------------------------- -.SH SYNOPSIS -\fBlariza\fP -[\fB\-C\fP] -[\fIURI ...\fP] -.\" -------------------------------------------------------------------- -.SH DESCRIPTION -\fBlariza\fP is a simple web browser using GTK+ 3, GLib and WebKit2GTK+. -.\" -------------------------------------------------------------------- -.SH OPTIONS -In addition to the standard arguments of GTK+ 3, \fBlariza\fP knows -about the following options: -.TP -\fB\-C\fP +.Dd Jul 17, 2021 +.Dt lariza 1 +.Sh NAME +.Nm lariza +.Nd simple web browser +.Sh SYNOPSIS +.Nm +.Op Fl C +.Op Ar URI... +.Sh DESCRIPTION +.Nm +is a simple web browser using GTK+3, GLib and Webkit2GTK+ +.Sh OPTIONS +In addition to the standard arguments of GTK+3, +.Nm +knows about the following options: +.Bl -tag +.It Fl C Disables cooperative instances. -.P -After these options there can be any number of URIs. If no URIs are -given, $\fBLARIZA_HOME_URI\fP will be opened. -.\" -------------------------------------------------------------------- -.SH ENVIRONMENT -In addition to the standard variables of GTK+ 3, \fBlariza\fP knows -about the following environment variables: -.P -.TP -\fBLARIZA_ACCEPTED_LANGUAGE\fP -In HTTP requests, WebKit sets the \(lqAccepted-Language\(rq header to -this value. Defaults to \fBen-US\fP. -.TP -\fBLARIZA_DOWNLOAD_DIR\fP -All downloads are automatically stored in this directory. If you want to -stick to XDG directories, then you should configure your -\(lqxdg-user-dirs\(rq and use this: - -\f(CW -.nf -\&LARIZA_DOWNLOAD_DIR=$(xdg-user-dir DOWNLOAD) -.fi -\fP - -This variable defaults to \fB/var/tmp\fP. -.TP -\fBLARIZA_ENABLE_CONSOLE_TO_STDOUT\fP +.El +.Pp +After these options there can be any number of +.Ar URIs . +If no +.Ar URIs +are given, $\fBLARIZA_HOME_URI\fP will be opened. +.Sh ENVIRONMENT +In addition to the standard variables of GTK+3, +.Nm +knows about the following environment variables: +.Bl -tag +.It Sy LARIZA_ACCEPTED_LANGUAGE +In HTTP requests, WebKit sets the +.Dq Accepted-Language +header to this value. Defaults to +.Sy en-US . +.It Sy LARIZA_DOWNLOAD_DIR +All downloads are automatically stored in this directory. This variable defaults +to +.Pa /var/tmp . +.It Sy LARIZA_ENABLE_CONSOLE_TO_STDOUT Enable writing WebKit console messages to stdout. -.TP -\fBLARIZA_FIFO_SUFFIX\fP -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 \(lqstandards\(rq): -\fI/var\:/run\:/user\:/$UID\:/lariza.fifo\:-$LARIZA_FIFO_SUFFIX\fP. - -$\fBUID\fP is the id of your user. $\fBLARIZA_FIFO_SUFFIX\fP defaults to -\fBmain\fP. If you change this variable, you can launch several -independent cooperative instances of \fBlariza\fP. -.TP -\fBLARIZA_HISTORY_FILE\fP -If set, \fBlariza\fP will write each visited URI to that file. This path -can point to a named pipe, but be aware that the browser will block -until a reader at the other end of the pipe has read all pending data. -.TP -\fBLARIZA_HOME_URI\fP -This URI will be opened by pressing the appropriate hotkeys -(\(lqhomepage\(rq or \(lqnew window\(rq) and if no URIs are specified on -the command line. Defaults to \fBabout:blank\fP. -.TP -\fBLARIZA_TAB_POS\fP -Can be one of \fBtop\fP (default), \fBright\fP, \fBbottom\fP, -\fBleft\fP. -.TP -\fBLARIZA_TAB_WIDTH_CHARS\fP +.It Sy LARIZA_FIFO_SUFFIX +Cooperative instances are implemented using a named pipe in the file system. The +name of this pipe usually is +.Pq at least on modern systems following XDG Dq standards : +.Pa /var/run/user/$UID/lariza.fifo-$LARIZA_FIFO_SUFFIX . +.Pp +.Sy $UID +is the id of your user. +.Sy $LARIZA_FIFO_SUFFIX +defaults to +.Sy main . +If you change this variable, you can launch several independent cooperative +instances of +.Nm . +.It Sy LARIZA_HISTORY_FILE +If set, +.Nm +will write each visited URI to that file. This path can point to a named pipe, +but be aware that the browser will block until a reader at the other end of the +pipe has read all pending data. +.It Sy LARIZA_HOME_URI +This URI will be opened by pressing the appropriate hokeys +.Pq Do homepage Dc or Do new window Dc +and if no URIs are specified on the command line. Defaults to +.Sy about:blank . +.It Sy LARIZA_TAB_POS +Can be one of +.Sy top +.Pq default , +.Sy right , bottom, left . +.It Sy LARIZA_TAB_WIDTH_CHARS An integer, determines width of tabs. Defaults to 20. -.TP -\fBLARIZA_USER_AGENT\fP -\fBlariza\fP will identify itself with this string. Uses WebKit's -default value if unset. -.TP -\fBLARIZA_ZOOM -Zoom level for WebKit viewports. Defaults to \fB1.0\fP. -.\" -------------------------------------------------------------------- -.SH FILES +.It Sy LARIZA_USER_AGENT +.Nm +will identify itself with this string. Uses WebKit's default value if unset. +.It Sy LARIZA_ZOOM +Zoom level for WebKit viewports. Defaults to 1.0. +.El +.Sh FILES XDG variables will be used to construct these paths. -.TP -\fI~/.config\:/lariza\:/adblock\fP -Adblock patterns. See \fBlariza.usage\fP(1). -.TP -\fI~/.config\:/lariza\:/certs\fP +.Bl -tag +.It Pa ~/.config/lariza/adblock +Adblock patterns. See +.Xr lariza.usage 1 . +.It Pa ~/.config/lariza/certs Directory where trusted certificates are stored. See -\fBlariza.usage\fP(1). -.TP -\fI~/.config\:/lariza\:/scripts\fP +.Xr lariza.usage 1 . +.It Pa ~/.config/lariza/scripts Directory to store user-supplied JavaScript snippets. See -\fBlariza.usage\fP(1). -.TP -\fI~/.local\:/share\:/lariza\:/web_extensions\fP -Sets the directory where WebKit will look for web extensions. See -\fBlariza.usage\fP(1). -.TP -\fI~/.cache\:/lariza\fP -.TQ -\fI~/.cache\:/webkitgtk\fP -.TQ -\fI~/.local\:/share\:/webkitgtk\fP -WebKitGTK will dump its caches and local storage here. It is probably -wise to clean those directories regularly or to mount them as -\fBtmpfs\fP(5). -.\" -------------------------------------------------------------------- -.SH LICENSE -\fBlariza\fP is released under the MIT license. See the accompanying -\fILICENSE\fP file. -.\" -------------------------------------------------------------------- -.SH HISTORY -\fBlariza\fP was originally written by Peter Hofmann. The project -was started in June 2014. -.\" -------------------------------------------------------------------- -.SH "SEE ALSO" -.BR lariza.usage (1). +.Xr lariza.usage 1 . +.It Pa ~/.cache/lariza , ~/.cache/webkitgtk , ~/.local/share/webkitgtk +WebKitGTK will dump its caches and local storage here. +.It Pa ~/.cache/lariza/cookies.txt +.Nm +will save its cookies in this text file. +.El +.Sh LICENSE +.Nm +is released under the MIT license. See the accompanying +.Pa LICENSE +file. +.Sh HISTORY +.Nm +was originally written by Peter Hofmann. The project was started in June 2014. +.Sh SEE ALSO +.Xr lariza.usage 1 |