summaryrefslogtreecommitdiff
path: root/res/about
diff options
context:
space:
mode:
Diffstat (limited to 'res/about')
-rw-r--r--res/about/help.gmi31
1 files changed, 23 insertions, 8 deletions
diff --git a/res/about/help.gmi b/res/about/help.gmi
index 1fa1e07e..90ffc8b1 100644
--- a/res/about/help.gmi
+++ b/res/about/help.gmi
@@ -24,6 +24,7 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a
24* Sidebar for page outline, managing bookmarks and identities, and viewing history 24* Sidebar for page outline, managing bookmarks and identities, and viewing history
25* Multiple tabs 25* Multiple tabs
26* Identity management — create and use TLS client certificates 26* Identity management — create and use TLS client certificates
27* Subscribe to Gemini feeds
27* Light and dark color themes 28* Light and dark color themes
28* Select and copy text with the mouse 29* Select and copy text with the mouse
29* Find text on the page 30* Find text on the page
@@ -44,7 +45,7 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a
44Gemini is a simple protocol for serving content over the internet. It specifies a Markdown inspired format allowing basic plain text document markup. Compared to HTTP and HTML, Gemini is vastly simpler and easier to work with. 45Gemini is a simple protocol for serving content over the internet. It specifies a Markdown inspired format allowing basic plain text document markup. Compared to HTTP and HTML, Gemini is vastly simpler and easier to work with.
45 46
46=> gemini://gemini.circumlunar.space/docs/faq.gmi Project Gemini FAQ 47=> gemini://gemini.circumlunar.space/docs/faq.gmi Project Gemini FAQ
47=> gemini://gemini.circumlunar.space/docs/specification.gmi Protocol and text/gemini specification 48=> gemini://gemini.circumlunar.space/docs/specification.gmi Protocol and 'text/gemini' specification
48 49
49## Why not just use a web browser 50## Why not just use a web browser
50 51
@@ -65,7 +66,7 @@ Lagrange's user interface is modeled after web browsers:
65* There is a sidebar for managing bookmarks and TLS identities, and viewing history and the page outline. The sidebar is hidden by default. 66* There is a sidebar for managing bookmarks and TLS identities, and viewing history and the page outline. The sidebar is hidden by default.
66* There is a search bar that appears at the bottom when searching text on the page. 67* There is a search bar that appears at the bottom when searching text on the page.
67 68
68Tip: Try pressing ${CTRL+}4 now to see the page outline. 69Tip: Try pressing ${CTRL+}5 now to see the page outline.
69 70
70The user interface has been designed for both mouse and keyboard based use. When using a mouse the most commonly needed features are available via context menus, for example by right-clicking on the currently open page. Keyboard shortcuts on the other hand can provide a very quick and fluid user experience. For example, to open the "CAPCOM" bookmark, one might use the following keyboard shortcuts: 71The user interface has been designed for both mouse and keyboard based use. When using a mouse the most commonly needed features are available via context menus, for example by right-clicking on the currently open page. Keyboard shortcuts on the other hand can provide a very quick and fluid user experience. For example, to open the "CAPCOM" bookmark, one might use the following keyboard shortcuts:
71 72
@@ -113,7 +114,7 @@ Right-clicking on a link shows a link-specific context menu. From there, you can
113 114
114### Opening links using the keyboard 115### Opening links using the keyboard
115 116
116Lagrange has two modes for navigating links with the keyboard. The first uses a modifier key (${ALT} by default): while the modifier is pressed, alphanumeric shortcuts are shown for each visible link in the window. You can then press the corresponding key, still holding the modifier, to open a link. The second mode is based on letters only and focuses on the home row keys. You press and release the activation key ("F" by default) to show the link shortcut letters. In this mode the shortcuts are not in alphabetic order, but instead roughly sorted based on proximity to the F and J keys. You may find this easier to use since it is a simple sequence of key presses without using modifiers, allowing one to keep fingers on or near the home row. 117Lagrange has two modes for navigating links with the keyboard. The first uses a modifier key (${ALT} by default): while the modifier is pressed, alphanumeric shortcuts are shown for each visible link in the window. You can then press the corresponding key, still holding the modifier, to open a link. The second mode is based on letters only and focuses on the page row keys. You press and release the activation key ("F" by default) to show the link shortcut letters. In this mode the shortcuts are not in alphabetic order, but instead roughly sorted based on proximity to the F and J keys. You may find this easier to use since it is a simple sequence of key presses without using modifiers, allowing one to keep fingers on or near the home row.
117 118
118You can give it a try now with the link below. Either hold down ${ALT}, or press and release F. 119You can give it a try now with the link below. Either hold down ${ALT}, or press and release F.
119 120
@@ -127,14 +128,15 @@ The set of open tabs is restored when you launch Lagrange.
127 128
128## Sidebar 129## Sidebar
129 130
130The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has four tabs: 131The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has five tabs:
131 132
132* Bookmarks: List of bookmarks that you've created. These appear first in search results for quick and easy access. 133* Bookmarks: List of bookmarks that you've created. These appear first in search results for quick and easy access.
134* Feeds: Entries found on subscribed feed index pages.
133* 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. 135* 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.
134* Identities: TLS client certificates. 136* Identities: TLS client certificates.
135* Outline: List of the headings in the currently open tab. Useful when reading longer documents. 137* Outline: List of the headings in the currently open tab. Useful when reading longer documents.
136 138
137${CTRL+}1 through ${CTRL+}4 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed. You can also press Escape to dismiss the sidebar. 139${CTRL+}1 through ${CTRL+}5 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed. You can also press Escape to dismiss the sidebar.
138 140
139## Bookmarks 141## Bookmarks
140 142
@@ -146,13 +148,22 @@ In addition to a title, bookmarks can have tags. Some tags have a special meanin
146 148
147### Special tags 149### Special tags
148 150
149* Set a "homepage" tag on a bookmark to make it one of the pages that will be opened when pressing the 🏠 button. 151* Set a "homepage" tag on a bookmark to make it one of the pages that will be opened when pressing the 🏠 button. If multiple bookmarks are tagged as homepages, a random one is selected.
152* A "subscribed" tag means that Lagrange will periodically fetch the bookmarked page and look for Gemini feed links. All the found links that match the required style ("YYYY-MM-DD Entry title") will appear in the Feeds sidebar tab.
153
154## Feeds
155
156A Gemini feed is simply a regular 'text/gemini' page that contains one or more links whose labels are formatted in a particular way.
157
158=> gemini://gemini.circumlunar.space/docs/companion/subscription.gmi See "Subscribing to Gemini pages" for more information.
159
160Subscriptions are managed via bookmarks. When you subscribe to a feed page, a bookmark is created and the special "subscribed" tag is applied on it. In the Bookmarks list, this is indicated by a ★ icon. There is no other difference between normal bookmarks and feed subscriptions — you may tag any bookmark as "subscribed" and Lagrange will look through it for feed-style links.
150 161
151## Identities (client certificates) 162## Identities (client certificates)
152 163
153Gemini uses TLS client certificates for user/session identification purposes. Unlike on the web where user identity tracking is covert and automatic, client certificates must be manually taken into use, and you are able to define how long each certificate remains valid. The term "Identity" is used in Lagrange to refer to client certificates. 164Gemini uses TLS client certificates for user/session identification purposes. Unlike on the web where user identity tracking is covert and automatic, client certificates must be manually taken into use, and you are able to define how long each certificate remains valid. The term "Identity" is used in Lagrange to refer to client certificates.
154 165
155The Identities sidebar tab shows all identities known to Lagrange. Press ${CTRL+}3 to show it. This includes identities created in Lagrange and any identities based on imported X.509 certificates. 166The Identities sidebar tab shows all identities known to Lagrange. Press ${CTRL+}4 to show it. This includes identities created in Lagrange and any identities based on imported X.509 certificates.
156 167
157### Creating a new identity 168### Creating a new identity
158 169
@@ -197,7 +208,7 @@ You can find a number of settings in Preferences to customize the user interface
197 208
198The "Outline on scrollbar" option shows the page outline when the mouse cursor is moved over the scrollbar, allowing one to better navigate long documents. The outline will disappear after the mouse cursor is moved away. If you need a persistent outline, one is always available in the sidebar. 209The "Outline on scrollbar" option shows the page outline when the mouse cursor is moved over the scrollbar, allowing one to better navigate long documents. The outline will disappear after the mouse cursor is moved away. If you need a persistent outline, one is always available in the sidebar.
199 210
200One important characteristic of Gemini is that you remain in control of what gets loaded and when. The browser will not suddenly fetch a ton of images, autoplay videos, or make surreptitious connections to any tracking servers — each network request is purposeful and manually triggered. The "Load image on scroll" option is provided to assist keyboard-only browsing and to facilitate a focused reading experience. When enabled, if there is an image link visible on the page and you press Space or ↓, it will be loaded and shown inline _instead_ of the view scrolling down. This allows you to read and see all the content of the page while only tapping on a single key on the keyboard. 211One important characteristic of Gemini is that you remain in control of what gets loaded and when. The browser will not suddenly fetch a ton of images, autoplay videos, or make surreptitious connections to any tracking servers — each network request is purposeful and manually triggered. With this in mind, the "Load image on scroll" option is provided to assist keyboard-only browsing and to facilitate a focused reading experience. When enabled, if there is an image link visible on the page and you press Space or ↓, it will be loaded and shown inline _instead_ of the view scrolling down. This allows you to read and see all the content of the page while only tapping on a single key on the keyboard.
201 212
202### Window and UI options 213### Window and UI options
203 214
@@ -247,6 +258,10 @@ Other style options:
247 258
248### Proxies 259### Proxies
249 260
261Gemini allows relaying requests via a proxy server. On the "Proxies" tab, you can configure proxy servers for Gemini, Gopher, and HTTP/HTTPS requests.
262
263When an HTTP proxy server is configured, HTTP/HTTPS links will no longer open in the system's default web browser but will be loaded via the proxy, expecting it to serve a 'text/gemini' version of the link contents.
264
250### Keybindings 265### Keybindings
251 266
252The "Keys" tab lets you change which keys are bound to UI commands. Click on an item with the mouse and then press the new key combination that you want bound to it. Right-click on a binding to erase it or reset it to the default. 267The "Keys" tab lets you change which keys are bound to UI commands. Click on an item with the mouse and then press the new key combination that you want bound to it. Right-click on a binding to erase it or reset it to the default.