home *** CD-ROM | disk | FTP | other *** search
/ Computer Buyer 1996 May / buyer-0596.iso / internet / encode / esscode.txt < prev    next >
Text File  |  1995-07-02  |  45KB  |  1,026 lines

  1.   --------------------------------------------------------------------------
  2.   ESS-Code 6.6                                     \  \  \  \  \  \  \  \  \
  3.   Electric Storm Software                          /  /  /  /  /  /  /  /  /
  4.   Copyright 1993, 1994, 1995, Michel Forget       /  /  /  /  /  /  /  /  /
  5.   --------------------------------------------------------------------------
  6.                                    ========
  7.                                    CONTENTS
  8.                                    ========
  9.  
  10.               1.  Introduction
  11.  
  12.               2.  Registration
  13.                   a) Registration Information
  14.                   b) Registration Form
  15.                   c) United Kingdom Registration Form
  16.  
  17.               3.  ESS-Code Version Information
  18.                   a) The Windows Version
  19.                   b) The WindowsNT/Windows 95 Version
  20.                   c) The DOS Version
  21.                   d) The Atari Version
  22.  
  23.               4.  Distribution
  24.  
  25.               5.  Disclaimer
  26.  
  27.               6.  Contacting Electric Storm Software
  28.  
  29.               7.  Using ESS-Code
  30.                   a. System Requirements
  31.                   b. The Windows Version (16-BIT & 32-BIT Versions)
  32.                      I)    Introduction
  33.                      II)   The Menu
  34.                      III)  The Servers
  35.                   c. The DOS Version
  36.                      I)     Introduction
  37.                      II)    Common Parameters
  38.                      III)   Unique Parameters
  39.                             i)   MIME.EXE
  40.                             ii)  UNMIME.EXE
  41.                             iii) SHIP.EXE
  42.                             iv)  UUE.EXE
  43.                      IV)    Help
  44.  
  45.               8.  Acknowledgements
  46.  
  47.               9.  Third Party Copyrights
  48.         
  49. =============================================================================
  50. 1. INTRODUCTION
  51. =============================================================================
  52.  
  53.      ESS-Code is an application designed to allow computer users to exchange
  54. binary files across computer networks that do not support the transmission 
  55. of binary information.  This task is accomplished by converting the binary 
  56. file to an ASCII file, then converting the ASCII file back to its original 
  57. state after transmission.
  58.  
  59.      There are four popular methods of conversion, each of which is named 
  60. after the part of the process that performs the conversion; UUE, MIME, BTOA, 
  61. and SHIP.  Since each of these conversion methods is an accepted standard, 
  62. there are a wide variety of encoding/decoding utilities available for every 
  63. major computer platform, including UNIX, Macintosh, Amiga, Atari, and many 
  64. more.
  65.  
  66.      Why should you use ESS-Code instead of one of the many other utilities 
  67. currently available?  There are many reasons:
  68.     
  69.      1)  SPEED            - ESS-Code is much faster than other coding
  70.                             programs that I have tested.  In some cases, the
  71.                             difference in speed is as much as 40%!  ESS-Code
  72.                             was tested against several major Shareware
  73.                             applications, and not one of them was faster.
  74.                              
  75.      2)  COMPATIBILITY    - There are versions of ESS-Code available for DOS, 
  76.                             Windows, WindowsNT, and Windows95.  The 
  77.                             conversion methods used by ESS-Code are standard, 
  78.                             meaning that you can use other conversion
  79.                             programs on other platforms (UNIX, Amiga, Atari,
  80.                             & Macintosh) to process files that have been
  81.                             converted with ESS-Code.  
  82.  
  83.      3)  OPTIONS          - ESS-Code was written with the needs of the user
  84.                             in mind.  There are a host of user-configurable 
  85.                             options that can be set to affect how output is 
  86.                             generated, how ESS-Code behaves, and even how 
  87.                             ESS-Code looks.
  88.  
  89.      4)  FLEXIBILITY      - ESS-Code supports UUE, BTOA, SHIP, MIME, File 
  90.                             Splitting, File Joining, and more.  All of your 
  91.                             file conversion needs are handled by one
  92.                             application.
  93.  
  94.      5) BINARY NEWSGROUPS - Many USENET discussion groups (newsgroups) --
  95.                             those with the word "binaries" in the name --
  96.                             encode messages so that they can be distributed
  97.                             to the public.
  98.  
  99.      6) ONLINE SERVICES   - Do you have a Genie, CompuServe, or AOL account?
  100.                             Many online services do not provide a way to
  101.                             send a file to another user in electronic mail,
  102.                             or charge for this service.  If this is the case,
  103.                             the file in question can be processed with
  104.                             ESS-Code.
  105.  
  106.      [The following two considerations only apply to the Windows version.]
  107.  
  108.      7)  APPEARANCE    - ESS-Code is a Windows application, which means that 
  109.                          it makes extensive use of menus, dialog boxes, and 
  110.                          graphical output.  You are not required to remember 
  111.                          any command line parameters, or type needlessly.  
  112.                          Since ESS-Code is a Windows application, you can 
  113.                          also access other programs while ESS-Code is 
  114.                          performing a conversion, or perform more than one 
  115.                          conversion at once.
  116.    
  117.      8)  HELP          - As you would expect of any application written for 
  118.                          the Windows environment, ESS-Code has extensive
  119.                          online help.  You can read the documentation 
  120.                          online, search for keywords, and find information 
  121.                          quickly when needed.  
  122.  
  123. =============================================================================
  124. 2. Registration
  125. =============================================================================
  126.  
  127. -------------------------------
  128. - a) Registration Information -
  129. -------------------------------
  130.  
  131. OR:  Is this program worth $15.00 to me?
  132.  
  133.      If you believe that ESS-Code is a quality product and would like to
  134. receive the registered version of the software, please send $15 (US/CDN)
  135. to:
  136.  
  137.      Michel Forget (RE: PC)
  138.      12209 Dovercourt Avenue
  139.      Edmonton, Alberta
  140.      CANADA
  141.      T5L 4E1
  142.  
  143.      If you send a cheque to the address listed above, please make it payable
  144. to Michel Forget.
  145.  
  146.      If you do not live in North America (and you are writing to this address
  147. instead of the address for users in the United Kingdom), please send an
  148. international money order or the equivalent of $15 in your own currency.
  149. Please do not send a personal cheque unless you live in North America.
  150.  
  151.      For your convenience, we have included a registration form which can be
  152. printed for easier (and very likely quicker) service.
  153.  
  154.      If you live in the United Kingdom, you can send your registration (10 UKP)
  155. to:
  156.  
  157.      ESS-PC (c/o Denesh Bhabuta)
  158.      203 Parr Lane
  159.      Unsworth
  160.      Bury
  161.      Lancashire
  162.      BL9 8JW
  163.  
  164.      If you send a cheque to the address listed above, please make it payable
  165. to Denesh Bhabuta.
  166.  
  167.      For your convenience, we have included a United Kingdom registration
  168. form for those who live in the United Kingdom.
  169.  
  170. ------------------------
  171. - b) Registration Form -
  172. ------------------------
  173.  
  174.      You do not need to print this form to register.  It is provided for
  175. your convenience only.  If you do not have a printer, or simply do not wish
  176. to print this form, simply send your name, address, and registration fee to 
  177. the address listed below.
  178.  
  179. TO:    Michel Forget (RE:  PC)
  180.     12209 Dovercourt Avenue
  181.     Edmonton, Alberta
  182.     CANADA
  183.     T5L 4E1
  184.  
  185. Dear Michel,
  186.  
  187.      I am sending you $15.00 (US/CDN) as my registration fee for ESS-Code.
  188. Please send me a key that I can use to unlock all current and future versions
  189. of ESS-Code.
  190.  
  191. Name:        ____________________________________
  192. Address:    ____________________________________
  193.         ____________________________________
  194.         ____________________________________
  195.         ____________________________________
  196.         ____________________________________
  197.  
  198.      If you supply an Internet electronic mail address, your key will me sent to
  199. you by electronic mail (in addition to being sent through normal paper-mail.
  200.  
  201. E-Mail:        [Internet]
  202.         ______________________________________________________
  203.         [Other]
  204.         ______________________________________________________
  205.  
  206. [________]     Please send a note to my Internet electronic mail address
  207.                 when new versions of ESS-Code are released.
  208.  
  209.      Please feel free to use the space provided below to record your comments,
  210. suggestions, or bug reports (if any):
  211.  
  212. (insert as much space as you need before printing - we love feedback)
  213.  
  214. ---------------------------------------
  215. - c) United Kingdom Registration Form -
  216. ---------------------------------------
  217.  
  218.      You do not need to print this form to register.  It is provided for your 
  219. convenience only.  If you do not have a printer, or simply do not wish to 
  220. print this form, simply send your name, address, and registration fee to the 
  221. address listed below.
  222.  
  223. TO:    ESS-PC (c/o Denesh Bhabuta)
  224.     203 Parr Lane
  225.     Unsworth
  226.     Bury
  227.     Lancashire
  228.     BL9 8JW
  229.  
  230. Dear Denesh,
  231.  
  232.      I am sending you 10 UKP as my registration fee for ESS-Code.  Please 
  233. send me a key that I can use to unlock all current and future versions of 
  234. ESS-Code.
  235.  
  236. Name:        ____________________________________
  237. Address:    ____________________________________
  238.         ____________________________________
  239.         ____________________________________
  240.         ____________________________________
  241.         ____________________________________
  242.  
  243.      If you supply an Internet electronic mail address, your key will me sent
  244. to you by electronic mail (in addition to being sent through normal 
  245. paper-mail.
  246.  
  247. E-Mail:        [Internet]
  248.         ______________________________________________________
  249.         [Other]
  250.         ______________________________________________________
  251.  
  252. [________]     Please send a note to my Internet electronic mail address 
  253.                 when new versions of ESS-Code are released.
  254.  
  255.      Please feel free to use the space provided below to record your
  256. comments, suggestions, or bug reports (if any):  Your comments will be
  257. forwarded to Electric Storm Software.
  258.  
  259. (insert as much space as you need before printing - we love feedback)
  260.  
  261. =============================================================================
  262. 3. ESS-Code Version Information
  263. =============================================================================
  264.  
  265.      There are several distinct versions of ESS-Code available, each serving
  266. a different operating environment but sharing a common version number.  The
  267. archive you received this manual with will contain only one version of
  268. ESS-Code.  If you should desire another of the available versions of
  269. ESS-Code, it should be available where you found this archive under one of
  270. the following filenames:
  271.  
  272.      THE WINDOWS VERSION                   ECD66WIN.ZIP
  273.  
  274.      THE WINDOWS 95 / WINDOWS NT VERSION   ECD66W95.ZIP
  275.  
  276.      THE DOS VERSION                       ECD66DOS.ZIP
  277.  
  278.      THE ATARI VERSION                     ECD64ATR.ZIP
  279.                                            ESSCD64.ZIP
  280.  
  281.      The Windows version of ESS-Code can be used with WindowsNT and/or
  282. Windows95.  The DOS version, of course, can be used with any Windows
  283. platform.  If you are using OS/2, you may use either the DOS or Windows
  284. versions of ESS-Code.
  285.  
  286. =============================================================================
  287. 4. Distribution
  288. =============================================================================
  289.  
  290.      The unregistered version of ESS-Code may be distributed with the 
  291. following limitations:
  292.  
  293.     GENERAL
  294.  
  295.              ESS-Code may be distributed free of charge; there can be no fee 
  296.         charged for the distribution of ESS-Code other than reasonable media 
  297.         charges.  ESS-Code may only be distributed in its entirety -- the 
  298.         archive format may be changed, but all of the files in the original 
  299.         archive must be included in the new archive.
  300.  
  301.     MAGAZINES
  302.  
  303.              ESS-Code may be included on disks or CD-ROMs included with (or 
  304.         sold by) magazines without permission, providing that a courtesy 
  305.         copy of the magazine (and media) is sent to Electric Storm Software 
  306.         and all other rules of distribution are adhered to.
  307.  
  308.     CD-ROM SOFTWARE COLLECTIONS
  309.  
  310.              ESS-Code may be included on CD-ROM collections, providing that
  311.         all rules of distribution are adhered to.  A courtesy copy of the
  312.         media would but sincerely appreciated, but is not manditory.
  313.  
  314.      The limitations specified in this section are not designed to interfere 
  315. with you; they are designed to protect the interests of Electric Storm 
  316. Software.  If there are any questions about these limitations, please do not 
  317. hesitate to contact Electric Storm Software.
  318.  
  319. =============================================================================
  320. 5. Disclaimer
  321. =============================================================================
  322.  
  323.      ESS-CODE ("THE SOFTWARE") DOES NOT COME WITH ANY WARRANTY, EXPRESS OR 
  324. IMPLIED.  IF YOU MAKE USE OF THE SOFTWARE, PLEASE BE AWARE THAT YOU DO SO AT 
  325. YOUR OWN RISK.  NEITHER THE AUTHOR OF THE SOFTWARE (MICHEL FORGET) NOR ANY 
  326. OTHER PARTY WILL ACCEPT RESPONSIBILITY FOR ANY DATA LOSS, EQUIPMENT DAMAGE, 
  327. OR OTHER UNFORESEEN CONSEQUENCES OR DAMAGES THAT ARISE AS A RESULT OF THE 
  328. USE OR MISUSE OF THE SOFTWARE.
  329.  
  330. =============================================================================
  331. 6. Contacting Electric Storm Software
  332. =============================================================================
  333.  
  334.      Programming:     Michel Forget
  335.      Design Testing:  Mike Bublitz
  336.  
  337.      If you would like to contact Electric Storm Software, please send an 
  338. electronic mail message to mforget@worldgate.com or mbublitz@worldgate.com 
  339. -- your message will be answered promptly.  If you would like to contact 
  340. Electric Storm Software in writing, either for the purposes of registration 
  341. or to offer comments or suggestions, please write to:
  342.  
  343.      Michel Forget (RE: PC)
  344.      12209 Dovercourt Avenue
  345.      Edmonton, Alberta
  346.      CANADA
  347.      T5L 4E1
  348.  
  349. =============================================================================
  350. 7. Using ESS-Code
  351. =============================================================================
  352.  
  353. --------------------------
  354. - a. System Requirements -
  355. --------------------------
  356.  
  357.      ESS-Code is not an application that will consume the resources of your
  358. system.  If you would like to use ESS-Code on your system, you should have:
  359.  
  360.      DOS Version
  361.  
  362.           DOS >= 3.3
  363.  
  364.      Windows 3.1/3.11 16-BIT Version
  365.  
  366.           DOS >= 3.3
  367.           Windows >= 3.1
  368.           VGA (>=16 Colours)
  369.  
  370.      Windows95/WindowsNT 32-BIT Version
  371.  
  372.           80386 Processor
  373.           Windows 95/WindowsNT
  374.           VGA (16 Colours)
  375.  
  376. -----------------------------------------------------
  377. - b. The Windows Version (16-BIT & 32-BIT Versions) -
  378. -----------------------------------------------------
  379.  
  380.      INTRODUCTION
  381.  
  382.      The purpose of this section of the manual is to describe what each of
  383. the features of ESS-Code does, and how to use them.
  384.  
  385.      ESS-Code is an application designed to allow computer users to exchange
  386. binary files across computer networks that do not support the transmission 
  387. of binary information.  This task is accomplished by converting the binary 
  388. file to an ASCII file, then converting the ASCII file back to its original 
  389. state after transmission.
  390.  
  391.      There are four popular methods of conversion, each of which is named 
  392. after the part of the process that performs the conversion; UUE, MIME, BTOA, 
  393. and SHIP.  Since each of these conversion methods is an accepted standard, 
  394. there are a wide variety of encoding/decoding utilities available for every 
  395. major computer platform, including UNIX, Macintosh, Amiga, Atari, and many 
  396. more.
  397.  
  398.      The ESS-Code "client" (the shell that you work with) is a Windows
  399. application; this means that you communicate with the client using menus,
  400. dialog boxes, message boxes, and the mouse.  The results of your actions
  401. are shown in the application window in a summarized graphical format.
  402.  
  403.      DRAG & DROP SUPPORT
  404.  
  405.         ESS-Code, like many other applications available, allows you to drag
  406. a file from the program manager (or explorer) to the ESS-Code application
  407. window to perform an encoding/decoding operation.
  408.  
  409.         When the file is dropped on the ESS-Code application window, a dialog
  410. box will appear asking what should be done with the file.  After selecting
  411. the appropriate action, ESS-Code will perform the action (asking for extra
  412. information if necessary).
  413.  
  414.  
  415.      THE MENU
  416.  
  417.      The ESS-Code user interface has four menus.  Each menu contains commands
  418. that are related to one another.
  419.  
  420.      FILE
  421.  
  422.           The file menu allows you to perform various operations on files, 
  423.      such as encoding, decoding, splitting, and joining.
  424.  
  425.        UUEncode File...    
  426.        ----------------
  427.  
  428.             This command will allow you to convert a file of your choosing
  429.        from binary to ASCII using the Dumas UUEncode file conversion method.
  430.  
  431.             If segmentation is enabled, the resulting output files will have 
  432.        extensions of ".UAA", ".UAB", ".UAC", and so on. If segmentation is
  433.        not enabled, the resulting output file will have an extension of
  434.        ".UUE".
  435.  
  436.             This method of file conversion is very fast, but it is also very 
  437.        inefficient.  After being converted, files are typically 20% larger 
  438.        than their binary counterparts.  The most attractive feature of this 
  439.        file conversion method is that it is supported by virtually every 
  440.        computer platform in existence.
  441.  
  442.        UUDecode File...    
  443.        ----------------
  444.  
  445.             This command will allow you to return a file converted with the 
  446.        Dumas UUEncode file conversion method to its original binary state.
  447.  
  448.             Files that have been converted with the Dumas UUEncode file 
  449.        conversion method have extensions of ".UUE", ".UAA", ".UAB", ".UAC",
  450.        [...], ".UBA", ".UBB", ".UBC", and so forth.
  451.  
  452.             When decoding a segmented file using this file conversion method,
  453.        you do not need to specify each of the segments.
  454.  
  455.        MIME-Encode File...    
  456.        -------------------
  457.  
  458.             This command will allow you convert a file of your choosing from 
  459.        binary to ASCII using the MIME file conversion method.
  460.  
  461.             If segmentation is enabled, the resulting output files will have 
  462.        extensions of ".01", ".02", ".03", and so forth. If segmentation is 
  463.        not enabled, the resulting output file will have an extension of ".M".
  464.  
  465.             This file conversion method, which is the newest of the file 
  466.        conversion methods to be developed, is rapidly gaining in popularity.
  467.        It is fast, efficient, and flexible.  If you know that the person or 
  468.        machine receiving your data can process MIME-Encoded files, this is 
  469.        the best file conversion method to use.
  470.  
  471.        MIME-Decode File...    
  472.        -------------------
  473.  
  474.             This command will allow you to return a file converted with the 
  475.        MIME file conversion method to its original binary state.
  476.  
  477.             Files that have been converted with the MIME file conversion 
  478.        method have extensions of ".M", ".01", ".02", ".03", and so forth.
  479.  
  480.             When decoding a segmented file using this file conversion method,
  481.        you do not need to specify each segment of the file to be decoded
  482.        (though you can do so if you wish).  Only the first segment must be 
  483.        specified.
  484.  
  485.        SHIP-Encode File...    
  486.        -------------------
  487.  
  488.             This command will allow you convert a file of your choosing from 
  489.        binary to ASCII using the SHIP file conversion method.
  490.  
  491.             To retain compatibility with the UNIX implementation of SHIP, the 
  492.        output of this encoding method is always a series of files named 
  493.        "PART0001", "PART0002", and so forth.  While not a desirable
  494.        situation, this is an unfortunate necessity.
  495.  
  496.             This file conversion method, though available, should not be used
  497.        unless there is no other option available.  MIME-Encoding, which is 
  498.        nearly as efficient, is much more flexible than SHIP-Encoding.
  499.  
  500.        SHIP-Decode File...    
  501.        -------------------
  502.  
  503.             This command will allow you to return a file converted with the 
  504.        SHIP file conversion method to its original binary state.
  505.  
  506.             Files that have been converted with the SHIP file conversion 
  507.        method have names such as "PART0001", "PART0002", "PART0003", and so
  508.        forth.
  509.  
  510.             When decoding a segmented file using this file conversion method, 
  511.        you do not need to specify each segment to be decoded (though you can 
  512.        do so if you wish).  Only the first segment must be specified.
  513.  
  514.        BTOA-Encode File...    
  515.        -------------------
  516.  
  517.             This command will allow you convert a file of your choosing from 
  518.        binary to ASCII using the BTOA file conversion method.
  519.  
  520.             To retain compatibility with the UNIX implementation of BTOA, the 
  521.        output of this encoding method cannot be segmented.  If you need to 
  522.        segment the output, you can use the "Split File..." command to do so.
  523.        If the resulting file is to be rebuilt on a UNIX system, you will need
  524.        to use the "cat" command in the following fashion (after removing 
  525.        network message headers):
  526.  
  527.        /usr/mforget/> cat file.1 file.2 file.3 file.4 file.5 >the.whole.file
  528.        /usr/mforget/> atob the.whole.file output
  529.  
  530.        BTOA-Decode File...    
  531.        -------------------
  532.  
  533.             This command will allow you to return a file converted with the 
  534.        BTOA file conversion method to its original binary state.
  535.  
  536.             Files that have been converted with the BTOA file conversion 
  537.        method have extensions of ".B2A".
  538.  
  539.        Split File...    
  540.        -------------
  541.  
  542.             This command will allow you to split a file into segments so that 
  543.        it may be written to disk for transportation or so that it may be 
  544.        transmitted across a network.  It is important to recognize that the 
  545.        file (once split using this method) will not be able to be processed 
  546.        by any conversion method until it is once again rebuilt.  If ESS-Code 
  547.        is not available for the platform on which the file will be rebuilt, 
  548.        there are many other utilities available that can perform this task 
  549.        (or it could be performed manually using a text editor).
  550.  
  551.        Join File...    
  552.        ------------
  553.  
  554.             This command will allow you to rejoin the parts of a file that 
  555.        has been split by ESS-Code. You do not need to specify the name of 
  556.        each segment to join.  Instead, you are only required to specify 
  557.        the name of the first segment (and ESS-Code will determine the 
  558.        other segment names).
  559.  
  560.        Apply Filter
  561.        ------------
  562.  
  563.             This command will allow you to repair UUEncoded files that have
  564.         been distributed in a corrupted (non-standard) format.  This is most
  565.         often the case when files are distributed through USENET discussion
  566.         groups or when files are distributed by ftp-mail software.
  567.  
  568.              Files are repaired by using a special template called a filter.
  569.         The filter consists of a data start sequence, a data end sequence,
  570.         and two instance counters.
  571.  
  572.              Each filter consists of four individual elements; a data start
  573.         sequence, a data end sequence, and two instance counters.  The data
  574.         start sequence is a unique set of characters that appear on the line
  575.         immediately before the encoded data begins.  The data end sequence
  576.         is a unique set of characters that appear on the line immediately
  577.         after the encoded data (for the segment) is complete.  The two
  578.         instance counters determine how many times the sequence in question
  579.         (start or end) should be located before ESS-Code starts or stops
  580.         recording data.
  581.  
  582.              There are several filters included with ESS-Code, but the filter
  583.         you need may not be available.  If this is the case, you can create
  584.         your own filter (and save it if you expect to need it more than
  585.         once).
  586.         
  587.              Once a file has been passed through a filter, the output will
  588.         consist of one non-segmented, standard, UUEncoded file.
  589.  
  590.         Reset LOG File
  591.         --------------
  592.  
  593.              This command is only available in the 32-BIT version of
  594.         ESS-Code.
  595.  
  596.              This command will allow you to erase the file that ESS-Code uses
  597.         to record information about the actions you perform while using
  598.         ESS-Code.  This file is required so that you have a way of tracking
  599.         where encoded/decoded files have been placed, and what options were
  600.         used for each encoding/decoding operation.  It also provides you with
  601.         a cumulative written record of what you have done with ESS-Code.  If
  602.         you find that the file is growing too large, simply select this
  603.         command to erase it.
  604.  
  605.  
  606.        Exit    
  607.        ----
  608.  
  609.              This command will allow you to exit ESS-Code.  You will not be 
  610.         asked for confirmation unless your options have changed and the 
  611.         AutoSave Options feature is disabled.
  612.  
  613.      SEGMENTATION
  614.  
  615.           When ESS-Code is processing a file, it can split the output file 
  616.      into segments so that it can be placed on floppy disks for 
  617.      transportation or transmitted over networks that cannot accommodate 
  618.      large messages.  The segmentation menu allows you to determine the size 
  619.      of the segments that ESS-Code will create.
  620.  
  621.        Preset Segment Size
  622.        -------------------
  623.  
  624.             The segment sizes that are shown in this submenu are typical 
  625.        segment sizes that are commonly used.
  626.  
  627.        User Defined Size    
  628.        -----------------
  629.  
  630.             If none of the preset segment sizes match your needs, you can 
  631.        specify a segment size of your own by selecting this menu entry.
  632.  
  633.        No Segmentation    
  634.        ---------------  
  635.  
  636.             If you do not need segmentation, select this menu entry to 
  637.        disable it.
  638.  
  639.      OPTIONS
  640.  
  641.           The options menu allows you to control how ESS-Code encodes and 
  642.      decodes files.  You can also significantly alter the look-and-feel of 
  643.      the application using the commands found in this menu.
  644.  
  645.        UUEncode    
  646.        --------
  647.  
  648.        Full Path Specification    This command forces the inclusion of the
  649.                                   full pathname of the file being encoded in
  650.                                   the encoded file.  Normally, UUEncoded
  651.                                   files only contain the filename and
  652.                                   extension of the file being encoded.
  653.  
  654.        Generate Table             This command forces the generation of a
  655.                                   table of characters to compensate for
  656.                                   corruption by ill-behaved network
  657.                                   mailers.  This table, while not usually
  658.                                   required, can be useful in some
  659.                                   situations.
  660.  
  661.        SHIP-Encode
  662.        -----------
  663.  
  664.        Fast Mode                  Selecting this menu entry will force the 
  665.                                   SHIP file conversion method to use a 
  666.                                   slightly less efficient (but slightly 
  667.                                   faster) method of encoding.
  668.  
  669.        MIME-Encode
  670.        -----------
  671.  
  672.        Subject                    If you select this menu entry, the MIME 
  673.                                   file conversion method will prompt you for 
  674.                                   a message subject to apply to the outgoing 
  675.                                   (encoded) data.
  676.  
  677.        Description                If you select this menu entry, the MIME 
  678.                                   file conversion method will prompt you 
  679.                                   for the name of a file containing a 
  680.                                   description of the outgoing (encoded) data.
  681.  
  682.        Specify Content Type       Selecting this menu entry will cause the 
  683.                                   MIME file conversion method to prompt you 
  684.                                   for a content-type to apply to the outgoing 
  685.                                   (encoded) data.  The content-type must be a 
  686.                                   subtype of application, audio, image, or
  687.                                   video.
  688.  
  689.        MIME-Decode / SHIP-Decode
  690.        -------------------------
  691.  
  692.        Quick Find                 If you select this menu entry, ESS-Code
  693.                                   will only require you to specify the name 
  694.                                   of the first segment of a file that was 
  695.                                   encoded with the MIME/SHIP file conversion
  696.                                   methods.  ESS-Code will attempt to
  697.                                   determine the names of all subsequent 
  698.                                   segments.  This option, which is enabled 
  699.                                   by default, should only be disabled if the 
  700.                                   file you are decoding does not conform to 
  701.                                   the naming standard used by ESS-Code, or 
  702.                                   if the segments of the file you are 
  703.                                   decoding reside in multiple directories 
  704.                                   on your system.
  705.  
  706.        Client Execution Mode
  707.        ---------------------
  708.  
  709.        Hidden                     If you select this menu entry, ESS-Code 
  710.                                   will hide servers when they are launched 
  711.                                   so that they have no visible output and do 
  712.                                   not appear on your monitor.
  713.  
  714.        Minimized                  If you select this menu entry, ESS-Code 
  715.                                   will minimize servers when they are 
  716.                                   launched so that they have no visible 
  717.                                   output, but appear as an icon (which can 
  718.                                   be opened should the need arise).
  719.  
  720.        Background Window          If you select this menu entry, ESS-Code
  721.                                   will display the output of servers in a
  722.                                   background window when they are launched.
  723.                                   This leaves you free to continue working 
  724.                                   with ESS-Code.
  725.  
  726.        Foreground Window          Selecting this menu entry will cause 
  727.                                   ESS-Code to display the output of servers 
  728.                                   in a foreground window when they are 
  729.                                   launched.  This allows you to see the 
  730.                                   contents of the entire window.  If you 
  731.                                   wish to continue working with ESS-Code 
  732.                                   while the server is operating, simply 
  733.                                   click on the main application window of 
  734.                                   ESS-Code.
  735.  
  736.        Quick Termination          Selecting this menu entry will cause
  737.                                   ESS-Code to remove server windows (if 
  738.                                   visible) immediately after the server has 
  739.                                   finished the task it was assigned.  While 
  740.                                   this prevents you from viewing the output 
  741.                                   of the encoding/decoding operation, it 
  742.                                   makes system resources available to the 
  743.                                   system that would otherwise be unavailable 
  744.                                   until the server window was closed 
  745.                                   manually.
  746.  
  747.        UNIX Line Termination
  748.        ---------------------
  749.  
  750.             If you select this menu entry, each line of  encoded output will 
  751.        end with a UNIX line-end character instead of a DOS line-end
  752.        character.  This prevents "^M" from appearing after every line when 
  753.        the encoded file is processed by a UNIX network mailer.
  754.  
  755.        Overwrite Confirmation
  756.        ----------------------
  757.  
  758.             Selecting this menu entry will cause ESS-Code to ask for 
  759.        confirmation before it overwrites any existing files during an 
  760.        encoding, decoding, file splitting, of file joining operation.
  761.  
  762.        AutoSave Options
  763.        ----------------
  764.  
  765.             If you select this menu entry, ESS-Code will automatically save 
  766.        your options before you exit if they have been changed.
  767.  
  768.        Save Options
  769.        ------------
  770.  
  771.             Selecting this menu entry will cause your options to be saved 
  772.        immediately.
  773.  
  774.        Save Options As...
  775.        ------------------
  776.  
  777.             Selecting this menu entry will allow you to save your options 
  778.        using a filename (and location) of your choosing.
  779.  
  780.        Load Options...
  781.        ---------------
  782.  
  783.             Selecting this menu entry will allow you to load a previously 
  784.        saved set of options.
  785.  
  786.      HELP
  787.  
  788.           The help menu allows you to search for help on a specific topic, 
  789.      use the online manual, learn how to use the help system, and much more.
  790.  
  791.      Contents
  792.      --------
  793.  
  794.           If you select this menu entry, you will be shown the contents of 
  795.      the online manual.
  796.  
  797.      Search...
  798.      ---------
  799.  
  800.           This menu entry will allow you to search for help within the 
  801.      online manual on a topic of your choosing.
  802.  
  803.      Index
  804.      -----
  805.  
  806.           If you select this menu entry, you will be shown the index of the 
  807.      online manual.
  808.  
  809.      Using Help
  810.      ----------
  811.  
  812.           If you do not know how to use the help system, select this menu 
  813.      entry to learn more about it.
  814.  
  815.      About ESS-Code...
  816.      -----------------
  817.  
  818.           This menu entry will allow you to view general information about 
  819.      ESS-Code, including copyright and shareware information.
  820.  
  821. ----------------------
  822. - c. The DOS Version -
  823. ----------------------
  824.  
  825.      INTRODUCTION
  826.  
  827.      The purpose of this section of the manual is to describe what each of
  828. the features of ESS-Code does, and how to use them.
  829.  
  830.      ESS-Code is an application designed to allow computer users to exchange
  831. binary files across computer networks that do not support the transmission 
  832. of binary information.  This task is accomplished by converting the binary 
  833. file to an ASCII file, then converting the ASCII file back to its original 
  834. state after transmission.
  835.  
  836.      There are four popular methods of conversion, each of which is named 
  837. after the part of the process that performs the conversion; UUE, MIME, BTOA, 
  838. and SHIP.  Since each of these conversion methods is an accepted standard, 
  839. there are a wide variety of encoding/decoding utilities available for every 
  840. major computer platform, including UNIX, Macintosh, Amiga, Atari, and many 
  841. more.  Each of the applications that form the backbone of ESS-Code has been
  842. ported directly from their UNIX counterparts, with the exception of MIME.EXE
  843. which is based entirely on the DOS version of MPACK.EXE (with minor cosmetic
  844. changes and several additional features which make it easier to use).  In
  845. all situations, compatibility with the UNIX implementation takes
  846. precedence over any other consideration.  This can lead to some strange
  847. behaviour (such as the file naming method used by SHIP.EXE) but is much
  848. preferable to having a program that cannot communicate with the software
  849. on which it was based.
  850.  
  851.      Unlike the Windows version, there is no "client" aspect to the DOS
  852. version of ESS-Code.  Instead, you communicate directly with DOS
  853. implementations of the various file conversion methods offered by ESS-Code.
  854. This form of interaction is most often used by bulletin board systems,
  855. electronic mail gateways, and other "batch" applications (since no human
  856. interaction is required).  This method of interaction is also ideally
  857. suited to people who like prefer DOS to Windows.
  858.  
  859.      If you do not know what command to use on the command line for an
  860. ESS-Code application, simply type the name of that application and
  861. you will be shown a "usage" page.  If you want more information on a
  862. command than is shown on the usage page, or more information than is
  863. shown in this section of the manual, please read the section of the
  864. manual about the Windows version of ESS-Code.  It explains every option
  865. in detail.
  866.  
  867.      COMMON PARAMETERS
  868.  
  869.      ESS-Code is a complex set of applications that encompasses many
  870. different file conversion methods, but every effort has been made to ensure
  871. that each of the applications that form ESS-Code look and feel the same as
  872. the others.  In addition to this, many of the applications share the same
  873. parameters.  This section of the manual discusses those parameters which
  874. are common to all of the applications that for ESS-Code.
  875.  
  876.      The following command applies to all ESS-Code applications:
  877.  
  878.      Name                   Brief Explanation
  879.      ----                   -----------------
  880.      -c                     This parameter enables overwrite confirmation.
  881.                             You will be prompted before any file are
  882.                             destroyed by ESS-Code, and given the chance
  883.                             not to continue.
  884.  
  885.      The following command applies to all ESS-Code encoding applications:
  886.  
  887.      Name                   Brief Explanation
  888.      ----                   -----------------
  889.      -u                     This parameter enables UNIX Line Termination.
  890.                             Instead of ending each line of encoded ASCII
  891.                             data in a file with the standard MS-DOS line-end
  892.                             character, the UNIX line-end character will be
  893.                             used.
  894.  
  895.      The following command applies to all ESS-Code encoding applications
  896. that are capable of producing segmented output, except MIME.EXE:
  897.  
  898.      Name                   Brief Explanation
  899.      ----                   -----------------
  900.      -s<size>               This command will enable segmented output.
  901.  
  902.      UNIQUE PARAMETERS
  903.  
  904.      Several of the applications that form ESS-Code have unique capabilities.
  905. This section of the manual describes what those capabilities are:
  906.  
  907.      MIME.EXE:
  908.  
  909.      Name                   Brief Explanation
  910.      ----                   -----------------
  911.      -s <subject>           This applies a subject to the outgoing (encoded)
  912.                             message.  If the subject contains spaces, quote
  913.                             it.
  914.  
  915.                             Example:  -s "This is a test."
  916.  
  917.      -d <description file>  This applies a description to the outgoing
  918.                             (encoded) message.  The description should be
  919.                             contained in an ASCII file, and should be no
  920.                             more than eighty characters wide.
  921.  
  922.      -m <characters>        This parameter enables segmentation, as
  923.                             described in the preceding section.
  924.  
  925.      -t <content-type>      This command allows you to manually specify
  926.                             the content-type of the outgoing (encoded)
  927.                             message.
  928.  
  929.      UNMIME.EXE
  930.  
  931.      Name                   Brief Explanation
  932.      ----                   -----------------
  933.      -q                     This command will prevent MIME.EXE from
  934.                             displaying as much output as it normally
  935.                             does.
  936.  
  937.      -d <directory>         The UNMIME.EXE application normally places
  938.                             output in the current directory.  If you do
  939.                             not want this to happen, you can specify an
  940.                             alternate directory with this command.
  941.  
  942.                             Example:  -d D:\USER\MFORGET
  943.  
  944.      SHIP.EXE
  945.  
  946.      Name                   Brief Explanation
  947.      ----                   -----------------
  948.      -f                     This command enables "fast" mode.  This mode is
  949.                             slightly faster, but slightly less efficient,
  950.                             than the normal file conversion method used.
  951.  
  952.      UUE.EXE
  953.  
  954.      Name                   Brief Explanation
  955.      ----                   -----------------
  956.      -f                     This command will cause ESS-Code to record the
  957.                             full pathname of the file being encoded within
  958.                             the encoded file, instead of simply recording
  959.                             the filename.
  960.  
  961.      -t                     This command will cause ESS-Code to generate
  962.                             a table of ASCII characters, which helps prevent
  963.                             ill-behaved network mail software from corrupting
  964.                             the encoded data during transmission.
  965.  
  966. =============================================================================
  967. 8. Acknowledgements
  968. =============================================================================
  969.  
  970.      ESS-Code is only possible because of the following people:
  971.  
  972.      Paul Rutter & Joe Orost
  973.      John G. Myers
  974.      Mark Adler
  975.      Mike Bublitz
  976.      Denesh Bhabuta
  977.      Erlend Nagel
  978.      RSA Data Security, Inc.
  979.      Carnegie Mellon University
  980.      Bell Communications Research, Inc.
  981.  
  982.      There have been many other individuals who have contributed to the
  983. development of this product who are too numerous to name.  Their help is
  984. recognized and appreciated, though.
  985.  
  986. =============================================================================
  987. 9. Third Party Copyrights
  988. =============================================================================
  989.  
  990. The following copyright (and notice) apply to the modified MPACK/MUNPACK
  991. used by ESS-Code.  Since the two utilities have been modified (in cosmetic
  992. terms only) the names "mime" and "unmime" have been used instead of the
  993. original names.
  994.  
  995. (C) Copyright 1993, 1994 by Carnegie Mellon University
  996. All Rights Reserved.
  997.  
  998. Permission to use, copy, modify, distribute, and sell this software
  999. and its documentation for any purpose is hereby granted without fee,
  1000. provided that the above copyright notice appear in all copies and that
  1001. both that copyright notice and this permission notice appear in
  1002. supporting documentation, and that the name of Carnegie Mellon
  1003. University not be used in advertising or publicity pertaining to
  1004. distribution of the software without specific, written prior
  1005. permission.  Carnegie Mellon University makes no representations about
  1006. the suitability of this software for any purpose.  It is provided "as
  1007. is" without express or implied warranty.
  1008.  
  1009. CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  1010. THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  1011. AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  1012. FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  1013. WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  1014. AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  1015. OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  1016. SOFTWARE.
  1017.  
  1018. Portions of this software are derived from code written by Bell
  1019. Communications Research, Inc. (Bellcore) and by RSA Data Security,
  1020. Inc. and bear similar copyrights and disclaimers of warranty.
  1021.  
  1022. --
  1023. Portions of this product are copyrighted by Borland International, Inc.
  1024. Trademarks are property of their respective owners.
  1025.  
  1026.