home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / archives / ckc190.tar.gz / ckc190.tar / ckaaaa.hlp < prev    next >
Text File  |  1996-03-21  |  15KB  |  358 lines

  1. CKAAAA.HLP                                                         October 1994
  2.  
  3.          C-KERMIT VERSION 5A(190), OVERVIEW OF FILES
  4.  
  5.    Communications software for UNIX, (Open)VMS, OS/2, AOS/VS, Apollo Aegis,
  6.  Stratus VOS, OS-9, the Apple Macintosh, the Commodore Amiga, and the Atari ST.
  7.  
  8. C-Kermit 5A(190) bears the following copyright notice:
  9.  
  10.   Copyright (C) 1985, 1994, Trustees of Columbia University in the City of New
  11.   York.  The C-Kermit software may not be, in whole or in part, licensed or
  12.   sold for profit as a software product itself, nor may it be included in or
  13.   distributed with commercial products or otherwise distributed by commercial
  14.   concerns to their clients or customers without written permission of the
  15.   Office of Kermit Development and Distribution, Columbia University.  This
  16.   copyright notice must not be removed, altered, or obscured.
  17.  
  18. And the following disclaimer:
  19.  
  20.   The C-Kermit software is provided in source code form by Kermit Development
  21.   and Distribution, Columbia University.  The software is provided "as is;" no
  22.   other warranty is provided, express or implied, including without
  23.   limitations, any implied warranty of merchantability or implied warranty of
  24.   fitness for a particular purpose.
  25.  
  26.   Neither Columbia University nor any of the contributors to the C-Kermit
  27.   development effort, including, but not limited to, AT&T, Digital Equipment
  28.   Corporation, Data General Corporation, Hewlett-Packard Company, or
  29.   International Business Machines Corporation, warrant C-Kermit software or
  30.   documentation in any way.  In addition, neither the authors of any Kermit
  31.   programs, publications or documentation, nor Columbia University nor any
  32.   contributing institutions or individuals acknowledge any liability resulting
  33.   from program or documentation errors.
  34.  
  35. DOCUMENTATION
  36.  
  37.   C-Kermit 5A is documented in the book "Using C-Kermit" by Frank da Cruz and
  38.   Christine M. Gianone, 1993, Digital Press, ISBN 1-55558-108-0.  Available at
  39.   book and computer stores, or order from Columbia University by calling
  40.   +1 212 854-3703 (MasterCard and Visa accepted), or by calling Digital Press /
  41.   Butterworth-Heinemann at one of the numbers below (MasterCard, Visa, and
  42.   American Express accepted).  Please purchase the documentation: it shows you
  43.   step-by- step how to use C-Kermit with numerous examples and illustrations,
  44.   it will answer most of your questions, and sales help to fund the Kermit
  45.   development and support effort.  Digital Press phone numbers:
  46.  
  47.     +1 800 366-2665   (Woburn, MA office for USA & Canada,
  48.                Toll-free M-F 8AM-6PM Eastern time)
  49.     +1 617 928 2613   (Newton, MA office for sales/marketing info)
  50.     +44 1865 314627   (Oxford, England distribution centre for
  51.                UK & Europe)
  52.     +61 03 9245 7111  (Melbourne, Vic, office for Australia & NZ)
  53.     +65 356-1968      (Singapore office for Malaysia, Singapore,
  54.                Indonesia, Philippines, Thailand)
  55.     +27 (31) 2683111  (Durban office for South Africa)
  56.   
  57. CD-ROMS
  58.  
  59.   If you have obtained C-Kermit on a CD-ROM collection of "free software",
  60.   C-Kermit was very likely included without permission.  Please help to support
  61.   the Kermit effort by obtaining Kermit software through the proper channels,
  62.   with proper documentation.
  63.  
  64. QUICK START FOR FTP USERS (UNIX, VMS, OS/2)
  65.  
  66.   The definitive FTP source for Kermit software is kermit.columbia.edu.
  67.   Kermit software obtained from other FTP sites is not necessarily complete
  68.   and up to date, and may have been modified.
  69.  
  70. C-Kermit for UNIX computers that have a C compiler and 'make' program:
  71.   
  72.   Directory kermit/archives, binary mode, file cku190.tar.Z or cku190.tar.gz.
  73.   Compressed tar archive UNIX C-Kermit source code, makefile, and other files.
  74.   Transfer in binary mode, uncompress (or gunzip), untar, and then give the
  75.   appropriate "make" command to build for your UNIX system; read the comments
  76.   in the makefile and ckuins.doc for further info.
  77.  
  78. C-Kermit for VMS:  
  79.  
  80.   Get the file kermit/f/ckvaaa.hlp in text mode, read it, take it from there.
  81.  
  82. C-Kermit for OS/2:
  83.  
  84.   Directory kermit/archives, binary mode, file cko190.zip.  This is the OS/2
  85.   C-Kermit distribution diskette (no source code).  It includes both the
  86.   32-bit and the 16-bit version, plus all the important text files.  Transfer
  87.   in binary mode, unzip, and then run the INSTALL.CMD script.
  88.   
  89.  
  90. FILES AND FILE NAMING CONVENTIONS
  91.  
  92. C-Kermit is a family of Kermit programs for many different computer systems.
  93. The program shares a common set of system-independent file transfer protocol
  94. modules, written in the C language.  System-dependent operations are collected
  95. into system-specific modules for each system.
  96.  
  97. C-Kermit is available for UNIX (AT&T, POSIX, BSD, SunOS, Solaris, NeXTSTEP,
  98. Xenix, ULTRIX, AIX, Linux, QNX, many others), IBM OS/2, DEC VMS and OpenVMS on
  99. VAX and AXP computers, Data General AOS/VS, Stratus VOS, the Apple Macintosh,
  100. Apollo Aegis, the Commodore Amiga, the Atari ST, and Motorola 680x0 computers
  101. with Microware OS/9.
  102.  
  103. C-Kermit file names all start with the letters "CK", followed by a single
  104. letter indicating the subgroup.  When referring to these files in the UNIX
  105. environment, use lowercase letters, rather than the uppercase letters shown
  106. here.  Subgroups:
  107.  
  108.   A: General descriptive material and documentation
  109.   B: BOO file encoders and decoders
  110.   C: All systems with C compilers
  111.   D: Data General AOS/VS
  112.   E: Reserved for "ckermit" files, like CKERMIT.INI
  113.   F: Microsoft Windows 3.x (F = Fenster) (reserved)
  114.   H: Harris computers, VOS (reserved)
  115.   I: Commodore Amiga (Intuition)
  116.   J: (unused)
  117.   K: (unused)
  118.   L: Stratus VOS
  119.   M: Macintosh with Mac OS
  120.   N: Microsoft Windows NT (reserved)
  121.   O: OS/2
  122.   P: IBM PC, PS/2 with MS/PC-DOS (reserved)
  123.   Q: (unused)
  124.   R: DEC PDP-11 with RSTS/E (reserved)
  125.   S: Atari ST GEMDOS
  126.   T: DEC PDP-11 with RT-11 (reserved)
  127.   U: UNIX or environments with UNIX-like C libraries
  128.   V: VMS and OpenVMS
  129.   W: Wart (Lex-like preprocessor, used with all systems)
  130.   X: DEC PDP-11 with RSX-11 (reserved)
  131.   Y: (unused)
  132.   Z: (unused)
  133.   0-8: (unused)
  134.   9: Microware OS-9
  135.  
  136. Examples (use lowercase on UNIX):
  137.  
  138.   CKAAAA.HLP - This file
  139.   CKVAAA.HLP - Read-me file for the VMS version
  140.   CKOAAA.HLP - Read-me file for the OS/2 version
  141.   CKUFIO.C   - File i/o for UNIX
  142.   CKSTIO.C   - Communications i/o for the Atari ST
  143.   CKUKER.NR  - Nroff source file for UNIX C-Kermit man page
  144.   CKUKER.MAK - Makefile for building UNIX C-Kermit
  145.   CKOKER.MAK - Makefile for building OS/2 C-Kermit
  146.  
  147. IMPORTANT FILES (use lowercase names on UNIX):
  148.  
  149.   CKAAAA.HLP  - This file (overview of the C-Kermit files).
  150.                 For system-specific distributions, this will normally
  151.                 be replaced by a system-specific READ.ME file.
  152.  
  153.   CKCKER.UPD  - Updates: Supplement to "Using C-Kermit".
  154.   CKCKER.BWR  - "Beware file" (limitations, known bugs, hints), general.
  155.   CKERMIT.INI - Standard initialization file (rename to .kermrc in UNIX, OS-9)
  156.   CKERMOD.INI - Sample customization file (rename to .mykermrc in UNIX, OS-9)
  157.   CKERMIT.KDD - Sample dialing directory file (rename to .kdd in UNIX, OS-9)
  158.   CKERMIT.KSD - Sample services directory file (rename to .ksd in UNIX, OS-9)
  159.   CKEDEMO.INI - Demonstration macros from "Using C-Kermit"
  160.   CKEVT.INI   - Ditto
  161.   CKETEST.INI - Ditto
  162.  
  163. UNIX-specific files (use lowercase names on UNIX):
  164.  
  165.   CKUINS.DOC - UNIX-specific installation instructions.
  166.   CKUKER.BWR - UNIX-specific beware file.
  167.   CKUKER.NR  - "man page" for UNIX.
  168.   CKURZSZ.INI - Macros for external protocols.
  169.  
  170. VMS-specific files:
  171.  
  172.   CKVINS.DOC - VMS-specific installation instructions.
  173.   CKVKER.BWR - VMS-specific beware file
  174.   CKVKER.HLP - VMS C-Kermit HELP topic
  175.  
  176. OS/2-specific files:
  177.  
  178.   The official OS/2 C-Kermit distribution diskette contains
  179.   numerous DLL and other binary files.  A proper installation can be
  180.   obtained only from the diskette, or from the ZIP-format image of
  181.   the diskette.  This is available in the kermit/archives/bin/cko190.zip
  182.   file.
  183.  
  184. DG AOS/VS-specific files:
  185.  
  186.   CKDINS.DOC - Data General AOS/VS C-Kermit installation instructions
  187.   CKDKER.BWR - AOS/VS "beware" file
  188.  
  189. The following files are of interest mainly to programmers and historians:
  190.  
  191.   CKCKER.ANN - Brief list of new features of 5A (release announcements).
  192.   CKCCFG.DOC - Configuration information (feature selection), general.
  193.   CKCPLM.DOC - Program logic manual (for programmers).
  194.   CKC190.UPD - Program update history for edits 189-190 (big).
  195.   CKC188.UPD - Program update history, edits 179-188 (big).
  196.   CKC178.UPD - Program edit history, 5A edits through 178 (very big).
  197.   CKCV4F.UPD - Program edit history, version 4F.
  198.   CKCV4E.UPD - Program edit history, version 4E.
  199.  
  200. BINARIES
  201.  
  202. If you have FTP access to kermit.columbia.edu (also known as
  203. kermit.cc.columbia.edu, ftp.cc.columbia.edu, watsun.cc.columbia.edu), you can
  204. also retrieve various C-Kermit binaries from the directory kermit/bin/ck*.*.
  205. Be sure to transfer these files in binary mode.
  206.  
  207. ENCODED BINARIES
  208.  
  209. VMS (decode these with the CKVDEH.MAR program) (these are in kermit/textbin):
  210.  CKVKER.HEX  - VAX/VMS (OpenVMS) 5.5, no networks.
  211.  CKVAXP.HEX  - OpenVMS AXP 1.0, no networks.
  212.  CKVAUCX.HEX - OpenVMS AXP 1.0, DEC TCP/IP.
  213.  CKVVTGV.HEX - VAX version with TGV MultiNet TCP/IP support included.
  214.  CKVVUCX.HEX - VAX version with DEC TCP/IP (UCX) support included.
  215.  CKVVWIN.HEX - VAX version with Wollongong WIN/TCP support included.
  216. OS-9:
  217.  CK9KER.BOO - OS-9/68000.  Decode with CKBUNB.C.
  218. OS/2:
  219.  Please get the entire CKO190.ZIP file.
  220. Amiga:
  221.  CKIKER.BOO.  Decode with CKBUNB.C.
  222. Atari ST:
  223.  CKSKER.BOO.  Decode with CKBUNB.C.
  224.  CKSNCP.BOO.  Minimal version of C-Kermit (no command parser).
  225. Data General MV AOS/VS:
  226.  CKDKER.UUE.  Decode with uudecode or ckdeco.c, then unpack with DUMPFILE.
  227.  
  228. SOURCE FILES
  229.  
  230. The source files for the UNIX version (all UNIX versions) are available in
  231. kermit/archives/cku190.tar.Z, approximately 1MB in size.  Transfer this file
  232. in binary mode.  This is a compressed tar archive.  There is also a gzip'd
  233. version, cku190.tar.gz.  To get the binary tar archive:
  234.  
  235.   mkdir kermit                   (at shell prompt, make a Kermit directory)
  236.   cd kermit                      (make it your current directory)
  237.  
  238.   ftp kermit.columbia.edu        (make an ftp connection)
  239.   user: anonymous                (log in as user "anonymous", lower case!)
  240.   password:                      (use your email id as a password)
  241.   cd kermit/archives             (go to the archives directory)
  242.   type binary                    (specify binary file transfer)
  243.   get cku190.tar.Z               (get the tar archive) (or get cku190.tar.gz)
  244.   bye                            (disconnect and exit from ftp)
  245.  
  246.   uncompress cku190.tar.Z        (at the shell prompt, uncompress the archive)
  247.   tar xvf cku190.tar             (extract the files from the tar archive)
  248.   make xxx                       (build C-Kermit for your system)
  249.  
  250. (where "xxx" is the makefile entry appropriate for your system.)
  251.  
  252. All C-Kermit source and other text files are also kept separately in the
  253. kermit/f directory.  The files necessary to build a particular implementation
  254. of C-Kermit are listed in the appropriate makefile or equivalent:
  255.  
  256.        UNIX: ckuker.mak (rename to makefile)
  257.    2.11 BSD: ckubs2.mak (rename to makefile), ckustr.sed
  258.   Macintosh: ckmker.mak (rename to kermit.make, use MPW C 3.2)
  259.         VMS: CKVKER.COM (DCL) or CKVKER.MAK (VMS MAKE)
  260.       Amiga: CKIKER.MAK (Aztec C) or CKISAS.MAK (SAS C)
  261.    Atari ST: CKSKER.MAK
  262.        OS/2: CKOKER.MAK, CKOKER.DEF, CKWART.DEF (MSC 6.0, GCC, or IBM C Set/2)
  263.        OS-9: CK9KER.MAK or CK9KER.GCC
  264.      AOS/VS: CKDMAK.CLI, CKDCC.CLI, CKDLNK.CLI
  265. Stratus VOS: CKLMAK.CM
  266.  
  267. Minimal source files for building selected versions (these patterns get all
  268. the files you need, and in some cases maybe a few extra):
  269.  
  270.    UNIX:   ck[cuw]*.[cwh]
  271.    VMS:    ck[cuwv]*.[cwh]
  272.    Mac:    ck[cuwm]*.[cwhr]
  273.    OS/2:   ck[cuwo]*.[cwh] ck*.def cko*.msb
  274.    AOS/VS: ck[cuwd]*.[cwh]
  275.    VOS:    ck[cwhl]*.[cwh]
  276.    Amiga:  ck[cuwi]*.[cwh]
  277.    Atari:  ck[cuws]*.[cwh]
  278.    OS-9:   ck[cwh9]*.[cawh]
  279.  
  280. For a detailed, specific source file list for this C-Kermit release, see the
  281. file CKCxxx.UPD, where xxx is the current C-Kermit edit number, such as 190.
  282.  
  283. Finally, here is a more detailed description of the C-Kermit file naming
  284. conventions.  A C-Kermit filename has the form:
  285.  
  286.   CK<system><what>.<type>
  287.  
  288. where:
  289.  
  290. <system> is described earlier in this file;
  291.  
  292. <type> is the file type (use lowercase on UNIX):
  293.  
  294.   C:   C language source
  295.   H:   Header file for C language source
  296.   W:   Wart preprocessor source, converted by Wart (or Lex) to a C program
  297.   R:   Macintosh resource file (8-bit text)
  298.   A:   Assembler source
  299.  
  300.   ANN: The text of an announcement of a particular version
  301.   DOC: Documentation
  302.   HLP: Help text
  303.   NR:  Nroff/Troff text formatter source for UNIX "man page"
  304.   UPD: Program update history
  305.   BWR: A "beware" file - list of known bugs, limitations
  306.   MSS: Scribe text formatter source
  307.   PS:  Typeset material to be printed on a PostScript printer
  308.   DSK: A "read.me" file for diskette distributions
  309.  
  310.   INI: Initialization file
  311.   TAK: A Kermit TAKE command file
  312.   KDD: A Kermit Dialing Directory
  313.   KSD: A Kermit Services Directory
  314.   TXT: A plain-text file
  315.  
  316.   MAK: A Makefile or other build procedure (often needs renaming)
  317.   COM: (VMS only) a DCL command procedure
  318.   CMD: (OS/2 only) a Rexx command procedure
  319.   REL: (VMS only) a RELEASE_NOTES file
  320.  
  321.   BOO: "boo"-encoded executable program, decode with CKBUNB program.
  322.   HEX: "hex"-encoded executable program, decode with CKVDEH program (VMS only).
  323.   HQX: BinHex'd Macintosh Kermit program, decode with BinHex version 4.0.
  324.   UUE: A uuencoded binary file, decode with uudecode or (DG only) CKDECO.
  325.  
  326.   DEF: An OS/2 linker definitions file.
  327.   SED: A UNIX sed (editor) script.
  328.   STR: A file of character strings extracted from C-Kermit (BSD 2.1x).
  329.  
  330. <what> is mnemonic (up to 3 characters) for what's in the file:
  331.  
  332.   AAA: A "read-me" file, like this one
  333.   INS: Installation instructions or procedures
  334.   KER: General C-Kermit definitions, information, documentation
  335.  
  336.   CMD: Command parsing
  337.   CON: CONNECT command
  338.   DEB: Debug/Transaction Log formats, Typedefs
  339.   DIA: Modem/Dialer control
  340.   FIO: System-depdendent File I/O
  341.   FNS: Protocol support functions
  342.   FN2: More protocol support functions (and FN3, ...)
  343.   MAI: Main program
  344.   PRO: Protocol
  345.   SCR: SCRIPT command
  346.   TIO: System-dependent communications i/o & control and interrupt handing
  347.   USR: User interface
  348.   US2: More user interface
  349.   US3: Still more user interface (and USR4, USR5, USR6, ...)
  350.   USX: Common user interface functions
  351.   USY: Command-line parsing
  352.   XLA: Character set translation module
  353.   NET: Network support module
  354.   MDB: Malloc-debugging module
  355.   STR: Strings module
  356.  
  357. (End of CKAAAA.HLP)
  358.