home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 6 / The_Pier_Shareware_Number_6_(The_Pier_Exchange)_(1995).iso / 035 / pmuue11.zip / pmuue.doc next >
Text File  |  1994-12-02  |  9KB  |  200 lines
  1.                               PMUUE 1.1
  2.             Presentation Manager Unix-to-Unix Encoder/Decoder
  3.                           December 2, 1994
  4.  
  5. What is PMUUE?
  6. ==============
  7.  
  8. PMUUE stands for Presentation Manager Unix-to-Unix Encoder/Decoder.
  9. It is used to encode and decode Unix-to-Unix encoded files (commonly
  10. known as "uuencoded" files.)
  11.  
  12. Normally, it is not possible to send binary files over the Internet
  13. through newsgroups because of the possibility of non-ASCII charaters
  14. being lost or converted to other characters.  A utility, such as
  15. PMUUE, will convert a binary file into a set of ASCII characters
  16. ("uuencoded" format) which can be send through mail and converted back
  17. into binary format once the destination is reached.
  18.  
  19. The Disclaimer
  20. ==============
  21.  
  22. There is no warranty, expressed or implied, with this program.  THE
  23. AUTHOR IS NOT RESPONSIBLE FOR ANY DAMAGES INCURRED BY USING THIS
  24. PROGRAM.  Use at your own risk!
  25.  
  26. Distribution
  27. ============
  28.  
  29. This program may distribute this program as long as 
  30.  
  31. a)      The archived file from which the program came from is distributed
  32.         and not altered in any way.
  33. b)      This program is not distributed with any commercial program.
  34.  
  35. Parts of the PMUUE display
  36. ==========================
  37.  
  38. Besides the normal OS/2 system windows such as the title bar, the
  39. minimize and maximize buttons and the menu bar, there are two windows
  40. controlled by PMUUE and they are the log window and the status bar.
  41.  
  42. The log window is where any significant event has occured with regards
  43. to encoding or decoding a binary file.  Specifically, an entry is
  44. placed into the log window when:
  45.  
  46. -       A file is opened
  47. -       The process of encoding or decoding a file is started or finished
  48.  
  49. The log window keeps the last 500 events (by default) that has occured
  50. and deletes any log entries, starting from the oldest entry, that
  51. exceed the maximum number of entries allowed.  The log window
  52. automatically scrolls down to always show the latest event.
  53.  
  54. The status bar shows the last message sent to the log window but this 
  55. might change in future versions to include a progress indicator.
  56.  
  57. A dialog box appears whenever an encoding or decoding process is 
  58. complete if desired.
  59.  
  60. The Menu Options
  61. ================
  62.  
  63. The File Menu
  64. -------------
  65.  
  66. The file menu allows the user to encode a file, decode a file, or exit 
  67. the program.
  68.  
  69. When the user selects the "Encode..." menu option or presses Ctrl-E on 
  70. the keyboard, the user is presented with a dialog box.  This dialog 
  71. box allows the user to select the binary file that he or she wants to 
  72. encode into uuencoded format.  The user can only select one or many
  73. files.  If the user selects "Cancel", the operation is aborted.  If
  74. the user selects "OK", then the encoding process is started.  A dialog
  75. box will appear when the encoding process is over.  Select "OK" to
  76. dismiss the dialog box.
  77.  
  78. The way the program encodes file can be determined by the Settings
  79. notebook.
  80.  
  81. When the user selects the "Decode..." menu option or presses Ctrl-D on 
  82. the keyboard, the user is presented with a dialog box.  This dialog 
  83. box allows the user to select the encoded file that he or she wants to 
  84. decode back into a binary file.  The user can select as many files as 
  85. he or she wants.  If the user select "Cancel", the operation is 
  86. aborted.  If the user selects "OK", then the operation is started.  
  87. Once the decoding process is finished, a dialog box will appear.  
  88. Select "OK" to dismiss the dialog box.
  89.  
  90. An encoded file does NOT have to be stripped of extraneous text in 
  91. order for PMUUE to decode it.  Also, the encoded file also does NOT 
  92. have to be split up if it contains more than one uuencoded file.
  93. Even if the binary file is split into many uuencoded files, these
  94. uuencoded files do NOT have to be joined together into one file.
  95. PMUUE will (hopefully) be smart enough to determine which lines are
  96. encoded and which are not and when an encoded file starts and ends.
  97.  
  98. When the user select "Exit" or double-clicks on the system menu icon 
  99. or selects "Close" from the system menu, the program will terminate.
  100.  
  101. The Preferences Menu
  102. --------------------
  103. The preferences has only one option, "Settings..." which will tell the
  104. program how to act in particular situations.  For a full explanation
  105. of the "Settings..." option, see "The Settings Notebook" elsewhere in
  106. this file.
  107.  
  108. The Help Menu
  109. -------------
  110. NOTE: The help facility is by no means complete.  It should be
  111. complete in a future version of PMUUE.
  112.  
  113. When the user selects "Help index...", the user is presented with all
  114. the major topics in the help file.  Right now, there is only one item
  115. but this will change in a future version.
  116.  
  117. When the user selects "General Help...", the user sees the definitions
  118. of the major functions of this program.
  119.  
  120. When the user selects "Using Help...", a window with instructions on
  121. how to use help is presented.
  122.  
  123. When ther user select "Keys Help...", a window with valid keystrokes
  124. for the main window appears.
  125.  
  126. When the user select the "Product Information..." menu option, PMUUE 
  127. will show a dialog showing the program name and version as well as 
  128. other pertinent information about itself.
  129.  
  130. The Settings Notebook
  131. =====================
  132.  
  133. The settings notebook is divided into five pages: Notification, End of
  134. Line, Directories, Multi-part, and Miscellaneous.
  135.  
  136. The "Notification" page allows the user to select which output methods
  137. are used by the program.  The "Log" option specifies if the log window
  138. should be active.  The "Status Line" option specifies if the status
  139. line window should be used.  The "Message Box" option specifies if
  140. message windows should be used by the program for notification
  141. purposes.
  142.  
  143. The "End of Line" page specifies how an end-of-line marker should be
  144. like in a uuencoded file.  The "OS/2" option says that lines should
  145. end with a carriage return followed by a linefeed.  The "Unix" options
  146. says that lines should end with only a linefeed.
  147.  
  148. The "Directories" page specifies where the binary and uuencoded files
  149. should be and be placed.  The "Default Decode Directory" indicates
  150. where the binary files should be placed after decoding a uuencoded
  151. file.  The program will also look at that directory, by default, when
  152. starting up the "Encode..." menu option for the first time in the
  153. current session.  The "Default Encode Directory" indicated where the
  154. uuencoded files should be placed after encoding a binary file.  The
  155. program will also look at that directory, by default, when starting up
  156. the "Decode..." menu option for the first in the currect session.
  157.  
  158. This page also has a "Default File Extension" file.  This field is
  159. used to add an extension to a uuencoded file when creating a uuencoded
  160. file except when the "Create multiple part encoding" option is used.
  161.  
  162. The "Multi-part" page specifies if multi-part uuencoded files should
  163. be created or not.  The "Create multiple part encoding" option
  164. indicates if PMUUE should split binary files into multiple uuencoded
  165. parts.  If this option is checked, then the rest of the options on the
  166. page are enabled.  The "Max. part size in KB" option specifies that
  167. the maximum size of each part should be limited by its size in
  168. kilobytes.  The maximum size should be entered to the field
  169. immediately to the right of this option.  The "Max. part size in
  170. lines" options specifies that the maximum size of each part should be
  171. limited by its size in the number of lines it has.  The maximum size
  172. should be entered to the field to the right of this option.
  173.  
  174. The maximum number of parts for either method of partitioning the file
  175. is 99 parts.  Each part of the encoded file will have an extension of
  176. ".u##" where ## is a number between 01 and 99.
  177.  
  178. The "Miscellaneous" page has two fields on it.  The "INI File" field
  179. indicates the name of the INI file that PMUUE should create and use to
  180. hold its settings in.  The "Max Log Length" field is the maximum
  181. number of lines that should be allowed in the log window.
  182.  
  183. Future Considerations
  184. =====================
  185.  
  186. Here are some possible (but not limited to) future extensions to PMUUE
  187.  
  188. -       A full help facility
  189. -       A progress indicator
  190.  
  191. Any other ideas would be appreciated.
  192.  
  193. Contacting The Author
  194. =====================
  195.  
  196. I do not have a permanent mailing address as of yet so I cannot 
  197. include one in this documentation.  Happy encoding!
  198.  
  199. Colin Vernon
  200.