README.md

   1 Elpher
   2 ======
   3
   4 Elpher aims to provide a full-featured gopher client for GNU Emacs.
   5
   6 It supports:
   7 - intuitive keyboard and mouse-driven browsing,
   8 - out-of-the-box compatibility with evil-mode,
   9 - clickable web and gopher links **in plain text**,
  10 - caching of visited sites,
  11 - pleasant and configurable visualization of Gopher directories,
  12 - direct visualisation of image files,
  13 - jumping directly to links by name (with autocompletion),
  14 - a simple bookmark management system,
  15 - connections using TLS encryption,
  16 - [the Gemini protocol](gopher://zaibatsu.circumlunar.space/1/~solderpunk/gemini).
  17
  18 The official home of elpher is gopher://thelambdalab.xyz/1/projects/elpher/.
  19 Please visit that page for development news and to leave feedback.
  20 (There is also a github repository, but this is mostly for the benifit of MELPA.)
  21
  22 Elpher is under active development.
  23 Any suggestions for improvements are welcome!
  24
  25 Installation
  26 ------------
  27
  28 Elpher is available from [MELPA](https://melpa.org).  If you have
  29 never installed packages from this repository before, you'll need
  30 to follow the instructions at https://melpa.org/#/getting-started.
  31
  32 To install Elpher, enter the following:
  33
  34     M-x package-install RET elpher RET
  35
  36 To uninstall, use `M-x package-delete RET elpher RET`.
  37
  38 Quick Start
  39 -----------
  40
  41 Once installed, use `M-x elpher` to launch the browser.  This will
  42 open a start page which documents the main key bindings and provides
  43 some links to help kick start your exploration of gopherspace.
  44
  45 From here you can move point between links (which may be menu items or
  46 inline URLs in text files) by using `TAB` and `Shift-TAB`,
  47 as in Info.  You can also jump directly to a menu item using `m`, or
  48 use the standard Emacs or Evil motion and search commands to find your
  49 way around.  To open a link, press enter.  (Where a mouse is
  50 available, Clicking on a link with the mouse cursor has the same
  51 effect.)
  52
  53 To return to the page you just followed the link from, press `u`.
  54
  55 Elpher caches (for the duration of an Emacs session) both page contents
  56 and the position of point on each of the pages (gopher menus, query
  57 results, or text pages) you visit, restoring these when you next visit
  58 the same page.  Thus, pressing `u` displays the previous page in
  59 exactly the same state as when you left, meaning that you can quickly
  60 and visually explore the different documents in a menu without having to
  61 wait for anything to reload.
  62
  63 Of course, sometimes you'll _want_ to reload the current page
  64 rather than stick with the cached version.  To do this use `R`.
  65 (This is particularly useful for search query results, where this
  66 allows you to perform a different search.)
  67
  68 To customize the various faces Elpher uses, the start page
  69 and a few other odds and ends, use the following:
  70
  71     M-x customize-group RET elpher RET
  72
  73 Full Documentation
  74 ------------------
  75
  76 The full documentation for Elpher can be found in the Info manual,
  77 which should become automatically available if you install Elpher
  78 using `M-x package-install`.  To access it, select it from the root
  79 Info directory which can be displayed using `C-h i`.
  80
  81 Licence
  82 -------
  83
  84 Elpher is free software and is distributed under the terms of version
  85 3 the GNU General Public License, which can be found in the file named
  86 COPYING.