README

   1 # Flinks-0.5.0
   2 Released under the GPLv3 by Martin Bays (mbays@sdf.org) 2008-20
   3
   4 ## Dependencies
   5 ### Required
   6 python3, with curses module
   7 lynx (http://lynx.isc.org/)
   8 ### Optional
   9 espeak (or another text-to-speech engine)
  10
  11 ## Description
  12 Flinks is a textmode flashing-word web browser, intended for speed-reading and
  13 skimming. Doubles as a navigator of spoken text.
  14
  15 ## Basic usage
  16 Hit 'g' and enter an url or local file to load. Press space to unpause.
  17
  18 Use cursor or vi keys to adjust the speed and to skip around within the
  19 document.
  20
  21 Links are shown in colour, and a rotating list of the last few links is shown
  22 above the main display point. To follow a link, hit the corresponding number.
  23
  24 To enable speech, use '^' (requires espeak and alsa in default configuration).
  25
  26 ## Keybindings and Configuration
  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 space : pause/unpause
  33
  34 l / h or Left / Right: skip sentences
  35 L / H : skip paragraphs
  36 o / i : skip words
  37 O / I or PgUp / PgDn : skip more words
  38 . / , : skip one word
  39 ] / [ : skip links
  40 ^A / ^E or Home / End : skip to start/end
  41
  42 j / k or Down / Up or < / > : decrease/increase speed
  43
  44 g : go to an url (enter "g foo" or "wp foo" to search google or wikipedia)
  45 G : adjust current url
  46
  47 / / ? : search forward/backward
  48 n / N : search again
  49
  50 b : go back
  51 u : unback
  52
  53 F1 : display this help page
  54
  55 q : quit
  56
  57 ^R : reload page
  58
  59 ^L : refresh screen
  60
  61 [1-9] : follow link
  62
  63 ^ : toggle speech
  64
  65 * : skip to next sentence not containing a link ("skip to article")
  66
  67 0 : begin count (e.g. type "0123o" to skip 123 words backward)
  68
  69 m : set mark ("ma", "mb" etc set marks local to the page; "mA", "mB" etc set
  70                     global marks which persist between sessions)
  71 ' : go to mark
  72
  73 : : execute a command, valid commands being as for the config file.