home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / archives / cku192.tar.gz / cku192.tar / ckuaaa.hlp < prev    next >
Text File  |  1996-12-28  |  7KB  |  171 lines

  1. File CKUAAA.HLP                                                 September 1996
  2.  
  3.                C-KERMIT FILES FOR UNIX
  4.  
  5. C-Kermit bears the following copyright notice:
  6.  
  7.   Copyright (C) 1985, 1996, Trustees of Columbia University in the City of New
  8.   York.  The C-Kermit software may not be, in whole or in part, licensed or
  9.   sold for profit as a software product itself, nor may it be included in or
  10.   distributed with commercial products or otherwise distributed by commercial
  11.   concerns to their clients or customers without written permission of the
  12.   Office of Kermit Development and Distribution, Columbia University.  This
  13.   copyright notice must not be removed, altered, or obscured.
  14.  
  15. All files for UNIX C-Kermit have Kermit Distribution names beginning with
  16. 'ck'.  Those particular to UNIX begin with 'cku'.  Those that UNIX C-Kermit
  17. share in common with other C-Kermit implementations begin with 'ckc' or 'ckw'.
  18. When retrieving these files via ftp from kermit.columbia.edu, a UNIX computer,
  19. use only lowercase letters in filenames.  (Actually, many of the 'cku' files
  20. are also used on other platforms, too.)
  21.  
  22. All the files needed for UNIX C-Kermit are listed below, and are available
  23. separately in the kermit/f directory.  They are also available in a compressed
  24. tar archive in kermit/archives called ckuxxx.tar.Z, where xxx is the C-Kermit
  25. edit number, for example cku192.tar.Z (and also .gz for gunzip).  Retrieve
  26. this file to your UNIX system in binary mode.  Here is an example of how to
  27. retrieve, unpack, and build:
  28.  
  29.   mkdir kermit
  30.   cd kermit
  31.   ftp kermit.columbia.edu
  32.   Name: anonymous (or "ftp")
  33.   Password: (supply your email address)
  34.   ftp> cd kermit/archives
  35.   ftp> binary (or "type binary")
  36.   ftp> get cku192.tar.Z (or .gz)
  37.   ftp> bye
  38.   uncompress cku192.tar.Z (or gunzip cku192.tar.gz)
  39.   tar xvf cku192.tar
  40.   make xxx
  41.  
  42. where "xxx" is the appropriate makefile entry, for example "make sunos41c".
  43. Please read the comments at the top of the makefile for details.
  44.  
  45. Prebuilt binary executables for selected platforms are in kermit/bin, with
  46. names starting with 'cku'.  See kermit/bin/READ.ME for further information.
  47.  
  48. DOCUMENTATION
  49.  
  50.   C-Kermit 5A is documented in the book "Using C-Kermit" by Frank da Cruz and
  51.   Christine M. Gianone, Digital Press, Woburn, MA, USA.  Digital Press
  52.   ISBN: 1-55558-164-1.  Price: US $39.95.  Available in bookstores and
  53.   computer stores, or order from Columbia University, phone 1-212-854-3703,
  54.   MasterCard and Visa accepted.  Please purchase the documentation: it should
  55.   answer most of your questions, and sales help to fund the Kermit development
  56.   and support effort.
  57.  
  58. UNIX C-KERMIT FILES:
  59.  
  60. ckuaaa.hlp  - This file.
  61.  
  62. ckuker.nr   - UNIX man page for C-Kermit, to be installed in the system's
  63.               local man page directory.  Format via 'nroff -man'.
  64.  
  65. ckuker.cpp  - C-Preprocessor source for the ckuker.nr file.
  66.  
  67. The following files should be placed in a world-readable directory, such as
  68. /usr/local/lib/kermit, so everybody can read and/or copy them:
  69.  
  70. ckermit.ini - Standard C-Kermit initialization file.  Rename to .kermrc
  71.               and place in your home directory.  Or read ckuins.doc to learn
  72.               how to set up a system-wide initialization file.
  73.  
  74. ckermod.ini - Sample C-Kermit customization file.  Rename to .mykermrc and
  75.               place in your home directory.
  76.  
  77. ckermit.kdd - Sample dialing directory file.  Replace this with your own
  78.               dialing directory in the same format, and rename it to .kdd.
  79.  
  80. ckermit.knd - Sample network directory file.  Replace this with your own
  81.               dialing directory in the same format, and rename it to .knd.
  82.  
  83. ckermit.ksd - Sample services directory.  Replace this with your own services
  84.               directory in the same format, and rename to .ksd.
  85.  
  86. ckermit.upd - Updates to C-Kermit since the most recent edition of "Using
  87.               C-Kermit" was published; documentation for new features.
  88.  
  89. ckermit.bwr - General C-Kermit "Beware file" - hints and tips, known bugs, etc.
  90.  
  91. ckuker.bwr  - UNIX-specific C-Kermit "Beware File".
  92.  
  93. ckedemo.ksc, ckevt.ksc, ckepage.ksc -
  94.               Macro definitions used in "Using C-Kermit".
  95.  
  96. FILES FOR BUILDING UNIX C-KERMIT:
  97.  
  98. ckuins.doc  - UNIX C-Kermit installation instructions.  
  99.  
  100. ckcplm.doc  - C-Kermit Program Logic Manual.
  101.  
  102. ckccfg.doc  - Documentation for configuration options.
  103.  
  104. makefile    - UNIX makefile for building C-Kermit from source code.  See
  105.               ckuins.doc for details, and also read the comments at the top 
  106.               of the makefile.  This makefile has hundreds of entries in it;
  107.               please be careful to pick the most appropriate one.  (NOTE: if
  108.               you don't find a file called "makefile" then look for it under
  109.               alternative names: "Makefile", "ckuker.mak", etc.
  110.  
  111. ckubs2.mak  - Makefile specifically for 2.10 and 2.11 BSD systems.
  112.  
  113. ckpker.mk   - Makefile specifically for Plan 9.
  114.  
  115. C-KERMIT SOURCE FILES:
  116.  
  117. ckcdeb.h    - Header file common to all C-Kermit modules.
  118. ckcasc.h    - Header file for ASCII character definitions.
  119. ckcsig.h    - Header file for signal handling functions.
  120. ckuver.h    - Header file for version heralds.
  121.  
  122. ckufio.c    - UNIX (and OS/2) system-specific file i/o module for C-Kermit.
  123. ckutio.c    - UNIX system-specific communications i/o module for C-Kermit.
  124. ckusig.c    - UNIX signal handling functions.
  125. ckucon.c    - The UNIX C-Kermit CONNECT command.
  126.  
  127. ckcpro.w    - System-independent C-Kermit protocol module, written in 'wart',
  128.               a lex-like preprocessor for C. 
  129. ckwart.c    - The 'wart' preprocessor.              
  130.  
  131. ckcker.h    - Header file for Kermit protocol items.
  132.  
  133. ckcfns.c, ckcfn2.c, ckcfn3.c - System-independent Kermit protocol support
  134.               routines.
  135.  
  136. ckuusr.c, ckuus2.c, ckuus3.c, ckuus4.c, ckuus5.c, ckuus6.c, ckuus7.c -
  137.               User interface: interactive command processor.
  138.  
  139. ckuusy.c    - User interface: command-line option processor.
  140.  
  141. ckuusx.c    - Support functions shared by interactive-mode and command-line
  142.               option processors.
  143.  
  144. ckuusr.h    - Header file for user interface.
  145.  
  146. ckucmd.c    - Command-parsing functions (keywords, filenames, numbers, etc).
  147. ckucmd.h    - Header file for command-parsing functions.
  148.  
  149. ckuxla.c    - Character-set translation module.
  150. ckcxla.h    - System-independent header file for character-set translation.
  151. ckuxla.h    - UNIX-specific header file for character-set translation.
  152.  
  153. ckudia.c    - DIAL command processor.
  154. ckuscr.c    - SCRIPT command processor.
  155. ckcnet.c    - Network support module.
  156. ckcnet.h    - Header file for network support module.
  157.  
  158. OTHER FILES:
  159.  
  160. These are not included in the tar.Z file.  FTP these separately from the
  161. kermit/b directory if you need them.
  162.  
  163. ckc192.upd  - Program update history for edits 191-192.
  164. ckc190.upd  - Program update history for edits 189-190.
  165. ckc188.upd  - Program update history, edits 179-188 (big).
  166. ckc178.upd  - Program edit history, 5A edits through 178 (very big).
  167. ckcv4f.upd  - Program edit history, version 4F.
  168. ckcv4e.upd  - Program edit history, version 4E.
  169.  
  170. (End of file ckuaaa.hlp)
  171.