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 Elpher is under active development.  Any suggestions for improvements
  19 are welcome!
  20
  21 Installation
  22 ------------
  23
  24 Elpher is available from [MELPA](https://melpa.org).  If you have
  25 never installed packages from this repository before, you'll need
  26 to follow the instructions at https://melpa.org/#/getting-started.
  27
  28 To install Elpher, enter the following:
  29
  30     M-x package-install RET elpher RET
  31
  32 To uninstall, use `M-x package-delete RET elpher RET`.
  33
  34 Quick Start
  35 -----------
  36
  37 Once installed, use `M-x elpher` to launch the browser.  This will
  38 open a start page which documents the main key bindings and provides
  39 some links to help kick start your exploration of gopherspace.
  40
  41 From here you can move point between links (which may be menu items or
  42 inline URLs in text files) by using `TAB` and `Shift-TAB`,
  43 as in Info.  You can also jump directly to a menu item using `m`, or
  44 use the standard Emacs or Evil motion and search commands to find your
  45 way around.  To open a link, press enter.  (Where a mouse is
  46 available, Clicking on a link with the mouse cursor has the same
  47 effect.)
  48
  49 To return to the page you just followed the link from, press `u`.
  50
  51 Elpher caches (for the duration of an Emacs session) both page contents
  52 and the position of point on each of the pages (gopher menus, query
  53 results, or text pages) you visit, restoring these when you next visit
  54 the same page.  Thus, pressing `u` displays the previous page in
  55 exactly the same state as when you left, meaning that you can quickly
  56 and visually explore the different documents in a menu without having to
  57 wait for anything to reload.
  58
  59 Of course, sometimes you'll _want_ to reload the current page
  60 rather than stick with the cached version.  To do this use `R`.
  61 (This is particularly useful for search query results, where this
  62 allows you to perform a different search.)
  63
  64 To customize the various faces Elpher uses, the start page
  65 and a few other odds and ends, use the following:
  66
  67     M-x customize-group RET elpher RET
  68
  69 Full Documentation
  70 ------------------
  71
  72 The full documentation for Elpher can be found in the Info manual,
  73 which should become automatically available if you install Elpher
  74 using `M-x package-install`.  To access it, select it from the root
  75 Info directory which can be displayed using `C-h i`.
  76
  77 Licence
  78 -------
  79
  80 Elpher is free software and is distributed under the terms of version
  81 3 the GNU General Public License, which can be found in the file named
  82 COPYING.