summaryrefslogtreecommitdiff
path: root/res
diff options
context:
space:
mode:
authorJaakko Keränen <jaakko.keranen@iki.fi>2021-04-17 14:39:41 +0300
committerJaakko Keränen <jaakko.keranen@iki.fi>2021-04-17 14:39:41 +0300
commit8e25a8fa343c4634d859917b670b3a7ed395838f (patch)
tree2141890110b374e77f07b1b2527b1eacbe4fda28 /res
parent4b63d7afe9f009601667c6fc01c7d8ef092b8881 (diff)
Updated Help
Diffstat (limited to 'res')
-rw-r--r--res/about/help.gmi106
-rw-r--r--res/about/version.gmi1
2 files changed, 97 insertions, 10 deletions
diff --git a/res/about/help.gmi b/res/about/help.gmi
index 30295512..c710afc9 100644
--- a/res/about/help.gmi
+++ b/res/about/help.gmi
@@ -335,12 +335,18 @@ URLs on the command line are opened after Lagrange has launched. If more than on
335$ lagrange gemini://gus.guru/ 335$ lagrange gemini://gus.guru/
336``` 336```
337 337
338### --echo 338### -E, --echo
339Debugging utility: internal events are printed to stdout. 339Debugging utility: internal events are printed to stdout.
340 340
341### --help
342Print a list of all the available options.
343
341### --sw 344### --sw
342Disable hardware accelerated graphics. Note that software rendering is anyway used as a fallback, so usually this option should not be necessary. 345Disable hardware accelerated graphics. Note that software rendering is anyway used as a fallback, so usually this option should not be necessary.
343 346
347### -V, --version
348Print the application version.
349
344## 3.2 Opening Gemini links 350## 3.2 Opening Gemini links
345 351
346On macOS and Windows, Lagrange registers itself as a "gemini:" URL scheme handler, so you can click on Gemini links in any application to open Lagrange with that URL. 352On macOS and Windows, Lagrange registers itself as a "gemini:" URL scheme handler, so you can click on Gemini links in any application to open Lagrange with that URL.
@@ -361,15 +367,95 @@ Lagrange stores user-specific persistent files in one of the following locations
361Other Unix : ~/.config/lagrange/ 367Other Unix : ~/.config/lagrange/
362``` 368```
363 369
364* bindings.txt 370### bindings.txt
365* bookmarks.txt 371Each line specifies one keybinding:
366* feeds.txt 372> {binding-id} {keycode} {flags}
367* idents.lgr and idents/ 373* Binding IDs are defined in src/ui/keys.c.
368* mimehooks.txt 374* Keycode is one of the SDLK constants from SDL (hexadecimal).
369* prefs.cfg 375* Flags specifies the modifier keys:
370* state.lgr 376```Table of modifier key flags
371* trusted.txt 377s : Shift
372* visited.2.txt 378a : Alt
379c : Ctrl
380g : Gui (Windows/Command/Meta key)
381k : Caps Lock
382```
383
384### bookmarks.txt
385Each bookmark is stored as three consecutive lines:
386> {icon} {creation-timestamp} {url}
387> {title}
388> {tags}
389* The icon is one UTF-32 codepoint as a hexadecimal number, prefixed with zeroes to be always eight bytes long.
390* Creation time is stored as a UNIX timestamp.
391* URL, title, and tags are UTF-8 text strings terminated at the newline.
392
393### feeds.txt
394Cached state of feed subscriptions. The file may be deleted while the application is not running to force a reset of feed contents. Subscriptions themselves are tracked via bookmark tags so deleting the file does not affect which pages are subscribed.
395
396The file has three sections. The first one is simply a UNIX timestamp indicating when feeds were last refreshed. The second section begins after the comment:
397```
398# Feeds
399```
400In this section, each line identifies a subscription so it can be referenced in the feed entries:
401> {feed-id} {feed-url}
402* The feed ID a hexadecimal number and always eight characters long.
403
404The third section contains all the discovered feed entries. It begins after the comment:
405```
406# Entries
407```
408Each feed entry consists of five consecutive lines:
409> {feed-id}
410> {posted-time}
411> {discovery-time}
412> {url}
413> {title}
414* The feed ID is one of the identifiers from the Feeds section (without zeroes for padding).
415* The posted time is a UNIX timestamp that specifies when the entry was posted. This is determined from the "YYYY-MM-DD" date found on the link line. If this is a "new headings" subscription, the posted time and the discovery time are the same.
416* The discovery time is a UNIX timestamp that marks when the entry was added to the cache.
417
418### idents.lgr and idents/
419idents.lgr is a binary file that contains metadata about the client certificates known to the application, for example on which URLs a particular certificate should be active.
420
421The "idents" subdirectory is where the actual client certificates are stored. Each certificate comprises a .crt and a .key file in PEM format. Certificates generated inside the application use the certificate fingerprint as the file name.
422
423### modmap.txt
424Translation table for keyboard modifiers. For example, one could swap the Alt and Ctrl keys by changing their mappings. See the comment in the file that explains the format and usage.
425
426### mimehooks.txt
427See section 4.
428
429### prefs.cfg
430Persistent configuration variables. The file is rewritten when the application is closed. Each line is interpreted as an internal UI event like those printed with the --echo command line option.
431
432### state.lgr
433A binary file that contains the current state of the application: open tabs and their scroll positions, and navigation history with cached page content (up to the configured cache limit). You may delete this file when the application is not running to close all tabs and clear the page content cache.
434
435### trusted.txt
436Trusted server certificates. Each line specifies the certificate fingerprint of one domain:
437> {domain} {valid-until} {fingerprint}
438* Domain names are stored in punycode format if they contain non-ASCII characters.
439* The "valid until" expiration date is a UNIX timestamp.
440
441### visited.2.txt
442The combined navigation history of all tabs. Each line specifies one URL:
443> {last-visited} {flags} {url}
444* The last visited time is stored as a UNIX timestamp.
445* Flags is always four bytes long:
446```
4470000 : No flags set
4480001 : Transient
449```
450The Transient flag is used to indicate redirections and for marking feed entries as read without actually visiting the URL. URLs with the Transient flag do not appear in the History sidebar tab.
451
452## 3.5 Environment variables
453
454### LAGRANGE_OVERRIDE_DPI
455Override display DPI detection with a user-provided value. The same value is applied to all displays. This is useful if your display's DPI value is not being detected correctly. Example:
456```96 is the default DPI value
457LAGRANGE_OVERRIDE_DPI=96
458```
373 459
374# 4 MIME hooks 460# 4 MIME hooks
375 461
diff --git a/res/about/version.gmi b/res/about/version.gmi
index 55c84ccd..f52e77d7 100644
--- a/res/about/version.gmi
+++ b/res/about/version.gmi
@@ -11,6 +11,7 @@
11* Preferences: Reorganized the fonts dropdown menu. 11* Preferences: Reorganized the fonts dropdown menu.
12* Updated the UI font to Source Sans 3. It now has all the styles and weights needed for page rendering, too. 12* Updated the UI font to Source Sans 3. It now has all the styles and weights needed for page rendering, too.
13* Added a semibold Fira Sans weight (used for links). 13* Added a semibold Fira Sans weight (used for links).
14* Navigation arrow buttons are disabled at end/beginning of history.
14* Fixed allocation of page rendering buffers. Previously, some buffers may have gone unused or were allocated erroneously to the same position, causing unnecessary work for the page renderer. 15* Fixed allocation of page rendering buffers. Previously, some buffers may have gone unused or were allocated erroneously to the same position, causing unnecessary work for the page renderer.
15* Fixed a possible crash when closing a tab. 16* Fixed a possible crash when closing a tab.
16 17