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