README

   1 ***     Ipage   ***
   2         An intelligent pager for the console.
   3
   4 Introduction
   5
   6 Ipage is a pager for the Linux console and possibly some other *nixes. It can do your standard paging functions e.g.
   7 page down, page up, line down, line up, search etc.
   8 Ipage has been optimized to be comfortable for a blind user to use e.a. it presents it's output in a format easily
   9 understandable for a screen reader like speakup (http://linux-speakup.org).
  10 In addition, ipage has a "say all" function. By pressing "a", the file will be read aloud from the current cursor
  11 position. Pressing "c" while in "say all" mode, the operation will be stopped and the cursor moved to the last line of
  12 text spoken.
  13 Ipage will also automatically save the last position in the file to a file called <filename>.ipm on exit, where <filename>
  14 is the name of the current file. All set marks will also be saved.
  15
  16 Keys
  17
  18 The following is a list of keys that can be use to operate ipage:
  19 down arrow:
  20 go to the next line
  21 up arrow:
  22 go to the previous line
  23 page down or space:
  24 go to the next page
  25 page up or b:
  26 go to the previous page
  27 /:
  28 search for a string of text
  29 >:
  30 search for the next occurrence of the string previously searched for by /
  31 <:
  32 search for the previous occurrence of the string previously searched for by /
  33 1 and 2:
  34 lower and raise the rate of the speech respectively
  35 v:
  36 change the voice of the speech
  37 s followed by a letter:
  38 set a mark at the current position and assign it to the letter
  39 m followed by a letter:
  40 move to the position previously assigned to the letter
  41 home:
  42 go to beginning of file
  43 end:
  44 go to end of file
  45 a:
  46 start the say all function
  47 c:
  48 stop the say all function and update the cursor
  49
  50 Dependencies
  51
  52 Ipage will knead the following components to run on the system:
  53 * espeak, for speech output
  54 * fmt, to prittyprint the file before viewing
  55 * ncurses, for output on the screen (it is possible that another version/flavor of curses will work too)
  56
  57 Installing
  58
  59 To compile and install ipage given that all dependencies are met:
  60 $ make
  61 $ sudo make install
  62
  63 To Do
  64
  65 This is just a list of things I might still do to ipage.
  66 * make the search function support regular expressions
  67 * make the say all function automatically scroll the file while reading
  68 * support other speech engines besides espeak (speech-dispatcher?)
  69
  70 Contributing
  71
  72 This is an open source project, so contributing is most welcome. If you want to contribute in any way, please drop me an
  73 email at:
  74 rynkruger@gmail.com
  75
  76 Copyright and License
  77
  78 Ipage is Distrebuted under the terms of the GNU General Public License version 3. You can view the license in the file
  79 License.txt. It boils down to this:
  80
  81 You may copy this program and give it to any one you like. You may modify the program as long as you state clearly which
  82 modifications are yours and give the source code to any one who wants it.
  83 You may not use the code in a close-source project without the permission of the copyright holder (yours truely)
  84
  85 Last updated by Rynhardt Kruger on March 17th, 2011
  86