home *** CD-ROM | disk | FTP | other *** search
/ Die PSION Power-CD 2 / PsionPowerCD2.iso / PSION-Power-CD / software / Doku / tcr_r.txt < prev    next >
Text File  |  2000-02-29  |  5KB  |  134 lines
  1. TCR COMPRESSOR AND DECOMPRESSOR  v1.04
  2.  
  3. Here's C source and executable for creating and extracting TCR files.
  4.  
  5. TCR is a text compression format that's especially useful with Psion Series 3 
  6. and Series 5 machines: there are text viewers for both which can display TCR-
  7. compressed files directly (VReader or EBook for the 5, Reader for the 3).
  8.  
  9.  
  10.     SOURCE  (Those funny-looking files ending in .c)
  11.  
  12. The source code is included here so you can compile it for other machines.  
  13. It's written in C for the GCC compiler, and should be easily portable to 
  14. other compilers.
  15.  
  16. See the comments in the code for details on the format and algorithms.
  17.  
  18. A TCR-encoded version of this file is included for you to practice on :)
  19.  
  20.     INSTALLATION
  21.  
  22. This program requires STDLIB.SIS and ESHELL.EXE to run on EPOC. Both are
  23. supplied in the ZIP. For EPOC put the TCR.EXE into \SYSTEM\PROGRAMS\
  24. The Linux and Win32 versions do not require any other files.
  25.  
  26.  
  27.  
  28.     USAGE  (What do I with them?)
  29.  
  30. The program has a simple text interface, for versatility and portability.
  31.  
  32. The program takes one or more filenames on the command line, and (de)compresses 
  33. those files, creating appropriately named ones with a different 
  34. filename extension - .tcr for compressed files, .txt for uncompressed ones.
  35.  
  36. To decompress a TCR to text file use the -d option.
  37.  
  38. Filenames must be supplied using the / notation, not \. If you do not specify
  39. a directory then the files will go in the same location as the Executable, 
  40. i.e. \SYSTEM\PROGRAMS\
  41.  
  42.  
  43.     VERSION  (What's this version number thingy about?)
  44.  
  45. v1.00
  46.   First release.
  47.  
  48. v1.01
  49.   Fixed two rare bugs in the compressor.
  50.   Decompressor now handles zero codes properly.
  51.  
  52. v1.02
  53.   Various improvements.  The compressor is now slightly faster; the 
  54.   decompressor is about four times as fast.
  55.  
  56. v1.03
  57.   Fixed another rare bug in the compressor.  (Perhaps they're not so rare 
  58.   after all?)
  59.  
  60. v1.04
  61.   Merged TCR and unTCR into one program, use -d to decompress.
  62.   Ported to EPOC.
  63.   Changes by Simon Quinn
  64.   Issues - EPOC appears to have a problem allocating memory for files larger
  65.   than 1MBytes with the standard library. 
  66.   
  67.  
  68.     HISTORY  (Where's this `TCR' format from anyway?)
  69.  
  70. Ian Young originally designed a format called ZVR for a Psion text file 
  71. viewer - see http://ww.rats.demon.co.uk/zvr/, where there's also a program 
  72. called ZVRZ for the de/compression (including source).  Unlike most 
  73. compression formats, which need to be decompressed right from the beginning 
  74. each time, with ZVR you can restart anywhere, which is obviously much better 
  75. for a text viewer.  Compression is still quite good though - average saving 
  76. is about 50%, as compared with (very roughly) 65% for ZIP, although for 
  77. highly repetitive files, compression rates of over 80% aren't unheard-of.
  78.  
  79. When Barry Childress (73510.1420@compuserve.com) came to write a text file 
  80. viewer for the Psion Series 3, Reader3 (available on 
  81. http://3lib.ukonline.co.uk), he adapted the ZVR format slightly to make TCR 
  82. (Text Compression for Reader). He also included a compression program called 
  83. TCReader - this is very much faster than Ian's ZVRZ, but only runs on a PC.
  84.  
  85. The format has become quite popular in the Psion world, so that when Jean-Luc 
  86. Damnet (jldamnet@pca.fr) wrote his VReader5 viewer for the Series 5, he also 
  87. included TCR support.  (Currently at http://ady.net/psion/files/vr201.zip)
  88.  
  89. Meanwhile, although you could use TCR files on a Psion, you needed a PC to 
  90. create them, which was very awkward me as I've an Atari instead.  Barry 
  91. Childress wasn't keen on letting me have his source code, so in desperation I 
  92. decided to write my own!  (And don't I wish I hadn't :)  Although this 
  93. version uses some ideas from Ian's original ZVRZ, and some from interesting 
  94. discussions with pmaud@cix.co.uk, it's all my own work, and (in my very 
  95. biased opinion) is better than previous ones :)  So, with thanks to Ian and 
  96. Peter, and apologies to Barry, here's a version you can compile for your 
  97. machine.
  98.  
  99.     RESTRICTIONS  (What can I do with this?)
  100.  
  101. The code and executables are freeware - use and share them freely.  I 
  102. _encourage_ you to compile versions for your own machine, read them for 
  103. ideas, let me know of any bugs or improvements, etc.  However: you're not 
  104. allowed to make any money from them (except for reasonable distribution 
  105. costs, etc.), and if you do use my source code you must credit me and let me  
  106. know!  Reasonable?  (Monetary appreciation would be nice, too :)
  107.  
  108.  
  109.     CONTACT  (Who do I send money to?)
  110.  
  111. Questions, comments, bugs, ideas, etc. to:
  112.  
  113.         Andrew Giddings
  114.  
  115.         gidds@cix.co.uk
  116.  
  117.         1 Pavilion Close
  118.         Southend-on-Sea
  119.         Essex  SS2 4TZ
  120.         UK
  121.  
  122.  
  123.     GRATUITOUS GREETINGS
  124.  
  125. Thanks to Ian Young, Barry Childress and Jean-Luc Damnet for their programs.
  126.  
  127. Thanks and Hi to Peter Maud for explaining ZVRZ to me, Steve Litchfield for 
  128. putting this on 3-Lib, and Stephan Hradek for testing and ideas.
  129.  
  130.  
  131.         Andrew Giddings  16/Feb/2000.
  132.  
  133. Additional editing of this README by Simon Quinn.
  134.