README

   1 Flinks-0.3.2
   2 ============
   3 Released under the GPLv3 by Martin Bays (mbays@sdf.lonestar.org) 2008-9
   4
   5 Dependencies
   6 ============
   7 python, version 2.4 or later, with curses module
   8 lynx (http://lynx.isc.org/)
   9
  10 Description
  11 ===========
  12 Flinks is a textmode flashing-word web browser, intended for speed-reading and
  13 skimming.
  14
  15 Basic usage
  16 ===========
  17 Hit 'g' and enter an url or local file to load. Press space to unpause.
  18
  19 Use cursor or vi keys to adjust the speed and to skip around within the
  20 document.
  21
  22 Links are shown in colour, and a rotating list of the last few links is shown
  23 above the main display point. To follow a link, hit the corresponding number.
  24
  25 Keybindings and Configuration
  26 ==============================
  27 When flinks is first run, it will create a file .flinksrc in your home
  28 directory. Edit this to change options and keybindings. Options can also be
  29 set on the commandline, or in-browser with ":set [option] [value]".
  30
  31 Default keys
  32 ============
  33 space : pause/unpause
  34
  35 l / h or Left / Right: skip sentences
  36 L / H : skip paragraphs
  37 o / i : skip words
  38 O / I or PgUp / PgDn : skip more words
  39 . / , : skip one word
  40 ] / [ : skip links
  41 ^A / ^E or Home / End : skip to start/end
  42
  43 j / k or Down / Up or < / > : decrease/increase speed
  44
  45 g : go to an url (enter "g foo" or "wp foo" to search google or wikipedia)
  46 G : adjust current url
  47
  48 / / ? : search forward/backward
  49 n / N : search again
  50
  51 b : go back
  52 u : unback
  53
  54 F1 : display this help page
  55
  56 q : quit
  57
  58 ^R : reload page
  59
  60 ^L : refresh screen
  61
  62 [1-9] : follow link
  63
  64 0 : begin count (e.g. type "0123o" to skip 123 words backward)
  65
  66 m : set mark ("ma", "mb" etc set marks local to the page; "mA", "mB" etc set
  67                     global marks which persist between sessions)
  68 ' : go to mark
  69
  70 : : execute a command, valid commands being as for the config file.