From 5965f2158c7f5331a330a3618e22afc044961a56 Mon Sep 17 00:00:00 2001 From: Jaakko KerΓ€nen Date: Sat, 26 Sep 2020 18:00:59 +0300 Subject: Updated Help --- res/about/help.gmi | 112 +++++++++++++++++++++++++++++++++++------------------ 1 file changed, 74 insertions(+), 38 deletions(-) (limited to 'res') 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 Lagrange's user interface is modeled after web browsers: * There is a navigation bar at the top with Back and Forward buttons. -* 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. +* There is a tab bar for switching tabs. The tab bar is hidden if there is only one tab open. * There is a sidebar for managing bookmarks and TLS identities, and viewing history and the page outline. The sidebar is hidden by default. * There is a search bar that appears at the bottom when searching text on the page. Tip: Try pressing ${CTRL+}4 now to see the page outline. -## URL entry and quick search +## Navigation + +### URL entry and quick search The URL input field is in its typical location in the navigation bar. It can be accessed quickly by pressing ${CTRL+}L. @@ -72,35 +74,28 @@ Search within cached pages is limited to the (small) set of pages that Lagrange Note 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. -## Tabs - -Press ${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. - -The set of open tabs is restored when you launch Lagrange. +### Links -## Sidebar - -The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has four tabs: +The 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: -* Bookmarks: List of bookmarks that you've created. These appear first in search results for quick and easy access. -* 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. -* Identities: TLS client certificates. -* Outline: List of the headings in the currently open tab. Useful when reading longer documents. +* Blue for Gemini +* Purple for Gopher +* Orange for HTTP(S) +* Red for other (cannot be opened) -${CTRL+}1 through ${CTRL+}4 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed. +When 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. -## Navigation +### Note about caching When 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. -### Link icons +The page cache is saved to a file when Lagrange is shut down so it can be restored on the next launch. -The 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: +### Opening links in a new tab -* Blue for Gemini -* Purple for Gopher -* Orange for HTTP(S) -* Red for other (cannot be opened) +Holding down ${CTRL} when clicking on a link causes it to open in a new tab. + +Right-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. ### Opening links using the keyboard @@ -110,13 +105,22 @@ When navigating via keyboard, hold down ${ALT} to see link shortcut keys. Try do Each 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. -## Downloads +## Tabs -Press ${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. +Press ${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. -The location where downloaded files are saved can be set in Preferences. +The set of open tabs is restored when you launch Lagrange. -The πŸ”ƒ 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. +## Sidebar + +The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has four tabs: + +* Bookmarks: List of bookmarks that you've created. These appear first in search results for quick and easy access. +* 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. +* Identities: TLS client certificates. +* Outline: List of the headings in the currently open tab. Useful when reading longer documents. + +${CTRL+}1 through ${CTRL+}4 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed. ## Bookmarks @@ -128,7 +132,7 @@ In addition to a title, bookmarks can have tags. Some tags have a special meanin * Set a "homepage" tag on a bookmark to make it one of the pages that will be opened when pressing the 🏠 button. -## Identities (TLS client certificates) +## Identities (client certificates) Gemini 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. @@ -142,9 +146,9 @@ Consider any information you enter in the certificate as public; only the Common ### Using an identity -You'll need to select an identity when you encounter this error message: +You will need to select an identity when you encounter this error message: -... +> πŸ”‘ Certificate Required Clicking 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. @@ -155,9 +159,49 @@ At launch, Lagrange looks through its "idents" directory to see if any new certi * mycert.key Lagrange will add a note to the imported identities to mark them as "Imported". +## Downloads + +Press ${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. + +The location where downloaded files are saved can be set in Preferences. + +The πŸ”ƒ 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. + +## Customization + +You can find a number of settings in Preferences to customize what the user interface and page contents look like. + +### Window color theme + +... + +### Page style + +* 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. +* 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. +* Big 1st paragraph: When enabled, the leading paragraph on the page is shown in a slightly larger font. + +Options for wide window layouts: + +* 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. + # OS integration -## Opening Gemini URLs (macOS) +## Command line options + +### URLs +URLs on the command line are opened after Lagrange has launched. If more than one URL is given, multiple tabs will be opened. For example: +``` +$ lagrange gemini://gus.guru/ +``` + +### --echo +Debugging utility: internal events are printed to stdout. + +### --sw +Disable hardware accelerated graphics. Note that software rendering is anyway used as a fallback, so usually this option should not be necessary. + +## Handling Gemini URLs (macOS) 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. @@ -184,13 +228,5 @@ Other Unix : ~/.config/lagrange/ * trusted.txt * visited.txt -## Command line options - -### --echo -Debugging utility: internal events are printed to stdout. - -### --sw -Disable hardware accelerated graphics. Note that software rendering is anyway used as a fallback, so usually this option should not be necessary. - # Open source licenses => about:license -- cgit v1.2.3