home *** CD-ROM | disk | FTP | other *** search
/ The Best of Select: Windows 95 Special 1 / WINDOWS95_1.ISO / internet / ess-code / esscode.txt < prev    next >
Text File  |  1995-08-08  |  45KB  |  1,044 lines

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