home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 110 / af110sub.adf / Aread.lzx / aread / ARead.doc < prev    next >
Text File  |  1998-05-16  |  7KB  |  260 lines

  1.  
  2.  
  3.                            ARead v1.3
  4.  
  5.                            (6/3/1998)
  6.  
  7.                          By Cliff Earl.
  8.  
  9.                       (cee@voyager.co.nz)
  10.  
  11.                        © 1998 Cliff Earl.
  12.  
  13.  
  14. Introduction.
  15.  
  16.   I  only  have a lowly 68000 in my old A2000.  Now if I have a
  17. little textfile that is only 1k or so in size, it seems to take
  18. forever  for multiview to load and display it.  I created ARead
  19. to rectify this problem.
  20.  
  21.   If  you  double  clicked  the ARead.doc icon (the little itty
  22. bitty one) straight from the distribution drawer and if you did
  23. not  notice  already, ARead is being used to read this document
  24. :^)
  25.  
  26.   As  of  v1.2  Aread  will  change  TABS  and CR (peecee style)
  27. characters  into  spaces.   It  just  makes things look a little
  28. nicer.
  29.  
  30.   Please  note  that  when  you see a version number in brackets
  31. eg..   (v1.2)  then  this  feature  was  added  to ARead at that
  32. version.
  33.  
  34.   ARead  as mentioned above is made for reading small textfiles
  35. like  aminet .readme files and file_id.diz files.  A few things
  36. to remember when using ARead are..
  37.  
  38.  
  39.  - ARead  will  load  any sized file but will  not display more
  40.    than 16000 lines.
  41.  
  42.  - ARead will NOT wordwrap any lines in the textfile.
  43.  
  44.  - ARead  does not like lines of text that are longer  than 254
  45.    characters. Strange behaviour may occur :^)
  46.  
  47.  - ARead does not like multi coloured text (ANSI).
  48.  
  49.   As  you  can  see ARead is not such a powerful text reader, I
  50. made  it  only  to  suit  my own needs.  If you think ARead has
  51. potential and would like to see more options and features added
  52. then please contact me with your requests.  I am only too happy
  53. to  add  things  to ARead for you, you just have to let me know
  54. what you want.
  55.  
  56. you want search function?
  57.  
  58. you want wordwrap?
  59.  
  60. you want xpk support?
  61.  
  62. you want menus?
  63.  
  64. you want iconify?
  65.  
  66. you want a rexx port?
  67.  
  68. you want multicolour support?
  69.  
  70. you want filerequesters? - ADDED AS OF V1.1
  71.  
  72. you want drag'n'drop?
  73.  
  74. what do you want?
  75.  
  76. I want a new Amiga :^)
  77.  
  78. Enjoy..
  79.  
  80.  
  81.          ********************************************
  82.  
  83.  
  84. Installing ARead.
  85.  
  86.  - copy  ARead  to  C:  or somewhere  in your path.  Or for lazy
  87.    people you can just use the installer script.
  88.  
  89.  
  90.          ********************************************
  91.  
  92.  
  93. Using ARead.
  94.  
  95.   Before the real meat here are what key combo's do what things
  96. when ARead is running..
  97.  
  98. CURSORUP..............previous line
  99.  
  100. CURSORDOWN............next line
  101.  
  102. SHIFT+SPACE...........previous page (v1.2)
  103.  
  104. SHIFT+CURSORUP........previous page
  105.  
  106. SHIFT+CURSORDOWN......next page
  107.  
  108. SPACE.................next page (v1.2)
  109.  
  110. CONTROL+CURSORUP......first page
  111.  
  112. CONTROL+CURSORDOWN...last page
  113.  
  114. ESCAPE................quit
  115.  
  116. Using ARead from Workbench.
  117.  
  118.   First  change  the default tool of the project you want ARead
  119. to  read  on to C:ARead (or wherever you put it.  Next add some
  120. tooltypes to get ARead looking how you want it.  You don't have
  121. to  add tooltypes if you want the default values.  Here are the
  122. tooltypes that ARead will understand.
  123.  
  124. PUBSCREEN
  125. Name  of the public screen that you would like ARead to open on.
  126. If  the  screen  is  not  open  then  ARead will fallback to the
  127. default public screen (usually Workbench).
  128.  
  129. FONTNAME
  130. Name  of  the  font  that you want ARead to use when displaying
  131. text.  Default=font of screen ARead opened on.
  132.  
  133. FONTSIZE
  134. Height of the font you specified. Default=8.
  135.  
  136. LEFT
  137. X-Position of ARead window. Default=0
  138.  
  139. TOP
  140. Y-Position of ARead window. Default=16
  141.  
  142. WIDTH
  143. Width of ARead window. Default=640
  144.  
  145. HEIGHT
  146. Height of ARead window. Default=240
  147.  
  148.  
  149. Using ARead from Shell/CLI.
  150.  
  151. I'm getting tired, so we will just put an example here..
  152.  
  153. ARead docs:aread.doc FONTNAME=xen.font FONTSIZE=11
  154.  
  155.   Easy  huh?   The  arguments  that  ARead  can  understand are
  156. exactly the same as the tooltypes above, and the default values
  157. are also the same.
  158.  
  159.   If  the  font  you  specified is not available then ARead will
  160. attempt  to  use  the font of the screen it opened on (sc_Font).
  161. If  this  also fails then ARead will use the system default font
  162. (gb_DefaultFont).
  163.  
  164.   As  of V1.1, you don't have to specify a filename when running
  165. ARead  from CLI/Shell.  If no name was specified then ARead will
  166. open  an ASL FileRequester so you can choose which file you want
  167. to  read.  You can also just double click on the Aread icon from
  168. Workbench and the FileRequester will open as well.
  169.  
  170.  
  171.          ********************************************
  172.  
  173.  
  174. Legal Crap.
  175.  
  176.   This  program  is FreeWare.  You don't have to send money and
  177. stuff  but  you  can if you like.  I take no responsability for
  178. any  damage  caused  to  whatever by using the programs in this
  179. distribution.   You  can  give the program to any old human but
  180. you  are not allowed to charge money for it.  Magazines are not
  181. allowed  to distribute the programs without prior permission of
  182. the  author (that's me) or they must send me a free copy of the
  183. magazine/coverdisk that contains the programs.
  184.  
  185.  
  186.          ********************************************
  187.  
  188.  
  189. How To Contact Me.
  190.  
  191. You can send me stuff by post to..
  192.  
  193.     Cliff Earl,
  194.     P.O Box 159,
  195.     Otaki,
  196.     Wellington 6471,
  197.     New Zealand.
  198.  
  199. You can EMail (suggestions, bug-reports, whatever) to..
  200.  
  201.     cee@voyager.co.nz
  202.  
  203. Still  no WWW page, I'm so lazy and my poor old Ami can't handle
  204. the InterNet except for EMail & FTP :^(
  205.  
  206.  
  207.          ********************************************
  208.  
  209. Credits.
  210.  
  211.                 - written and assembled with -
  212.  
  213.                          ASM-One v1.30
  214.                            By T.F.A
  215.                          no copyright?
  216.  
  217.  
  218.          ********************************************
  219.  
  220. History.
  221.  
  222. v1.0 (21/2/1998)
  223.  
  224.   - first public release
  225.  
  226. v1.1 (4/3/1998)
  227.  
  228.   - Added ASL FileRequest if no name  specified from shell or if
  229.     ARead  is  not  started  from  WB  as  the default tool of a
  230.     project.   (Requested  by Nils Goers, thanks for the example
  231.     ASL code Nils).
  232.  
  233.   - Added  ability to open on specified PubScreen (Requested  by
  234.     Nils Goers).
  235.  
  236.   - Changed fallback font from topaz.font to default system font
  237.     (Requested by Nils Goers).
  238.  
  239. v1.2 (5/3/1998)
  240.  
  241.   - Changed  fallback  font  code  again.   Now  if  no font  is
  242.     specified  or  if  the  specified font cannot be opened then
  243.     ARead  will  try  to use the font of the screen it opens on.
  244.     If  this  too fails then you get the default system font ala
  245.     graphics library gb_DefaultFont.  (Requested by Nils Goers).
  246.  
  247.   - Changed  some dcb.b data to ds.b bss to save  some space and
  248.     keep ARead under 4kb in size.
  249.  
  250.   - Added  code  to  formatter to make ARead replace CR and  TAB
  251.     characters into spaces.
  252.  
  253. v1.3 (6/3/1998)
  254.  
  255.   - Corrected  small feature when ARead is run from CLI  with no
  256.     arguments.   Previously ARead would open it's file requester
  257.     in  the  SYS:   directory.  Now ARead opens the requester in
  258.     the current directory.
  259.  
  260.