1 \input texinfo @c -*-texinfo-*-
3 @setfilename elpher.info
4 @settitle Elpher Manual v1.0.0
8 This manual documents Elpher, a gopher client for Emacs.
10 Copyright @copyright{} 2019 Tim Vaughan
13 The source and documentation of Elpher is free software. You can
14 redistribute it and/or modify it under the terms of the GNU General
15 Public License as published by the Free Software Foundation; either
16 version 3, or (at your option) any later version.
18 Elpher is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNElpher FOR A PARTICULAR PURPOSE. See the GNU General Public License in
21 the file COPYING in the same directory as this file for more details.
26 @title Elpher Gopher Client Manual
30 @vskip 0pt plus 1filll
37 @node Top, Introduction, (dir), (dir)
44 * Introduction:: Elpher Overview: what's this all about?
45 * Navigation:: Fundamentals of Elpher navigation
46 * Bookmarks:: How to record and visit bookmarks
47 * Character encodings:: How Elpher handles different character encodings
48 * Customization:: How to customize various aspects of Elpher
49 * Hacking:: Contributing changes to Elpher
53 @node Introduction, Navigation, Top, Top
56 Elpher aims to be a capable and practical gopher client for Emacs. Its
57 focus is on easy keyboard-driven navigation based on sensible default
58 bindings (with out-of-the-box support for Evil). It is intended to be
59 robust and behave in non-surprising ways at all times. Additionally,
60 Elpher provides the following bells and whistles:
64 an easily navigable history, sporting caching of visited pages (both
65 content and cursor position),
68 auto-completing menu item navigation,
71 followable web and gopher links in plain text,
74 direct visualization of image files where supported (no writing to
78 a simple bookmark management system.
81 Elpher is still under active development. Although we try very hard to
82 ensure that releases are bug-free, this cannot be guaranteed. However,
83 this also means that any usability features that you feel are missing
84 can likely by incoroporated quickly, so please get in touch if you
87 @node Navigation, Bookmarks, Introduction, Top
90 Throughout this manual, we use the word ``page'' to refer to any
91 visualization of a response from a gopher server, be it a
92 menu/directory, query result, text file or image. We use
94 Elpher's navigation interface is inspired by the Emacs Info mode.
95 Movement within a page is essentially the same as moving
96 around any other text file in Emacs, but with special keys
97 for quickly jumping between menu items and URLs in text files.
98 Movement between pages is facilitated by a simple linear history
99 coupled with caching of pages and cursor position.
102 * Within-page navigation:: Moving about within a page
103 * Between-page navigation:: Concepts and commands for moving between pages
106 @node Within-page navigation, Between-page navigation, Navigation, Navigation
107 @section Within-page navigation
109 To move about within a page, you should be able use the same keys you usually
110 use to browse files in Emacs. This is even true when Evil mode is
111 enabled. Paragraph hopping, searching etc should work as usual.
113 In addition, the following commands are provided for quickly moving between
114 links and menu items.
117 @item @kbd{tab} (@code{elpher-next-link})
118 Move to the next link or menu item in the file.
120 @item @kbd{<S-tab>}/@kbd{<backtab} (@code{elpher-prev-link})
121 Move to the previous link or menu item in the file.
123 @item @kbd{m} (@code{elpher-jump})
124 Jump directly to a link within a file by specifying its display string
125 or link text. (Unlike the previous two commands, this immediately opens
129 The following commands can be used to retrieve information about the
130 current page, or the address of the link at point:
133 @item @kbd{i} (@code{elpher-info-link})
134 Display host, port and selector information for the link at point.
136 @item @kbd{I} (@code{elpher-info-current})
137 Display host, port and selector information for the current page.
139 @item @kbd{c} (@code{elpher-copy-link-url})
140 Add URL representing address of link at point to the kill-ring and the
141 system clipboard (if available).
143 @item @kbd{C} (@code{elpher-copy-current-url})
144 Add URL representing address of the current page to the kill-ring and
145 the system clipboard (if available).
148 @node Between-page navigation, , Within-page navigation, Navigation
149 @section Between-page navigation
151 Moving to a different page can be accomplished in several ways,
152 described by the following commands:
155 @item @kbd{RET}, @kbd{mouse-1} (@code{elpher-follow-link})
156 Follow the menu item or link at point (or selected with the mouse).
159 Exactly what is meant by ``follow'' depends on the kind of item selected.
160 For text or menu type items or links, the curent page text is replaced
161 by the text of this item.
163 Once a text, menu or query response page is retrieved, its contents are
164 cached for the duration of the Emacs session.
166 @node Bookmarks, Character encodings, Navigation, Top
169 @node Character encodings, Customization, Bookmarks, Top
170 @chapter Character encodings
172 @node Customization, Hacking, Character encodings, Top
173 @chapter Customization
175 @node Hacking, Index, Customization, Top
178 @node Index, , Hacking, Top