elpher.texi

   1 \input texinfo @c -*-texinfo-*-
   2 @c %**start of header
   3 @setfilename elpher.info
   4 @settitle Elpher Manual v1.0.0
   5 @c %**end of header
   6
   7 @copying
   8 This manual documents Elpher, a gopher client for Emacs.
   9
  10 Copyright @copyright{} 2019 Tim Vaughan
  11
  12 @quotation
  13 The source and documentation of Elpher is free software.  You can
  14 redistribute it and/or modify it under the terms of the GNU General
  15 Public License as published by the Free Software Foundation; either
  16 version 3, or (at your option) any later version.
  17
  18 Elpher is distributed in the hope that it will be useful, but WITHOUT
  19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  20 FITNElpher FOR A PARTICULAR PURPOSE. See the GNU General Public License in
  21 the file COPYING in the same directory as this file for more details.
  22 @end quotation
  23 @end copying
  24
  25 @titlepage
  26 @title Elpher Gopher Client Manual
  27 @author Tim Vaughan
  28
  29 @page
  30 @vskip 0pt plus 1filll
  31 @insertcopying
  32 @end titlepage
  33
  34 @contents
  35
  36 @ifnottex
  37 @node Top, Introduction, (dir), (dir)
  38 @top Elpher
  39
  40 @insertcopying
  41 @end ifnottex
  42
  43 @menu
  44 * Introduction::                Elpher Overview: what's this all about?
  45 * Navigation::                  Fundamentals of Elpher navigation
  46 * Bookmarks::                   How to record and visit bookmarks
  47 * Customization::               How to customize various aspects of Elpher
  48 * Hacking::                     Contributing changes to Elpher
  49 * Index::
  50 @end menu
  51
  52 @node Introduction, Navigation, Top, Top
  53 @chapter Introduction
  54
  55 Elpher aims to be a capable and practical gopher client for Emacs.  Its
  56 focus is on easy keyboard-driven navigation based on sensible default
  57 bindings (with out-of-the-box support for Evil).  It is intended to be
  58 robust and behave in non-surprising ways at all times.  Additionally,
  59 Elpher provides the following bells and whistles:
  60
  61 @itemize
  62 @item
  63 an easily navigable history, sporting caching of visited sites (both
  64 content and cursor position),
  65
  66 @item
  67 auto-completing menu item navigation,
  68
  69 @item
  70 followable web and gopher links in plain text,
  71
  72 @item
  73 direct visualization of image files where supported (no writing to
  74 disk), and
  75
  76 @item
  77 a simple bookmark management system.
  78 @end itemize
  79
  80 Throughout this manual, the
  81
  82 Elpher is still under active development.  Although we try very hard to
  83 ensure that releases are bug-free, this cannot be guaranteed.  However,
  84 this also means that any usability features that you feel are missing
  85 can likely by incoroporated quickly, so please get in touch if you
  86 have some ideas.
  87
  88 @node Navigation, Bookmarks, Introduction, Top
  89 @chapter Navigation
  90
  91 Elpher's navigation interface heavily inspired by the Emacs Info mode.
  92
  93 @menu
  94 * Within-page navigation::
  95 * Between-page navigation::
  96 @end menu
  97
  98 @node Within-page navigation, Between-page navigation, Navigation, Navigation
  99 @section Within-page navigation
 100
 101 Within a single page
 102
 103 @node Between-page navigation,  , Within-page navigation, Navigation
 104 @section Between-page navigation
 105
 106 @node Bookmarks, Customization, Navigation, Top
 107 @chapter Bookmarks
 108
 109 @node Customization, Hacking, Bookmarks, Top
 110 @chapter Customization
 111
 112 @node Hacking, Index, Customization, Top
 113 @chapter Hacking
 114
 115 @node Index,  , Hacking, Top
 116 @unnumbered Index
 117
 118 @printindex cp
 119
 120 @bye