Added a man page

Generated with Pandoc.

3 files changed, 279 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 @@
+.\" 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).
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 @@
+% LAGRANGE(1)
+% Jaakko Keränen (jaakko.keranen@iki.fi)
+% January 2022
+
+# NAME
+
+lagrange - a beautiful Gemini client
+
+# SYNOPSIS
+
+**lagrange** \[options\]\ \[_URL_\]...\ \[_FILE_\]...
+
+# DESCRIPTION
+
+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.
+
+# OPTIONS
+
+When multiple URLs and/or local files are specified, they are opened in separate tabs.
+
+**-E**, **\--echo**
+:   Print all internal application events to stdout. Useful for debugging.
+
+**\--help**
+:   List the available command line options.
+
+**-u**, **\--url-or-search** _URL_ | _TEXT_
+:   Open a URL, or make a search query with given text. This only works if the search query URL has been configured.
+
+**-V**, **\--version**
+:   Output the version number.
+
+## Window options:
+
+**-h**, **\--height** _N_
+:   Set initial window height to _N_ pixels.
+
+**\--sw**
+:   Disable hardware-accelerated rendering.
+
+**-w**, **\--width** _N_
+:   Set initial window width to _N_ pixels.
+
+## Control options:
+
+These options are used to control the currently running Lagrange instance via the command line.
+
+**\--close-tab**
+:   Close the current tab.
+
+**-L**, **\--list-tab-urls**
+:   Print the URLs of open tabs to stdout. If the app isn't running, nothing is printed.
+
+**\--new-tab** [_URL_]
+:   Open a new tab. If the URL argument is omitted, the user's homepage is opened.
+
+**\--tab-url**
+:   Print the URL of the active tab.
+
+# ENVIRONMENT
+
+`LAGRANGE_OVERRIDE_DPI`
+:   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.
+
+# FILES
+
+User-specific files such as bookmarks and navigation history are stored in the following operating system dependent locations:
+
+- Windows: "C:\\Users\\Name\\AppData\\Roaming\\fi.skyjake.Lagrange"
+- macOS: "~/Library/Application Support/fi.skyjake.Lagrange"
+- Other: "~/.config/lagrange" 
+
+The directory contains:
+
+**bindings.txt**
+:   Customized key bindings.
+
+**bookmarks.ini**
+:   Bookmarks in TOML format.
+
+**feeds.txt**
+:   State of subscribed feeds: all the known entries and latest update timestamps.
+
+**fonts.ini**
+:   Custom fonts to load at launch.
+
+**idents.lgr**
+:   Information about identities.
+
+**idents/**
+:   Subdirectory containing client certificates and private keys in PEM format.
+
+**modmap.txt**
+:   Customized keyboard modifier mapping.
+
+**mimehooks.txt**
+:   Configuration of external programs to filter page contents depending on MIME type.
+
+**palette.txt**
+:   Colors of the UI palette.
+
+**prefs.cfg**
+:   User's preferences. This is a list of UI events that gets executed at launch (cf. output of **\--echo**).
+
+**state.lgr**
+:   Serialized UI state, specifying open tabs and sidebar state.
+
+**sitespec.ini**
+:   Site-specific preferences in TOML format.
+
+**trusted.2.txt**
+:   Fingerprints of trusted server certificates.
+
+**visited.2.txt**
+:   List of visited URLs with timestamps.
+
+# STANDARDS
+
+* [Gemini Protocol Specification](https://gemini.circumlunar.space/docs/specification.gmi)
+* [Gempub Specification](https://codeberg.org/oppenlab/gempub)
+* [RFC 1436: The Internet Gopher Protocol](https://datatracker.ietf.org/doc/html/rfc1436)
+* [RFC 1288: The Finger User Information Protocol](https://datatracker.ietf.org/doc/html/rfc1288)
+
+# SEE ALSO
+
+Open "about:help" in the application to view the complete Help page.
\ No newline at end of file
diff --git a/res/makeman.sh b/res/makeman.sh
new file mode 100755
index 00000000..510c4cf6
--- /dev/null
+++ b/res/makeman.sh
@@ -0,0 +1,3 @@
+#!/bin/sh
+pandoc lagrange.1.md -s -t man > lagrange.1
+