README

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