home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / NCDC_OS2.ZIP / NCDC.DOC next >
Text File  |  1993-04-13  |  8KB  |  235 lines
  1.   Exploding: ncdc.doc               
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                N C D C
  12.  
  13.  
  14.                              version  1.51
  15.  
  16.                           Jurgen A. Doornik
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.     1. Introduction.
  27.     ___________________________________________________________________
  28.  
  29.     NCDC is a XX/UU encoder/decoder. There are many of these around,
  30.     so why NCDC?
  31.  
  32.     o  NCDC is completely free, and comes with C source code.
  33.  
  34.     o  NCDC is written in ANSI C, with conditional code sections
  35.        for old style (K&R) headers, Unix and VAX/VMS.
  36.        NCDC currently runs on MsDos, Unix, and VAX/VMS computers.
  37.        You can easily adjust the source code for other machines,
  38.        but it will probably run unchanged.
  39.  
  40.     o  NCDC has the decoder and encoder in one program, and
  41.        is fairly intelligent: it knows when to decode or encode,
  42.        and, when decoding, which method to use.
  43.  
  44.     o  Unlike many other decoders, NCDC gives warning messages
  45.        if something unexpected is found. NCDC can glue broken lines.
  46.  
  47.     o  NCDC is efficient. Its speed approximates that of assembler
  48.        encoders/decoders.
  49.  
  50.  
  51.     If you have any suggestions for improvement, or find any bugs,
  52.     please report them to me, via email:
  53.  
  54.        INTERNET: ECONZ@UK.AC.OX.VAX
  55.  
  56.     or by mail:
  57.  
  58.     Jurgen Doornik
  59.     Institute of Economics and Statistics
  60.     St Cross Building, Manor Road
  61.     Oxford OX1 3UL
  62.     United Kingdom
  63.     FAX +44 - 865 - 271094
  64.  
  65.     Special thanks are due to Arjen Merckens, who helped debugging
  66.     NCDC, and added the /s option for VAX/VMS. Arjen is author
  67.     of ACD (ChDir FAST; more features than LCD/NCD and free).
  68.  
  69.  
  70.     2. Contents of zip file.
  71.     ___________________________________________________________________
  72.  
  73.     NCDC.C   - C source code for NCDC
  74.     NCDC.DOC - this file
  75.     NCDC.EXE - Dos executable
  76.     NCDC.VXE - VAX/VMS executable
  77.  
  78.  
  79.     3. Installation and compilation
  80.     ___________________________________________________________________
  81.  
  82.     To install the VAX/VMS executable, you need to transfer it (as a
  83.     binary file) to the VAX, rename it to NCDC.EXE, and add something
  84.     like
  85.         $NCDC == "$disk:[path]NCDC.EXE"
  86.     to your login.com. To compile on the VAX type
  87.         CC NCDC.C
  88.     and then
  89.         LINK NCDC
  90.     I had to add
  91.         $ define LNK$LIBRARY  "SYS$LIBRARY:VAXCRTL"
  92.     to my login.com for this to work.
  93.  
  94.     The Dos version is compiled and linked using Microsoft C/C++ 7.00,
  95.     using the command
  96.         CL NCDC.C
  97.     So no extra optimizations were used.
  98.  
  99.  
  100.     4. How to use NCDC.
  101.     ___________________________________________________________________
  102.  
  103.     Usage:  NCDC infile [outfile] [/u] [/##]
  104.  
  105.     infile   The file to encode or decode.
  106.              NCDC decodes if infile has no extension or
  107.              an extension ENC, XXE or UUE. Otherwise NCDC
  108.              will encode. When decoding, the decoding method
  109.              is derived from first encoded line of infile.
  110.              When encoding XXencoding is the default.
  111.  
  112.     outfile  Optionally override the destination. This is
  113.              useful when the name of the original file which
  114.              has been encoded, is invalid on the decoding
  115.              platform.
  116.  
  117.     /u       Set encoding method to UUencode.
  118.  
  119.     /##      Sets maximum outfile size to ## kilobytes. E.g.
  120.                  NCDC test.zip /50
  121.              could lead to test.enc, test.en2 and test.en3
  122.              being created. If you then do
  123.                  NCDC test
  124.              NCDC will see that test.enc is not enough, and
  125.              automatically include test.en2 and test.en3.
  126.  
  127.     /s       This option is only available under VAX/VMS.
  128.              By default the decoded file has Variable length format.
  129.              Use /s to change this to Stream_LF format.
  130.  
  131.  
  132.     5. When to use NCDC.
  133.     ___________________________________________________________________
  134.  
  135.     Executable files, and word processor files cannot be sent by email
  136.     as such. They have to be encoded on one side, and decoded on the
  137.     other side to make sure that no information is lost.
  138.     Email often involves several types of computers, leading to several
  139.     conversions into other character coding systems.
  140.  
  141.     An email transmission of a document usually works like this:
  142.     1. compress the document              <----  PKZIP,ARJ,ZOO,LHARC, etc
  143.     2. encode the document                <----  NCDC
  144.     3. send it to the mainframe
  145.     3. email the document
  146.          .....
  147.     4. document is received
  148.     5. download it from the mainframe
  149.     6. decode the document                <----  NCDC
  150.     7. decompress the document            <----  PKUNZIP,ARJ,ZOO,LHARC, etc
  151.  
  152.     To send test.doc, for example:
  153.     1. PKZIP test.doc
  154.     2. NCDC test.zip             <---- XXencode file test.zip into test.enc
  155.         .....
  156.     6. NCDC test                 <---- XXdecode file test.enc into test.zip
  157.     7. PKUNZIP test
  158.  
  159.     Altough steps 1 and 7 are optional, they are advisable in order to
  160.     keep network transmissions at a minimum.
  161.  
  162.  
  163.  
  164.     6. License, warranty and disclaimer.
  165.     ___________________________________________________________________
  166.  
  167.     NCDC is written by Jurgen A. Doornik in ANSI C. Some special
  168.     additions are made for VAX/VMS and UNIX machines.
  169.     You may distribute NCDC given these restrictions:
  170.  
  171.     o  the program shall be supplied in its original, unmodified
  172.        form, which includes this documentation;
  173.  
  174.     o  no fee is charged;
  175.  
  176.     o  the program may be included, or bundled, with any other
  177.        programs/products (including for-profit products) on the
  178.        condition that I shall receive one copy of the program/
  179.        product (as given/sold), and an update each time NCDC
  180.        is bundled with the update.
  181.  
  182.     o  You may use and modify the source code for personal pur-
  183.        poses only, and on the condition that I shall receive
  184.        a copy of the modified version.
  185.  
  186.     For any other use contact me.
  187.  
  188.  
  189.  
  190.     Jurgen Doornik        INTERNET: ECONZ@UK.AC.OX.VAX
  191.  
  192.     Institute of Economics and Statistics
  193.     St Cross Building, Manor Road
  194.     Oxford OX1 3UL
  195.     United Kingdom
  196.     FAX +44 - 865 - 271094
  197.  
  198.  
  199.     DISCLAIMER:
  200.     I shall not be responsible for any damages or inconveniences
  201.     incurred due to the usage of NCDC.
  202.  
  203.     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW WILL JURGEN DOORNIK BE
  204.     LIABLE TO YOU FOR DAMAGES, INCLUDING ANY LOST PROFITS, LOST MONIES, OR
  205.     OTHER SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
  206.     USE OR INABILITY TO USE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR
  207.     DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY THIRD PARTIES)
  208.     THESE PROGRAMS, EVEN IF YOU HAVE BEEN ADVISED OF THE POSSIBILITY OF
  209.     SUCH DAMAGES, OR FOR ANY CLAIM BY ANY OTHER PARTY.
  210.  
  211.  
  212.     7. Revision history.
  213.     ___________________________________________________________________
  214.  
  215.     26-10-92 (JAD): Released version 1.51.
  216.     26-10-92 (JAD): Pre/post encoding text used \n instead of
  217.              \r\n for MSDOS.
  218.     04-08-92 (JAD): Released version 1.5.
  219.     08-04-92 (JAD): VMS specific help text restricted to VMS.
  220.              Documented NCDC.
  221.     01-05-91 (AM): added smaller buffer for VMS; added /s option:
  222.              Stream_LF decoding for VMS.
  223.     10-04-91 (JAD): added osize = 0 in decode; added get_start()
  224.              because continuation files received from SIMTEL don't
  225.              start with begin. When decodeing was expecting multiple
  226.              of four in last line, now computes # actually expected
  227.              (when encoding still writing multiple of four.
  228.      9-04-91 (JAD): changed VMS OPEN_W_ARG, added pre-ANSI C function
  229.              headers for UNIX.
  230.      8-04-91 (JAD): Introduced MSDOS/VMS/UNIX versions.
  231.      4-04-91 (JAD): Bug fix: table was not kept when found at top of
  232.              encoded file.
  233.  
  234.  
  235.