home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / OSK / APPS / macutils.lzh / MACUTILS / MCVERT / mcvert.1 < prev    next >
Text File  |  1995-09-20  |  6KB  |  150 lines

  1. .TH MCVERT LOCAL "May 5, 1987"
  2. .UC 4.2
  3. .SH NAME
  4. mcvert \- BinHex 4.0 to MacBinary file conversion utility
  5. .SH SYNOPSIS
  6. .B mcvert
  7. [-options] name... [[-options] name...]...
  8. .br
  9. .SH DESCRIPTION
  10. The
  11. .I mcvert
  12. program translates MacIntosh files from one format to another.
  13. The primary formats in which MacIntosh files are represented on non-Macs are:
  14. .TP
  15. .B MacBinary:
  16. An eight bit wide representation of the data and resource forks of a Mac
  17. file and of relevant Finder information, MacBinary files are recognized
  18. as "special" by several MacIntosh terminal emulators.  These emulators,
  19. using Kermit or Xmodem or any other file transfer protocol, can separate
  20. the incoming file into forks and appropriately modify the Desktop to display
  21. icons, types, creation dates, and the like.
  22. .TP
  23. .B BinHex 4.0:
  24. A seven bit wide representation of a Mac file with CRC error checking,
  25. BinHex 4.0 files are designed for communication of Mac files over long
  26. distance, possibly noisy, seven bit wide paths.
  27. .TP
  28. .B PackIt:
  29. PackIt files are actually representations of collections of Mac files, possibly
  30. Huffman compressed.  Packing many small related files together before
  31. a MacBinary transfer or a translation to BinHex 4.0 is common practice.
  32. .TP
  33. .B Text:
  34. A MacIntosh ends each line of a plain text file with a carriage return
  35. character (^M), rather than the newline character (^J) that some systems
  36. seem to prefer.  Moreover, a MacBinary file has prepended Finder information
  37. that non-MacIntoshes don't need.
  38. .TP
  39. .B Data, Rsrc:
  40. A Data or Rsrc file is the exact copy of the data or resource fork of a
  41. MacIntosh file.
  42. .PP
  43. It is the purpose of this program to convert to the MacBinary format
  44. files in other of the above formats, and vice versa.
  45. .PP
  46. .SH PARAMETERS
  47. Exactly one of the following operations may be specified for an input name:
  48. .TP
  49. .B x
  50. BinHex 4.0 - files in the MacBinary format are translated to BinHex
  51. files, or vice versa.  The name argument may be the name of a file to be
  52. converted or a basename to which an appropriate suffix must be appended
  53. to get a filename.  If the conversion is from Binhex 4.0 to MacBinary,
  54. several files may comprise the BinHex representation of the Mac file.
  55. Rather than manually concatenate the files and manually delete mail
  56. headers and other extraneous garbage, one may specify the names of the
  57. files in order and
  58. .I mcvert
  59. will do the concatenating and deleting.  Conversely, in converting
  60. a MacBinary file to BinHex 4.0 format for mailing over long distances,
  61. one may be restricted to mail messages of no greater that some fixed
  62. length.  In this case,
  63. .I mcvert
  64. can automatically divide the BinHex file into pieces and label each
  65. piece appropriately.
  66. Option 'x' is selected by default.
  67. .TP
  68. .B r
  69. Resource - files in the MacBinary format with empty data forks
  70. and nonempty resource forks are made from ordinary data files, or vice versa.
  71. .TP
  72. .B d
  73. Data - files in the MacBinary format with nonempty data forks
  74. and empty resource forks are made from ordinary data files, or vice versa.
  75. .TP
  76. .B u
  77. Text - files in the MacBinary format with nonempty data forks
  78. and empty resource forks are made from ordinary data files, or vice versa.
  79. Unix newline
  80. characters are interchanged with MacIntosh carriage return
  81. characters, and a newly created MacBinary file has creator field given by
  82. the MAC_EDITOR environment variable.
  83. .PP
  84. .SH OPTIONS
  85. .TP
  86. .B p | q
  87. If a BinHex to MacBinary conversion is taking place and option 'p' is selected,
  88. any file of type "PIT "
  89. will be unpacked into its constituent parts.  This option does not recursively
  90. unpack "PIT " files packed in "PIT " files.
  91. If a MacBinary to BinHex conversion is taking place, this option is currently
  92. ignored.  By default, option 'q' is selected.
  93. .TP
  94. .B U | D
  95. When option 'U' is selected, the conversion that takes place is the one suitable
  96. for Uploading files.  That is, the conversion is from MacBinary to something
  97. else when 'U' is selected.  Conversely, option 'D', as in Download,
  98. converts from something to MacBinary.  Option 'D' is the default.
  99. .TP
  100. .B s | v
  101. Normally,
  102. .I mcvert
  103. prints to stderr information about the files it is creating.  Selecting
  104. option 's', as in silent, disables this reporting.  Option 'v', for verbose,
  105. is the default.
  106. .SH "ENVIRONMENT VARIABLES"
  107. There are four environment variables one may use to customize 
  108. the behavior of
  109. .I mcvert
  110. slightly.
  111. .TP
  112. .B MAC_EDITOR
  113. The creator of MacBinary text files produced with options -uD.  
  114. The default is MACA, the creator type of MacWrite.
  115. .TP
  116. .B MAC_DLOAD_DIR
  117. The MacBinary files created when option -D is selected are placed in this
  118. directory.  The default is ".", the current working directory.
  119. .TP
  120. .B MAC_EXT
  121. The MacBinary files created when option -D is selected are named according
  122. to the filename field stored in the file header, with the name extended by
  123. this suffix.  The default is ".bin".
  124. .TP
  125. .B MAC_LINE_LIMIT
  126. The BinHex files created when option -U is selected may be no longer than
  127. this many lines long.  Files that would otherwise exceed this line limit
  128. are broken up into several files with numbers embedded into their file 
  129. names to show their order.  Each such file has "Start of part x" and "End
  130. of part x" messages included where appropriate.
  131. .SH BUGS
  132. It should be possible to discard bad input now and successfully translate
  133. good input later, but bad input mostly just causes immediate termination.
  134. .PP
  135. A more diligent person would support BinHex 3.0 and BinHex 2.0 and BinHex
  136. 5000.0 B. C., but I've never seen anyone use them in three years.  A
  137. more diligent person would also do something for users of macget and
  138. macput, but hopefully someone will make those programs support the
  139. MacBinary file protocol.
  140. .SH SEE ALSO
  141. xbin(1), macget(1), macput(1), xmodem(1), kermit(1)
  142. .SH AUTHOR
  143. Doug Moore, Cornell University Computer Science.  Based upon
  144. .I xbin
  145. by Dave Johnson, Brown University, as modified by Guido van Rossum, and upon
  146. .I unpit
  147. by Allan G. Weber, as well as upon correspondence with several helpful
  148. readers of USENET.
  149.  
  150.