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 on the non-GNU ELPA package archive.  If you are
  30 using Emacs 28 or later, this archive should be available on your system
  31 by default.  For Emacs 27, you'll need to follow the instructions at
  32 https://elpa.nongnu.org to make the archive accessible.
  33
  34 Alternatively, Elpher is available from MELPA (https://melpa.org).  If
  35 you have never installed packages from this repository before, you'll
  36 need to follow the instructions at https://melpa.org/#/getting-started.
  37
  38 Once one of these package archives is installed, enter the following to
  39 install Elpher:
  40
  41     M-x package-install RET elpher RET
  42
  43 To uninstall, use
  44
  45     M-x package-delete RET elpher RET
  46
  47 Quick Start
  48 -----------
  49
  50 Once installed, use "M-x elpher" to launch the browser.  This will
  51 open a start page which documents the main key bindings and provides
  52 some links to help kick start your exploration of gopher space and
  53 gemini space.
  54
  55 From here you can move point between links (which may be menu items or
  56 inline URLs in text files) by using TAB and Shift-TAB,
  57 as in Info.  You can also jump directly to a menu item using "m", or
  58 use the standard Emacs or Evil motion and search commands to find your
  59 way around.  To open a link, press enter.  (Where a mouse is
  60 available, Clicking on a link with the mouse cursor has the same
  61 effect.)
  62
  63 To return to the page you just followed the link from, press "u".
  64
  65 Elpher caches (for the duration of an Emacs session) both page
  66 contents and the position of point on each of the pages (gopher menus,
  67 gemini pages, query results, or text pages) you visit, restoring these
  68 when you next visit the same page.  Thus, pressing "u" displays the
  69 previous page in exactly the same state as when you left, meaning that
  70 you can quickly and visually explore the different documents in a menu
  71 without having to wait for anything to reload.
  72
  73 Of course, sometimes you'll _want_ to reload the current page
  74 rather than stick with the cached version.  To do this use "R".
  75 (This is particularly useful for search query results, where this
  76 allows you to perform a different search.)
  77
  78 To customize the various faces Elpher uses, the start page
  79 and a few other odds and ends, use the following:
  80
  81     M-x customize-group RET elpher RET
  82
  83 Full Documentation
  84 ------------------
  85
  86 The full documentation for Elpher can be found in the Info manual,
  87 which should become automatically available if you install Elpher
  88 using "M-x package-install".  To access it, select it from the root
  89 Info directory which can be displayed using "C-h i".
  90
  91 Contributors
  92 ------------
  93
  94 Elpher was originally written and is currently maintained by Tim Vaughan
  95 <plugd@thelambdalab.xyz>.  Significant improvements and
  96 maintenance have also been contributed by and with the help of Alex
  97 Schroeder <alex@gnu.org>.  In addition, the following people have
  98 all generously provided assistance and/or patches over the years:
  99
 100 * Jens Östlund <jostlund@gmail.com>
 101 * F. Jason Park <jp@neverwas.me>
 102 * Christopher Brannon <chris@the-brannons.com>
 103 * Omar Polo <op@omarpolo.com>
 104 * Noodles! <nnoodle@chiru.no>
 105 * Abhiseck Paira <abhiseckpaira@disroot.org>
 106 * Zhiwei Chen <chenzhiwei03@kuaishou.com>
 107 * condy0919 <condy0919@gmail.com>
 108 * Alexis <flexibeast@gmail.com>
 109 * Étienne Deparis <etienne@depar.is>
 110 * Simon Nicolussi <sinic@sinic.name>
 111 * Michel Alexandre Salim <michel@michel-slm.name>
 112 * Koushk Roy <kroy@twilio.com>
 113 * Vee <vee@vnsf.xyz>
 114 * Simon South <simon@simonsouth.net>
 115 * Daniel Semyonov <daniel@dsemy.com>
 116 * Bradley Thornton <bradley@northtech.us>
 117
 118 License
 119 -------
 120
 121 Elpher is free software and is distributed under the terms of version
 122 3 the GNU General Public License, which can be found in the file named
 123 COPYING.