\input texinfo @c -*-texinfo-*-
@setfilename elpher.info
-@settitle Elpher Manual v1.0.0
+@settitle Elpher Manual v2.0.0
@dircategory Emacs
@direntry
* Bookmarks:: How to record and visit bookmarks
* Character encodings:: How Elpher handles different character encodings
* Encrypted connections:: How and when TLS is enabled
+* Gemini support:: Support for the Gemini protocol
* Customization:: How to customize various aspects of Elpher
* Command Index::
+
+@detailmenu
+ --- The Detailed Node Listing ---
+
+Navigation
+
+* Within-page navigation:: Moving about within a page
+* Between-page navigation:: Commands for moving between pages
+* History and Caching:: Explanation of how Elpher represents history
+
+@end detailmenu
@end menu
@node Introduction, Installation, Top, Top
@item
direct visualization of image files where supported (no writing to
-disk), and
+disk),
+
+@item
+a bookmark management system,
@item
-a simple bookmark management system.
+basic support for the new ``heavier than gopher, lighter than the web'' Gemini protocol.
+
@end itemize
Elpher is still under active development. Although we try very hard to
While not recommended, it is also possible to install Elpher directly by
downloading the file @file{elpher.el} from
-@url{https://github.com/tgvaughan/elpher}, adding it to a directory in
+@url{gopher://thelambdalab.xyz/1/projects/elpher/}, adding it to a directory in
your @code{load-path}, and then adding
@example
This is similar to @code{elpher-download}, but instead applies to the
current page rather than a link.
-@keycmd{@key{w}, elpher-view-raw}
+@keycmd{@key{.}, elpher-view-raw}
This displays the raw server response for the current page. While not
useful for general browsing, it is useful for debugging incorrect rendering
or out-of-spec server responses.
cached for the duration of the Emacs session.
@keycmd{@key{g}, elpher-go}
-Open a particular page by specifying either its URL or directly entering
-a host, port and selector.
+Open a particular page by specifying either its full URL or just entering
+a gopher host name.
If a non-gopher protocol is used in the URL the result will be the same
as following a URL link of the same type from a gopher menu.
@keycmd{@key{O}, elpher-root-dir}
Open the root page (empty selector) on the current host.
-@keycmd{@key{u}, elpher-back}
+@keycmd{@key{u}\, @kbd{mouse-3}, elpher-back}
Return to the previous page, where ``previous'' means the page where the
page which was displayed immediately before the current page.
@end table
@key{R}.
-@node Encrypted connections, Customization, Character encodings, Top
+@node Encrypted connections, Gemini support, Character encodings, Top
@chapter Encrypted connections
While RFC 1436 does not broach the topic of encryption at all, several
In this case Elpher will prompt for your confirmation to ensure that
you can't accidentally make a non-TLS connection.
-
-@node Customization, Command Index, Encrypted connections, Top
+@node Gemini support, Customization, Encrypted connections, Top
+@chapter Gemini support
+
+@uref{gopher://zaibatsu.circumlunar.space/1/~solderpunk/gemini, Gemini}
+is a new protocol being devloped by several members of
+gopherspace. It aims to solve some of the long-standing technical
+issues associated with gopher as a protocol, while keeping the major benifits.
+For instance, it _requires_ encrypted connections, it does away with
+the selector type, and allows servers to explicitly specify the
+character coding scheme used for text documents.
+
+The latest versions of Elpher aim to provide seemless navigation between
+gemini and gopher documents. Basically you should be able to open,
+bookmark, download and otherwise interact with gemini pages in exactly
+the same way as you do with other non-gemini pages. The only major
+difference from your perspective as a user is that you should no longer
+have to worry about manually toggling TLS on or off (for gemini it's
+always on), and you should never have to manually set a character coding
+scheme.
+
+I should emphasize however that, while it is definitely functional,
+Elpher's gemini support is still experimental, and various aspects will
+change as the protocol develops further. Additionally, the use of
+client TLS certicificates is not yet supported.
+
+@node Customization, Command Index, Gemini support, Top
@chapter Customization
Various parts of Elpher can be customized via the
the appearance of Elpher, including one face per menu item type.
The group also contains variables for customizing the behaviour of
-Elpher. This includes how to open arbitrary (non-gopher) URLs,
-whether to display buffer headers, whether to look for naked URLs in
-gopher menus (as opposed to just plain text files), and whether
-to prompt for confirmation when switching away from TLS.
+Elpher. This includes how to open arbitrary (non-gopher) URLs, whether
+to display buffer headers, how to deal with ANSI escape sequences in
+text, the timeout to impose on network connections, and whether to
+prompt for confirmation when switching away from TLS.
See the customization group itself for details.
The Lambda Lab / projects / elpher.git / blobdiff