\input texinfo @c -*-texinfo-*-
@setfilename elpher.info
-@settitle Elpher Manual v2.11.0
+@settitle Elpher Manual v3.0.0
@dircategory Emacs
@direntry
* Navigation:: Fundamentals of Elpher navigation
* Bookmarks:: How to record and visit bookmarks
* Gopher character encodings:: How Elpher selects encodings for gopher pages
-* Encrypted gopher connections:: How and when TLS is enabled for gopher
+* Encrypted gopher connections:: How and when TLS is enabled for gopher
* Gemini support:: Support for the Gemini protocol
* Finger support:: Support for the Finger protocol
* Customization:: How to customize various aspects of Elpher
* Command Index::
+* News:: Changes introduced by major releases
+* Acknowledgements:: Contributors to Elpher
@detailmenu
--- The Detailed Node Listing ---
@end detailmenu
@end menu
+
@end ifnottex
@macro keycmd{key,cmd}
@kbd{M-x package-delete @key{RET} elpher @key{RET}}.
@end example
-While not recommended, it is also possible to install Elpher directly
-by downloading the file @file{elpher.el} from
-@url{https://alexschroeder.ch/cgit/elpher}, adding it to a directory
-in your @code{load-path}, and then adding
+It is also possible to install Elpher directly by downloading the file
+@file{elpher.el} from @url{gopher://thelambdalab.xyz/1/projects/elpher}
+(you'll need to download the ``source archive'' and extract it), adding
+it to a directory in your @code{load-path}, and then adding
@example
(require 'elpher)
@chapter Navigation
Throughout this manual, we use the word ``page'' to refer to any
visualization of a response from a gopher or gemini server, be it a
-menu/directory, query result, text file or image. We use
+menu/directory, query result, text file or image.
Elpher's navigation interface is inspired by the Emacs Info mode.
Movement within a page is essentially the same as moving
Jump directly to a link within a file by specifying its display string
or link text. (Unlike the previous two commands, this immediately opens
the selected link.
-
-@keycmd{@key{M}, elpher-jump-to-number}
-Jump directly to a link within a file by specifying the number of the
-link, where the first link on the page is link number 1.
-(These indices can be shown next to the links by setting the customization
-option elpher-number-links to non-nil.)
@end table
commands to access them:
@table @asis
-@keycmd{@key{s}, elpher-history}
+@keycmd{@key{s}, elpher-show-history}
This shows the history of the current buffer. This shows all the links
you would visit if you were to use @key{u} again and again.
-@keycmd{@key{S}, elpher-history-all}
+@keycmd{@key{S}, elpher-show-visited-pages}
This shows the entire Elpher browsing history. It includes all the
-pages you visited using other Elpher buffers, and it includes buffers
-you later killed.
+pages you visited in your current Emacs session.
@end table
useful ones:
@table @asis
-@keycmd{@key{a}, elpher-set-bookmark-no-overwrite}
+@keycmd{@key{a}, elpher-bookmark-link}
Add a bookmark for the link at point. The minibuffer will prompt for
a name for the bookmark, which defaults to the display string.
-@keycmd{@key{A}, bookmark-set-no-overwrite}
+@keycmd{@key{A}, elpher-bookmark-current}
Add a bookmark for the current page. The minibuffer will prompt for
a name for the bookmark, defaulting to the display string associated
with the link that was followed to reach the current page.
-@keycmd{@key{B}, bookmark-bmenu-list}
+@keycmd{@key{B}, elpher-open-bookmarks}
Open a page displaying all current bookmarks. This is where you can
delete and search bookmarks, for example.
-
@end table
-If all your bookmarks disappeared in an upgrade from 2.10 to 2.11, you
-can import your old Elpher bookmarks into your Emacs bookmarks using
+On opening the bookmarks page, elpher will offer to import any legacy
+(2.x) bookmarks files into the new system. Once the import is complete,
+the original bookmarks file will have ``-legacy'' appended to it, so
+so that elpher knows not to import it again.
+
+If you have any other legacy bookmark files (besides the one in the
+original location, or specified in the @code{elpher-bookmarks-file}
+customization variable, which should be automatically detected), you can
+can import these using
@example
@kbd{M-x elpher-bookmark-import @key{RET}}
@end example
-Once this is done, you can delete the file with the Elpher bookmarks.
+Once this is done, you may delete these legacy bookmarks files.
@node Gopher character encodings, Encrypted gopher connections, Bookmarks, Top
@chapter Gopher character encodings
system used by whoever authored the document.
Unfortunately gopher lacks a systematic way of acquiring this necessary
-information. Thus, the details of the coding system must be either inferred from the binary data,
-or must be specified by the user.
+information. Thus, the details of the coding system must be either
+inferred from the binary data, or must be specified by the user.
By default, Elpher applies Emacs' built-in character encoding detection
system to the full (undecoded) response data and uses this to attempt to
See the customization group itself for details.
-@node Command Index, , Customization, Top
+@node Command Index, News, Customization, Top
@unnumbered Command Index
@printindex fn
+@node News, Acknowledgements, Command Index, Top
+@chapter News
+
+This chapter documents the major changes introduced by Elpher releases.
+
+@section v3.0.0
+
+@subsection Bookmarks system
+
+Bookmarks are now handled by Emacs' own bookmark management system,
+instead of Elpher's own system.
+(For details, @xref{Bookmarks, , , emacs, The Emacs Editor}.)
+This means two things. Firstly,
+the bookmarks file (elpher-bookmarks by default) and format used by
+previous versions are now deprecated. If these are detected, Elpher
+will offer to import your old bookmarks when you first accessing the
+bookmark list with the new version. A suffix will be added to your
+old bookmarks file so that Elpher knows that the import is complete.
+
+Secondly, the old Elpher bookmark menu has been removed in the new
+version. Instead, @kbd{B} brings up the menu provided by the Emacs
+function @code{bookmark-bmenu-list}. This has different key and mouse
+bindings to Elpher's old menu, but is much more functional. Bookmarks
+can be renamed, deleted in groups, and much more. (Use @kbd{C-h m} with
+the menu open to see the complete list.)
+
+@subsection History
+
+Browsing history can now be accessed via new bindings to @kbd{s} and @kbd{S}.
+The former shows the current history ``stack'' (pages accessible with
+the @kbd{u} key), while the latter shows a list of all pages which have
+been visited in the current session.
+
+@subsection Socks connections
+
+Elpher can now use socks connections to browse via TOR.
+
+@subsection browse-url, Org and mu4e integration
+
+These integrations provide support for elpher-handling of gemini, gopher
+and finger URLs using @code{browse-url}, in Org documents, and the mu4e
+mail system.
+
+@subsection imenu integration
+
+Gemini document headers are now navigable via imenu.
+For details, @xref{Imenu, , , emacs, The Emacs Editor}.
+
+@node Acknowledgements, , News, Top
+@chapter Acknowledgements
+
+Elpher was originally written by Tim Vaughan. Recent maintenance has
+been done by and with the help of Alex Schroeder. In addition, the
+following people (in alphabetical order) have generously provided
+assistance and/or patches:
+
+@itemize
+@item Alexis
+@item Christopher Brannon
+@item Zhiwei Chen
+@item condy0919
+@item Étienne Deparis
+@item Roy Koushik
+@item Simon Nicolussi
+@item Noodles!
+@item Jens Östlund
+@item F. Jason Park
+@item Omar Polo
+@item Koushk Roy
+@item Michel Alexandre Salim
+@item Alex Schroeder
+@item Daniel Semyonov
+@item Simon South
+@item Bradley Thornton
+@item Vee
+@end itemize
+
+
@bye