X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.texi;h=d9a835bd8a4aa23e5d18c924c760ec1a5052e787;hp=e7a03a919aec9747e32bb4ed0d0e8f2c9c744521;hb=8df32499ec6d54b37427a5f49bc41fce47a98ffc;hpb=5f7b2a6ed52621ea1bd983428428d5d513b2405e diff --git a/elpher.texi b/elpher.texi index e7a03a9..d9a835b 100644 --- a/elpher.texi +++ b/elpher.texi @@ -1,7 +1,7 @@ \input texinfo @c -*-texinfo-*- @setfilename elpher.info -@settitle Elpher Manual v2.11.0 +@settitle Elpher Manual v3.0.0 @dircategory Emacs @direntry @@ -11,7 +11,9 @@ @copying This manual documents Elpher, a gopher and gemini client for Emacs. -Copyright @copyright{} 2019, 2020 Tim Vaughan +Copyright @copyright{} 2019, 2020, 2021 Tim Vaughan@* +Copyright @copyright{} 2021 Daniel Semyonov@* +Copyright @copyright{} 2021 Alex Schroeder @quotation The source and documentation of Elpher is free software. You can @@ -180,12 +182,19 @@ rather than stick with the cached version. To do this use @key{R}. (This is particularly useful for search query results, where this allows you to perform a different search.) -That's more-or-less it. Elpher supports a number of other features, such -as bookmarking, support for different coding schemes and TLS encryption, -and a variety of customization options, all of which are explained in -the rest of this document. However the emphasis is on keeping the basic +That's more-or-less it. Elpher supports a number of other features, +such a support for different coding schemes and TLS encryption, and a +variety of customization options, all of which are explained in the +rest of this document. However the emphasis is on keeping the basic navigation experience as intuitive and responsive as possible. +Note that you can launch multiple Elpher sessions in parallel by using +a prefix: + +@example +@kbd{C-u M-x elpher @key{RET}} +@end example + @node Navigation, Bookmarks, Quick Start, Top @chapter Navigation Throughout this manual, we use the word ``page'' to refer to any @@ -230,6 +239,7 @@ or link text. (Unlike the previous two commands, this immediately opens the selected link. @end table + The following commands can be used to retrieve information about the current page, or the address of the link at point: @@ -306,8 +316,9 @@ Once a text, menu or query response page has been displayed, its contents are cached for the duration of the Emacs session. @keycmd{@key{g}, elpher-go} -Open a particular page by specifying either its full URL or just entering -a gopher host name. (The protocol defaults to gopher, so gemini links must include the @code{gemini://} prefix. +Open a particular page by specifying either its full URL or just +entering a gopher host name. (The protocol defaults to gopher, so gemini +links must include the @code{gemini://} prefix. If a unsupported protocol is used in the URL the result will be the same as following a URL link of the same type from a link in a page. @@ -323,7 +334,7 @@ structure of selectors. @keycmd{@key{O}, elpher-root-dir} Open the root page (empty selector) on the current host. -@keycmd{@key{u}\, @kbd{mouse-3}, elpher-back} +@keycmd{@key{u}\, @key{-}\, @key{^}\, @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 @@ -365,6 +376,19 @@ this will be automatically positioned on the link that was most recently followe from a given page. This means that, at least for links followed from menus and text files, the inverse of @key{u} is actually just @key{RET}. +Elpher actually maintains two histories, and there are two different +commands to access them: + +@table @asis +@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-show-visited-pages} +This shows the entire Elpher browsing history. It includes all the +pages you visited in your current Emacs session. + +@end table @node Bookmarks, Gopher character encodings, Navigation, Top @chapter Bookmarks @@ -374,30 +398,35 @@ emacs, The Emacs Editor}. The following commands are perhaps the most 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 -need to import the 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 @@ -410,8 +439,8 @@ characters. To do this properly requires knowledge of the encoding 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 @@ -425,7 +454,7 @@ The alternative is to explicitly set the coding system used for decoding using the following command: @table @asis -@keycmd{@key{S},elpher-set-coding-system} +@keycmd{@key{!},elpher-set-coding-system} Causes a elpher to prompt for a coding system to use for decoding future gopher text. The @key{TAB} key can be used at this prompt to display a list of alternatives (which is extensive) and to auto-complete. An empty