summaryrefslogtreecommitdiff
path: root/res/about/help.gmi
diff options
context:
space:
mode:
authorJaakko KerΓ€nen <jaakko.keranen@iki.fi>2020-09-26 18:00:59 +0300
committerJaakko KerΓ€nen <jaakko.keranen@iki.fi>2020-09-26 18:00:59 +0300
commit5965f2158c7f5331a330a3618e22afc044961a56 (patch)
tree7d99351a1447d04a80f7da2d5162f7222cf133f4 /res/about/help.gmi
parent3f97efb0d5ed327be564b02194e82b612ac886f9 (diff)
Updated Help
Diffstat (limited to 'res/about/help.gmi')
-rw-r--r--res/about/help.gmi112
1 files changed, 74 insertions, 38 deletions
diff --git a/res/about/help.gmi b/res/about/help.gmi
index 1059dd68..540ca8aa 100644
--- a/res/about/help.gmi
+++ b/res/about/help.gmi
@@ -56,13 +56,15 @@ One way to browse Gemini content is via web browser extensions or proxies that t
56 56
57Lagrange's user interface is modeled after web browsers: 57Lagrange's user interface is modeled after web browsers:
58* There is a navigation bar at the top with Back and Forward buttons. 58* There is a navigation bar at the top with Back and Forward buttons.
59* Below the navigation bar, there is a tab bar for switching between open tabs. The tab bar is hidden if there is only one tab open. 59* There is a tab bar for switching tabs. The tab bar is hidden if there is only one tab open.
60* There is a sidebar for managing bookmarks and TLS identities, and viewing history and the page outline. The sidebar is hidden by default. 60* There is a sidebar for managing bookmarks and TLS identities, and viewing history and the page outline. The sidebar is hidden by default.
61* There is a search bar that appears at the bottom when searching text on the page. 61* There is a search bar that appears at the bottom when searching text on the page.
62 62
63Tip: Try pressing ${CTRL+}4 now to see the page outline. 63Tip: Try pressing ${CTRL+}4 now to see the page outline.
64 64
65## URL entry and quick search 65## Navigation
66
67### URL entry and quick search
66 68
67The URL input field is in its typical location in the navigation bar. It can be accessed quickly by pressing ${CTRL+}L. 69The URL input field is in its typical location in the navigation bar. It can be accessed quickly by pressing ${CTRL+}L.
68 70
@@ -72,35 +74,28 @@ Search within cached pages is limited to the (small) set of pages that Lagrange
72 74
73Note that the navigation stack is saved to a file when Lagrange is shut down and restored on the next launch. This means the next time you launch Lagrange, you can still search the contents of past pages. However, navigation stacks are tab-specific, so closing a tab will delete its history as well. 75Note that the navigation stack is saved to a file when Lagrange is shut down and restored on the next launch. This means the next time you launch Lagrange, you can still search the contents of past pages. However, navigation stacks are tab-specific, so closing a tab will delete its history as well.
74 76
75## Tabs 77### Links
76
77Press ${CTRL+}T to open a new tab, and ${CTRL+}W to close the current tab. Right-clicking on buttons in the tab bar shows a context menu for additional tab-related functions.
78
79The set of open tabs is restored when you launch Lagrange.
80 78
81## Sidebar 79The type and destination of a link are indicated by the link's icon and color: ➀ links to the same domain, and 🌐 to a different domain. The colors are:
82
83The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has four tabs:
84 80
85* Bookmarks: List of bookmarks that you've created. These appear first in search results for quick and easy access. 81* Blue for Gemini
86* History: Chronological list of visited URLs. This is not a full history of all the URLs you've accessed over time β€” only unique URLs are shown at the latest access time. 82* Purple for Gopher
87* Identities: TLS client certificates. 83* Orange for HTTP(S)
88* Outline: List of the headings in the currently open tab. Useful when reading longer documents. 84* Red for other (cannot be opened)
89 85
90${CTRL+}1 through ${CTRL+}4 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed. 86When you move the mouse over a link, additional information about it will appear: the destination domain, with the URL scheme shown for non-Gemini links, and the date of the last visit to the URL.
91 87
92## Navigation 88### Note about caching
93 89
94When navigating to a new page, the old page is cached in memory. If you navigate back, the cached copy of the page is restored. Think of it as rewinding time β€” you return to a past time as if nothing had happened. The same applies to forward navigation; cached pages are loaded if available. This allows back and forward navigation to happen instantly, without any network requests. 90When navigating to a new page, the old page is cached in memory. If you navigate back, the cached copy of the page is restored. Think of it as rewinding time β€” you return to a past time as if nothing had happened. The same applies to forward navigation; cached pages are loaded if available. This allows back and forward navigation to happen instantly, without any network requests.
95 91
96### Link icons 92The page cache is saved to a file when Lagrange is shut down so it can be restored on the next launch.
97 93
98The type and destination of a link are indicated by the link's icon and color: ➀ links to the same domain, and 🌐 to a different domain. The colors are: 94### Opening links in a new tab
99 95
100* Blue for Gemini 96Holding down ${CTRL} when clicking on a link causes it to open in a new tab.
101* Purple for Gopher 97
102* Orange for HTTP(S) 98Right-clicking on a link shows a link-specific context menu. From there, you can also open the link in a new background tab, which will keep the current tab open.
103* Red for other (cannot be opened)
104 99
105### Opening links using the keyboard 100### Opening links using the keyboard
106 101
@@ -110,13 +105,22 @@ When navigating via keyboard, hold down ${ALT} to see link shortcut keys. Try do
110 105
111Each visible link on the page gets an alphanumeric shortcut. For example, the first link can be opened by pressing ${ALT+}1. The tenth link is ${ALT+}A. Additionally hold down ${CTRL} to open the link in a new tab. 106Each visible link on the page gets an alphanumeric shortcut. For example, the first link can be opened by pressing ${ALT+}1. The tenth link is ${ALT+}A. Additionally hold down ${CTRL} to open the link in a new tab.
112 107
113## Downloads 108## Tabs
114 109
115Press ${CTRL+}S to save the contents of the current page to the Downloads folder. This works on all pages regardless of whether Lagrange can display the contents or not. 110Press ${CTRL+}T to open a new tab, and ${CTRL+}W to close the current tab. Right-clicking on buttons in the tab bar shows a context menu for additional tab-related functions.
116 111
117The location where downloaded files are saved can be set in Preferences. 112The set of open tabs is restored when you launch Lagrange.
118 113
119The πŸ”ƒ button on the right side of the URL input field is the Reload/Stop button β€” it reloads the current page or stops an ongoing download. During large downloads, an additional progress indicator appears next to the Stop button. 114## Sidebar
115
116The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has four tabs:
117
118* Bookmarks: List of bookmarks that you've created. These appear first in search results for quick and easy access.
119* History: Chronological list of visited URLs. This is not a full history of all the URLs you've accessed over time β€” only unique URLs are shown at the latest access time.
120* Identities: TLS client certificates.
121* Outline: List of the headings in the currently open tab. Useful when reading longer documents.
122
123${CTRL+}1 through ${CTRL+}4 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed.
120 124
121## Bookmarks 125## Bookmarks
122 126
@@ -128,7 +132,7 @@ In addition to a title, bookmarks can have tags. Some tags have a special meanin
128 132
129* Set a "homepage" tag on a bookmark to make it one of the pages that will be opened when pressing the 🏠 button. 133* Set a "homepage" tag on a bookmark to make it one of the pages that will be opened when pressing the 🏠 button.
130 134
131## Identities (TLS client certificates) 135## Identities (client certificates)
132 136
133Gemini uses TLS client certificates for manual user/session identification purposes. This is analogous to logging into a web site, except you are in full control of the information. The term "Identity" is used in Lagrange to refer to client certificates. 137Gemini uses TLS client certificates for manual user/session identification purposes. This is analogous to logging into a web site, except you are in full control of the information. The term "Identity" is used in Lagrange to refer to client certificates.
134 138
@@ -142,9 +146,9 @@ Consider any information you enter in the certificate as public; only the Common
142 146
143### Using an identity 147### Using an identity
144 148
145You'll need to select an identity when you encounter this error message: 149You will need to select an identity when you encounter this error message:
146 150
147... 151> πŸ”‘ Certificate Required
148 152
149Clicking on an identity in the sidebar will toggle it on/off for the currently open URL. On subsequent page loads, the certificate will then be sent to the server when the URL or any URL under it is fetched. You can click on the πŸ‘€ button in the navigation bar to see which identity is being used for the current page. 153Clicking on an identity in the sidebar will toggle it on/off for the currently open URL. On subsequent page loads, the certificate will then be sent to the server when the URL or any URL under it is fetched. You can click on the πŸ‘€ button in the navigation bar to see which identity is being used for the current page.
150 154
@@ -155,9 +159,49 @@ At launch, Lagrange looks through its "idents" directory to see if any new certi
155* mycert.key 159* mycert.key
156Lagrange will add a note to the imported identities to mark them as "Imported". 160Lagrange will add a note to the imported identities to mark them as "Imported".
157 161
162## Downloads
163
164Press ${CTRL+}S to save the contents of the current page to the Downloads folder. This works on all pages regardless of whether Lagrange can display the contents or not.
165
166The location where downloaded files are saved can be set in Preferences.
167
168The πŸ”ƒ button on the right side of the URL input field is the Reload/Stop button β€” it reloads the current page or stops an ongoing download. During large downloads, an additional progress indicator appears next to the Stop button.
169
170## Customization
171
172You can find a number of settings in Preferences to customize what the user interface and page contents look like.
173
174### Window color theme
175
176...
177
178### Page style
179
180* Font: At the moment, two font options are provided. "Nunito" is a friendly rounded font with generous leading. "Fira Sans" is more angular and narrow, and has a tighter leading.
181* Line width: This setting determines the maximum width for text lines. "Window" disables the maximum limit and fits text lines to the full width of the window. Shorter lines are generally easier to read.
182* Big 1st paragraph: When enabled, the leading paragraph on the page is shown in a slightly larger font.
183
184Options for wide window layouts:
185
186* Site icon: If there is room on the left side of the page text, the site icon appears there along with the top level heading. This allows one to keep better track of the current reading position in long documents.
187
158# OS integration 188# OS integration
159 189
160## Opening Gemini URLs (macOS) 190## Command line options
191
192### URLs
193URLs on the command line are opened after Lagrange has launched. If more than one URL is given, multiple tabs will be opened. For example:
194```
195$ lagrange gemini://gus.guru/
196```
197
198### --echo
199Debugging utility: internal events are printed to stdout.
200
201### --sw
202Disable hardware accelerated graphics. Note that software rendering is anyway used as a fallback, so usually this option should not be necessary.
203
204## Handling Gemini URLs (macOS)
161 205
162Lagrange registers itself as a "gemini:" URL scheme handler, so you can click on Gemini links in any application to open Lagrange with that URL. 206Lagrange registers itself as a "gemini:" URL scheme handler, so you can click on Gemini links in any application to open Lagrange with that URL.
163 207
@@ -184,13 +228,5 @@ Other Unix : ~/.config/lagrange/
184* trusted.txt 228* trusted.txt
185* visited.txt 229* visited.txt
186 230
187## Command line options
188
189### --echo
190Debugging utility: internal events are printed to stdout.
191
192### --sw
193Disable hardware accelerated graphics. Note that software rendering is anyway used as a fallback, so usually this option should not be necessary.
194
195# Open source licenses 231# Open source licenses
196=> about:license 232=> about:license