diff options
Diffstat (limited to 'res/about/help.gmi')
| -rw-r--r-- | res/about/help.gmi | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/res/about/help.gmi b/res/about/help.gmi index 9f394e5a..d56f45de 100644 --- a/res/about/help.gmi +++ b/res/about/help.gmi | |||
| @@ -47,18 +47,32 @@ Modern web browsers are complex beasts. In fact, they are so complex that one ca | |||
| 47 | 47 | ||
| 48 | => https://win95.ajf.me Windows 95 on DOSBox (using Emscripten) | 48 | => https://win95.ajf.me Windows 95 on DOSBox (using Emscripten) |
| 49 | 49 | ||
| 50 | If one seeks to just read text and view images, this is absurd overkill. Having a universal platform that runs everywhere and on everything is clearly a valuable notion, but it comes with a hefty price tag. The software stack towers ever higher, and hardware needs to be ever more powerful and complicated to run it well. However, everything happening over the internet doesn't have to rely on this behemoth. | 50 | If one seeks to just read text and view images, this is absurd overkill. Having a universal platform that runs everywhere and on everything is clearly a valuable notion, but it comes with a hefty price tag. The software stack towers ever higher, and hardware needs to be ever more powerful and complicated to run it well. However, everything on the internet doesn't have to rely on this behemoth. |
| 51 | 51 | ||
| 52 | One way to browse Gemini content is via web browser extensions or proxies that translate the content for the web. This may be a sufficient and easy solution for you. However, native clients such as Lagrange also benefit from the simpleness of the protocol and the content. The experience can be optimized, and the software runs well even on simple hardware like the Raspberry Pi. | 52 | One way to browse Gemini content is via web browser extensions or proxies that translate the content for the web. This may be a sufficient and easy solution for you. However, native clients such as Lagrange also benefit from the simpleness of the protocol and the content. The experience can be optimized, and the software runs well even on simple hardware like the Raspberry Pi. |
| 53 | 53 | ||
| 54 | # User interface | 54 | # User interface |
| 55 | 55 | ||
| 56 | Lagrange's user interface is modeled after WWW browsers: | ||
| 57 | * There is a navigation bar at the top with Back and Forward buttons. | ||
| 58 | * 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 sidebar for managing bookmarks and TLS identities, and viewing history and the page outline. The sidebar is hidden by default. | ||
| 60 | * There is a search bar that appears at the bottom when searching text on the page. | ||
| 61 | |||
| 56 | ## URL entry and quick search | 62 | ## URL entry and quick search |
| 57 | 63 | ||
| 58 | The URL input field is in its typical location in the navigation bar. It can be accessed quickly by pressing ${CTRL+}L. | 64 | The URL input field is in its typical location in the navigation bar. It can be accessed quickly by pressing ${CTRL+}L. |
| 59 | 65 | ||
| 60 | As you enter text, Lagrange starts looking for matches in bookmarks, history, content of cached pages, and identities. Search terms are case insensitive, and if many words are entered, they are all required to appear in the specified order in any matched content. Search of cached pages is limited to the (small) set of pages that Lagrange keeps in memory for back navigation. | 66 | As you enter text, Lagrange starts looking for matches in bookmarks, history, content of cached pages, and identities. Search terms are case insensitive, and if many words are entered, they are all required to appear in the specified order in any matched content. Search of cached pages is limited to the (small) set of pages that Lagrange keeps in memory for back navigation. |
| 61 | 67 | ||
| 68 | Press Tab or ↓ to switch input focus to the search results. | ||
| 69 | |||
| 70 | ## Tabs | ||
| 71 | |||
| 72 | 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. | ||
| 73 | |||
| 74 | The set of open tabs is restored when you launch Lagrange. | ||
| 75 | |||
| 62 | ## Sidebar | 76 | ## Sidebar |
| 63 | 77 | ||
| 64 | The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has four tabs: | 78 | The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has four tabs: |
| @@ -68,6 +82,8 @@ The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has f | |||
| 68 | * Identities: TLS client certificates. | 82 | * Identities: TLS client certificates. |
| 69 | * Outline: List of the headings in the currently open tab. Useful when reading longer documents. | 83 | * Outline: List of the headings in the currently open tab. Useful when reading longer documents. |
| 70 | 84 | ||
| 85 | ${CTRL+}1 through ${CTRL+}4 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed. | ||
| 86 | |||
| 71 | ## Navigation | 87 | ## Navigation |
| 72 | 88 | ||
| 73 | ### Opening links using the keyboard | 89 | ### Opening links using the keyboard |
| @@ -82,7 +98,11 @@ Each visible link on the page gets an alphanumeric shortcut. For example, the fi | |||
| 82 | 98 | ||
| 83 | ## Managing and using identities | 99 | ## Managing and using identities |
| 84 | 100 | ||
| 85 | TLS client certificates used to identify you. | 101 | TLS client certificates that you can identify yourself with. Consider any information you enter in the certificate as public; only the Common Name is required and will appear as the issuer and subject of the certificate. |
| 102 | |||
| 103 | ## Drop and drop | ||
| 104 | |||
| 105 | You can drag and drop .gmi files on the Lagrange window to open them in the current tab. Dropping multiple files opens them in separate tabs. This is the recommended way to view local files, because there is no "Open File" menu item. You may also type "file://" URLs in the URL field. | ||
| 86 | 106 | ||
| 87 | # Runtime files | 107 | # Runtime files |
| 88 | 108 | ||
| @@ -93,10 +113,6 @@ TLS client certificates used to identify you. | |||
| 93 | * trusted.txt | 113 | * trusted.txt |
| 94 | * visited.txt | 114 | * visited.txt |
| 95 | 115 | ||
| 96 | # Platform-specific instructions | ||
| 97 | |||
| 98 | # Compiling from source | ||
| 99 | |||
| 100 | # Open source licenses | 116 | # Open source licenses |
| 101 | 117 | ||
| 102 | Lagrange itself is distributed under the BSD 2-clause license: | 118 | Lagrange itself is distributed under the BSD 2-clause license: |