home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / mac / util / unix / mcread1.tz / mcread1 / mcREADME < prev    next >
Encoding:
Text File  |  1991-06-26  |  5.7 KB  |  120 lines
  1. mcread 1.0
  2. (C)1991 by Mike Gleason Jr... NCEMRSoft, Baby!
  3.  
  4. Purpose
  5.  
  6. The primary goal of mcread is to decode binary MacWrite(tm) files and display
  7. the readable text on other platforms.  A secondary goal is to display plain
  8. text and TeachText files originally created on a Macintosh.
  9.  
  10. mcread can deal with both MacBinary files (usually those ending with .bin) and
  11. raw files, but it prefers MacBinary files, because it can then tell exactly
  12. what type of file it's up against, and if it can decode it.  As a small
  13. example, let's say that you want to get some files off of FTP, and download
  14. them to your mac.  Usually those files are ascii files in the BinHex 4.0
  15. standard.  So you get mcvert* and decode the BinHex (.hqx) file into a smaller
  16. MacBinary file (.bin).  Further, let's assume the decoded file was a Stuffit
  17. archive, so it will have the suffix ".sit.bin."  You could go ahead and
  18. download the compressed file to your mac, but why waste your own valuable CPU
  19. time :-)  You also decode the Stuffit(tm) archive using unsit**, and it will
  20. produce a whole nasty of mess of files ending in .data, .info, .rsrc.  Next
  21. you need to convert these files into MacBinary files, and to do that you use
  22. macbin.*  Finally, you have decoded all the files on your remote machine.  But
  23. why stop there?  You can go ahead and read the documentation on the remote
  24. machine, instead of having to launch you favorite megamemoryhogmocious word
  25. processor just to read a 2K "README."  This is where mcread comes in.  You
  26. simply type "mcread README.bin" and bingo, you peruse the README instantly. 
  27. In fact, if you are looking at the file "mcREADME," then you are looking at an
  28. example of mcread's work, which was done by "mcread MACAtest.bin > mcREADME"
  29. on a un*x machine.
  30.  
  31. *mcvert, unsit, and macbin should be in the same directory as mcread was when
  32. you download it.  If not, you can get them via FTP to sumex-aim.stanford.edu
  33. (IP address is 36.44.0.6), in the /info-mac/unix directory.
  34.  
  35. **someone really should work on unsit so it produces MacBinary files in the
  36. first place, and have the option to delete the archive after decoding.  mcvert
  37. should delete those damned binhex's when it finishes too... but I digress.
  38.  
  39. Options
  40.  
  41. *   -pN: puts mcread in paging mode, prompting you every N lines.  The default
  42. value for N is 23.  A better idea though, would be to pipe the output into a
  43. real pager, like "less."
  44.  
  45. *   -wN: Do you have a pud terminal that only displays 40 characters?  Or
  46. maybe you think you're bad because you can display 132 or more characters on a
  47. line.  You can make mcread wordwrap to any (reasonable) length, by specifying
  48. -w.  The default is 78.
  49.  
  50. *   -tN: Let's mcread know how many spaces a tab should equal.  If you don't
  51. specify -t, mcread assumes N = 4.
  52.  
  53. Additional Features
  54.  
  55. *   If there is a picture embedded in the MacWrite or TeachText file, it let's
  56. you know by sticking in a "### picture omitted" message.
  57.  
  58. *   Since a fair number of Mac files contain extended characters, mcread makes
  59. a modest effort to convert them into printable 7 bit ASCII.  As examples, the
  60. bullet character * is replaced by an asterisk, "smart" quotes are lobotomized,
  61. and things like the trademark character get mapped to a string of characters:
  62. (tm). Obviously there are going to be some side effects, like un-English
  63. characters such as the German umlauted characters being stripped of their
  64. umlauts.  Had mcread been a half-assed effort, it would have just omitted or
  65. stripped the 8th bit, so consider yourself lucky ;-)
  66.  
  67. *   The tab substitution feature isn't just going to tack on 'N' spaces, it
  68. treats them as tab stops, so things will line up nicely.  This would be handy
  69. if you're planning on mcread'ing a whole bunch of Technical Notes with a
  70. buttload o' code in them.
  71.  
  72. *   If you pass -t0 for the tab substitution, it doesn't output any spaces,
  73. instead it goes ahead and puts out the tab character.
  74.  
  75. *   While mcread is not intended to provide an exact replica of the document,
  76. it's not like the Mac DA "QRead" either, where it just barfs characters
  77. (nothing against QRead of course).  The output is word-wrapped and has tab
  78. stops, so it should not be an eyestrain to read.
  79.  
  80. Caveats
  81.  
  82. *   mcread only reads MacWrite 4.5 files.  It doesn't read the way older 2.2
  83. format, and I assume it won't read Claris' MacWrite II format.  But since 50%
  84. of the documentation distributed with mac software is MW 4.5 format, and the
  85. other 40% plain TEXT format, I don't think it will cause much of a problem.
  86.  
  87.  
  88. Future
  89.  
  90. I hope this isn't the end of mcread.  I think at the bare minimum, Microsoft
  91. Word support should be added.  MacWrite 2.2 support could be added, if someone
  92. else beats me to it, or if there is an insane amount of registrations.  Other
  93. word processors could be added, like WriteNow and FullWrite, and maybe other
  94. things like PageMaker and MS-DOS word processors.  I've sort of started
  95. working on mcread so it will take input from stdin, but I haven't seen a
  96. personal need for it so I've suspended it.  Other things could be done, like
  97. turning on ANSI codes for bold-faced text and such, I suppose.
  98.  
  99. ScholarshipWare?
  100.  
  101. This is Un*x ShareWare.  If you use this tool, you can show your gratitude in
  102. one or both of the following ways:
  103.  
  104. 1.  Whip out a 1$US bill (or the equivalent foreign currency; I like foreign
  105. coins) and mail it to the address below; It's only a dollar, and it goes
  106. towards a good cause: my tuition!
  107.  
  108. 2.  Mail me a short note written on your company stationery saying how useful
  109. this is to you, blah, blah, blah.  This is for the scholarship committee here
  110. at the University of Nebraska; If I can hand in a bunch of these letters with
  111. my scholarship form, they'll be impressed, and maybe give me a grant!
  112.  
  113. Thanks!!!
  114.  
  115. ### picture omitted!
  116.     Mike Gleason Jr.
  117.     5705 North 117th Plaza
  118.     Omaha, NE 68164
  119.     U.S.A.
  120.