README

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