README.md

   1 # Elpher
   2
   3 [![MELPA](https://melpa.org/packages/elpher-badge.svg)](https://melpa.org/#/elpher)
   4
   5 Elpher aims to provide a full-featured gopher client for GNU Emacs.
   6
   7 It supports:
   8 - simple keyboard and mouse-driven browsing, including out-of-the-box
   9   compatibility with evil-mode,
  10 - caching of visited sites,
  11 - clean and configurable visualization of Gopher directories,
  12 - direct visualisation of image files,
  13 - jumping directly to links by name (with autocompletion),
  14 - clickable web and gopher links in plain text.
  15
  16 Keep the non-web internet alive!
  17
  18 ## Installation
  19
  20 Elpher is available from [MELPA](https://melpa.org).  If you have
  21 never installed packages from this repository before, you'll need
  22 to follow the instructions at https://melpa.org/#/getting-started.
  23
  24 To install Elpher, enter the following:
  25
  26     M-x package-install RET elpher RET
  27
  28 To uninstall, use `M-x package-delete RET elpher RET`.
  29
  30 ## Usage
  31
  32 Once installed, use `M-x elpher` to launch the browser.  This will
  33 open a start page which documents the default key bindings and
  34 provides some links to help kick start your exploration of gopherspace.
  35
  36 To customize the various faces Elpher uses, the start page
  37 and a few other odds and ends, use the following:
  38
  39     M-x customize-group RET elpher RET
  40
  41 ## History and Caching
  42
  43 This is an aspect of Elpher that perhaps requires separate explanation.
  44
  45 Every item you visit with Elpher is modeled as a "node" in a tree.
  46 For instance, a gopher directory represents a single node.  When
  47 you open such a directory, Elpher creates nodes for every entry
  48 in that directory and makes these children of the original directory node:
  49
  50                X  <- current directory node
  51                |
  52             -------
  53             |  |  |
  54             o  o  o  <- nodes representing entries in directory
  55
  56 If one of those entries is itself a directory and you click on it,
  57 Elpher marks that node the current node, and extends the tree as follows:
  58
  59                o  <- original directory node
  60                |
  61             -------
  62             |  |  |
  63             o  o  X  <- current directory node (marked with X)
  64                   |
  65               ---------
  66               | | | | |
  67               o o o o o  <- nodes representing entries in new directory
  68
  69 Pressing the 'u' key (introduced on page which opens when elopher starts)
  70 always moves to the page representing "parent" node, whatever that is.
  71
  72 Once a node is visited, its "contents" (i.e. whatever is retrieved
  73 from the gopher server) are recorded in memory with the corresponding
  74 node.  The cursor position (point) is also stored. If the node is
  75 visited again in the same session, the cached contents are displayed
  76 and the cursor returns to its previous position.  This makes
  77 navigating amongst different documents referenced from within the same
  78 directory very snappy. (To conserve memory, this caching isn't by
  79 default applied to images entries viewed in the browser.)
  80
  81 This hierarchy is also maintained when gopher URLs are followed from plain
  82 text documents, and when directories are retrieved explicitly using the 'g'
  83 key.
  84
  85 ## Licence
  86
  87 Elpher is free software and is distributed under the terms of version
  88 3 the GNU General Public License, which can be found in the file named
  89 COPYING.