summaryrefslogtreecommitdiff
path: root/res/lagrange.1
blob: 7b8815c1eea6081431776d2229b4603df09c8296 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "LAGRANGE" "1" "January 2022" "" ""
.hy
.SH NAME
.PP
lagrange - a beautiful Gemini client
.SH SYNOPSIS
.PP
\f[B]lagrange\f[R]
[options]\ [\f[I]URL\f[R]]\&...\ [\f[I]FILE\f[R]]\&...
.SH DESCRIPTION
.PP
Lagrange is a graphical client for the Gemini, Gopher, and Finger
protocols.
It offers modern conveniences familiar from web browsers, such as smooth
scrolling, inline image viewing, multiple tabs, visual themes, Unicode
fonts, and bookmarks.
.SH OPTIONS
.PP
When multiple URLs and/or local files are specified, they are opened in
separate tabs.
.TP
\f[B]-E\f[R], \f[B]--echo\f[R]
Print all internal application events to stdout.
Useful for debugging.
.TP
\f[B]--help\f[R]
List the available command line options.
.TP
\f[B]-u\f[R], \f[B]--url-or-search\f[R] \f[I]URL\f[R] | \f[I]TEXT\f[R]
Open a URL, or make a search query with given text.
This only works if the search query URL has been configured.
.TP
\f[B]-V\f[R], \f[B]--version\f[R]
Output the version number.
.SS Window options:
.TP
\f[B]-h\f[R], \f[B]--height\f[R] \f[I]N\f[R]
Set initial window height to \f[I]N\f[R] pixels.
.TP
\f[B]--sw\f[R]
Disable hardware-accelerated rendering.
.TP
\f[B]-w\f[R], \f[B]--width\f[R] \f[I]N\f[R]
Set initial window width to \f[I]N\f[R] pixels.
.SS Control options:
.PP
These options are used to control the currently running Lagrange
instance via the command line.
.TP
\f[B]--close-tab\f[R]
Close the current tab.
.TP
\f[B]-L\f[R], \f[B]--list-tab-urls\f[R]
Print the URLs of open tabs to stdout.
If the app isn\[cq]t running, nothing is printed.
.TP
\f[B]--new-tab\f[R] [\f[I]URL\f[R]]
Open a new tab.
If the URL argument is omitted, the user\[cq]s homepage is opened.
.TP
\f[B]--tab-url\f[R]
Print the URL of the active tab.
.SH ENVIRONMENT
.TP
\f[B]\f[CB]LAGRANGE_OVERRIDE_DPI\f[B]\f[R]
Override the autodetected screen DPI with a user-provided value.
Some window systems and/or monitors may not provide an appropriate DPI
value, so this enables further tuning the UI scaling in addition to the
\[lq]UI scale factor\[rq] found in Preferences.
.SH FILES
.PP
User-specific files such as bookmarks and navigation history are stored
in the following operating system dependent locations:
.IP \[bu] 2
Windows:
\[lq]C:\[rs]Users\[rs]Name\[rs]AppData\[rs]Roaming\[rs]fi.skyjake.Lagrange\[rq]
.IP \[bu] 2
macOS: \[lq]\[ti]/Library/Application Support/fi.skyjake.Lagrange\[rq]
.IP \[bu] 2
Other: \[lq]\[ti]/.config/lagrange\[rq]
.PP
The directory contains:
.TP
\f[B]bindings.txt\f[R]
Customized key bindings.
.TP
\f[B]bookmarks.ini\f[R]
Bookmarks in TOML format.
.TP
\f[B]feeds.txt\f[R]
State of subscribed feeds: all the known entries and latest update
timestamps.
.TP
\f[B]fonts.ini\f[R]
Custom fonts to load at launch.
.TP
\f[B]idents.lgr\f[R]
Information about identities.
.TP
\f[B]idents/\f[R]
Subdirectory containing client certificates and private keys in PEM
format.
.TP
\f[B]modmap.txt\f[R]
Customized keyboard modifier mapping.
.TP
\f[B]mimehooks.txt\f[R]
Configuration of external programs to filter page contents depending on
MIME type.
.TP
\f[B]palette.txt\f[R]
Colors of the UI palette.
.TP
\f[B]prefs.cfg\f[R]
User\[cq]s preferences.
This is a list of UI events that gets executed at launch (cf.\ output of
\f[B]--echo\f[R]).
.TP
\f[B]state.lgr\f[R]
Serialized UI state, specifying open tabs and sidebar state.
.TP
\f[B]sitespec.ini\f[R]
Site-specific preferences in TOML format.
.TP
\f[B]trusted.2.txt\f[R]
Fingerprints of trusted server certificates.
.TP
\f[B]visited.2.txt\f[R]
List of visited URLs with timestamps.
.SH STANDARDS
.IP \[bu] 2
Gemini Protocol
Specification (https://gemini.circumlunar.space/docs/specification.gmi)
.IP \[bu] 2
Gempub Specification (https://codeberg.org/oppenlab/gempub)
.IP \[bu] 2
RFC 1436: The Internet Gopher
Protocol (https://datatracker.ietf.org/doc/html/rfc1436)
.IP \[bu] 2
RFC 1288: The Finger User Information
Protocol (https://datatracker.ietf.org/doc/html/rfc1288)
.SH SEE ALSO
.PP
Open \[lq]about:help\[rq] in the application to view the complete Help
page.
.SH AUTHORS
Jaakko Ker\[:a]nen (jaakko.keranen\[at]iki.fi).