README

   1 Flinks-0.2.1
   2 ============
   3 Released under the GPLv3 by Martin Bays (mbays@sdf.lonestar.org) 2008
   4
   5 Dependencies
   6 ------------
   7 python, version 2.4 or later
   8 lynx
   9
  10 Description
  11 -----------
  12 Flinks is a flashing-word web browser, intended for speed-reading and
  13 skimming.
  14
  15 Basic usage
  16 -----------
  17 Hit 'g' and enter a 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 l / h or Left / Right: skip sentences
  34 L / H : skip paragraphs
  35 o / i : skip words
  36 O / I or PgUp / PgDn : skip more words
  37 . / , : skip one word
  38 ] / [ : skip links
  39 ^A / ^E or Home / End : skip to start/end
  40
  41 j / k or Left / Right or < / > : decrease/increase speed
  42
  43 space : pause/unpause
  44
  45 g : go to an url (type "g foo" at the prompt to search with google for 'foo')
  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 q : quit
  55
  56 ^R : reload page
  57
  58 ^L : refresh screen
  59
  60 [1-9] : follow link
  61
  62 0 : begin count (e.g. type "0123o" to skip 123 words backward)
  63
  64 m : set mark ("ma", "mb" etc set marks local to the page; "mA", "mB" etc set
  65                     global marks which persist between sessions)
  66 ' : go to mark
  67
  68 : : execute a command, valid commands being as for the config file