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