README.md

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