home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / archives / ckv201.zip / ckaaaa.txt next >
Text File  |  2002-02-16  |  15KB  |  365 lines
  1. ckaaaa.txt                                                         8 Feb 2002
  2.  
  3.                C-KERMIT VERSION 8.0.201
  4.                   OVERVIEW OF FILES
  5.  
  6.            Communications software for UNIX and (Open)VMS.
  7.  
  8.                And in former versions also for:
  9.               Stratus VOS, AOS/VS, QNX,
  10.          Plan 9, OS-9, Apollo Aegis, and the Commodore Amiga.
  11.               The Apple Macintosh, the Atari ST.
  12.  
  13.  
  14.   Copyright (C) 1985, 2002,
  15.     Trustees of Columbia University in the City of New York.
  16.     All rights reserved.  See the C-Kermit COPYING.TXT file or the
  17.     copyright text in the ckcmai.c module for disclaimer and permissions.
  18.  
  19.  
  20. DOCUMENTATION
  21.  
  22.   C-Kermit is documented in the book "Using C-Kermit", Second Edition, by
  23.   Frank da Cruz and Christine M. Gianone, Digital Press, ISBN 1-55558-164-1.
  24.  
  25.  
  26. QUICK START FOR FTP USERS
  27.  
  28.   If you have a Web browser, go to:
  29.  
  30.     http://www.columbia.edu/kermit/ckermit.html
  31.  
  32.   And take it from there.  Otherwise...
  33.  
  34.   The definitive FTP source for Kermit software is kermit.columbia.edu.
  35.   Kermit software obtained from other FTP sites is not necessarily complete
  36.   or up to date, and may have been modified.
  37.  
  38. C-Kermit for UNIX computers that have a C compiler and 'make' program:
  39.  
  40.   Directory kermit/archives, binary mode, file cku201.tar.Z or cku201.tar.gz
  41.  
  42.   This is a compressed tar archive of UNIX C-Kermit source code, makefile, and
  43.   other files.  It unpacks into its current directory, so download it into a
  44.   fresh directory.  Transfer in binary mode, uncompress (or gunzip), untar (tar
  45.   xvf cku201.tar), and then give the appropriate "make" command to build for
  46.   your UNIX system; read the comments in the makefile and ckuins.txt for
  47.   further info.
  48.  
  49. C-Kermit for VMS:
  50.  
  51.   If you have VMS UNZIP, get the file kermit/archives/ckv201.zip in binary
  52.   mode, unzip, and build with CKVKER.COM.
  53.  
  54. Others:  In the kermit/f or kermit/test directories under the appropriate
  55. prefixes, explained below.
  56.  
  57.  
  58. INSTALLATION
  59.  
  60. Installation procedures depend on the system.  Please read the CK?INS.TXT,
  61. if any, file for your system (?=U for UNIX, V for VMS, etc).  Please note
  62. the naming and placement for the initialization files:
  63.  
  64.   CKERMIT.INI
  65.     The standard initialization file.  Please leave it as is unless you
  66.     know what you are doing and (if you are changing it or replacing it
  67.     for others to use) you are prepared to support it.  Rename this file
  68.     to .kermrc in UNIX, OS-9, BeBox, or Plan 9.  In Stratus VOS, rename
  69.     it ckermit.ini (lowercase).  On multiuser systems, it goes either in the
  70.     (or EACH) user's home (login) directory, or else in a common shared
  71.     place if C-Kermit has been configured to look in that place (see
  72.     ckccfg.txt for details).
  73.  
  74.   CKERMOD.INI
  75.     A *sample* customization file.  On multiuser OS's, a copy of this file
  76.     goes in each user's home directory, and then each user edits it to suit
  77.     her needs and preferences; e.g. by defining macros for their common
  78.     connections.
  79.  
  80.   DIALING DIRECTORIES
  81.     Dialing directory files can be system-wide, per-group, or per-user, or
  82.     any combination.  For example, there can be a corporate wide directory
  83.     shared by all users, a supplemental directory for each division or
  84.     department, and a personal directory for each user.  Simply be sure the
  85.     dialing directory files are identified a SET DIAL DIRECTORY command in
  86.     the user's (or the system-wide) C-Kermit initialization file, or in the
  87.     environment variable (logical name, symbol) K_DIAL_DIRECTORY.  (The
  88.     standard initialization file looks by default in the user's home or login
  89.     directory.)  When installing C-Kermit on multiuser platforms from which
  90.     users will dial out, you can also set environment variables for area
  91.     code, country code, and the various dialing prefixes as described on page
  92.     478 of "Using C-Kermit" (second edition), so users don't have to worry
  93.     about defining these items themselves.   Network directories and service
  94.     directories can also be set up in a similar manner.
  95.  
  96.   DOCUMENTATION
  97.     In UNIX, the general C-Kermit man page (or one of the versions tailored
  98.     for a specific platform, like HP-UX or Solaris) should be installed in
  99.     the appropriate place.  In VMS, the VMS help topic (CKVKER.HLP) should
  100.     be installed as described in CKVINS.TXT.  Plain-text documentation such
  101.     as CKERMIT2.TXT should be put in whatever place people are accustomed
  102.     to looking.
  103.  
  104. FILES AND FILE NAMING CONVENTIONS
  105.  
  106. C-Kermit is a family of Kermit programs for many different computer systems.
  107. The program shares a common set of system-independent file transfer protocol
  108. modules, written in the C language.  System-dependent operations are collected
  109. into system-specific modules for each system.
  110.  
  111. C-Kermit file names all start with the letters "CK", followed by a single
  112. letter indicating the subgroup.  When referring to these files in the UNIX,
  113. AOS/VS, or VOS environments, use lowercase letters, rather than the uppercase
  114. letters shown here.  Subgroups:
  115.  
  116.   _: Security/Authentication/Encryption code, possibly regulated by law
  117.   A: General descriptive material and documentation
  118.   B: BOO file encoders and decoders (obsolete)
  119.   C: All platforms with C compilers
  120.   D: Data General AOS/VS
  121.   E: Reserved for "ckermit" files, like CKERMIT.INI, CKERMIT80.TXT
  122.   F: (reserved)
  123.   G: (reserved)
  124.   H: (reserved)
  125.   I: Commodore Amiga (Intuition)
  126.   J: (unused)
  127.   K: (unused)
  128.   L: Stratus VOS
  129.   M: Macintosh with Mac OS
  130.   N: Microsoft Windows NT
  131.   O: OS/2 and/or Microsoft Windows 95/98/ME/NT/2000/XP/...
  132.   P: Bell Labs Plan 9
  133.   Q: (reserved)
  134.   R: DEC PDP-11 with RSTS/E (reserved)
  135.   S: Atari ST GEMDOS (last supported in version 5A(189))
  136.   T: DEC PDP-11 with RT-11 (reserved)
  137.   U: UNIX or environments with UNIX-like C libraries
  138.   V: VMS and OpenVMS
  139.   W: Wart (Lex-like preprocessor, used with all systems)
  140.   X: (reserved)
  141.   Y: (reserved)
  142.   Z: (reserved)
  143.   0-3: (reserved)
  144.   4: IBM AS/400 (reserved)
  145.   5-8: (reserved)
  146.   9: Microware OS-9
  147.  
  148. Examples (use lowercase on UNIX, VOS, or AOS/VS):
  149.  
  150.   ckaaaa.txt - This file
  151.   ckufio.c   - File i/o for UNIX
  152.   ckstio.c   - Communications i/o for the Atari ST
  153.   makefile   - makefile for building UNIX C-Kermit
  154.   ckpker.mk  - makefile for building Plan 9 C-Kermit
  155.   ckvker.com - build procedure for VMS C-Kermit
  156.  
  157. IMPORTANT FILES (use lowercase names on UNIX, VOS, or AOS/VS):
  158.  
  159.   ckaaaa.txt  - This file (overview of the C-Kermit files).
  160.                 For system-specific distributions, this will normally
  161.                 be replaced by a system-specific READ.ME file.
  162.  
  163.   ckermit70.txt - Updates: Supplement to "Using C-Kermit", 2nd Ed, for 7.0.
  164.   ckermit80.txt - Updates: Supplement to "Using C-Kermit", 2nd Ed, for 8.0.
  165.   ckututor.txt  - C-Kermit Tutorial for Unix (plain text)
  166.   ckcbwr.txt  - "Beware file" (limitations, known bugs, hints), general.
  167.   ckermit.ini - Standard initialization file (rename to .kermrc in UNIX, OS-9)
  168.   ckermod.ini - Sample customization file (rename to .mykermrc in UNIX, OS-9)
  169.  
  170. The following can be found at the Kermit FTP site:
  171.  
  172.   ckermit.kdd - Sample dialing directory file (rename to .kdd in UNIX, OS-9)
  173.   ckermit.knd - Sample dialing directory file (rename to .knd in UNIX, OS-9)
  174.   ckermit.ksd - Sample services directory file (rename to .ksd in UNIX, OS-9)
  175.   ckedemo.ksc - Demonstration macros from "Using C-Kermit"
  176.   ckepage.ksc - Ditto
  177.   ckevt.ksc   - Ditto
  178.  
  179. UNIX-specific files:
  180.  
  181.   ckuins.txt - UNIX-specific installation instructions.
  182.   ckubwr.txt - UNIX-specific beware file.
  183.   ckuker.nr  - "man page" for UNIX.
  184.  
  185. VMS-specific files:
  186.  
  187.   ckvins.txt - VMS-specific installation instructions.
  188.   ckvbwr.txt - VMS-specific beware file
  189.   ckvker.hlp - VMS C-Kermit HELP topic (needs updating).
  190.  
  191. DG AOS/VS-specific files:
  192.  
  193.   ckdins.txt - Data General AOS/VS C-Kermit installation instructions
  194.   ckdbwr.txt - AOS/VS "beware" file
  195.   ckd*.cli   - Procedures for building AOS/VS C-Kermit
  196.  
  197. The following files are of interest mainly to programmers and historians
  198. (find them at the Kermit ftp site):
  199.  
  200.   ckcker.ann - Release announcements.
  201.   ckccfg.txt - Configuration information (feature selection), general.
  202.   ckcplm.txt - Program logic manual (for programmers).
  203.   ckc201.txt - Program update history for edit 201.
  204.   ckc200.txt - Program update history for edit 198-200 (big)
  205.   ckc197.txt - Program update history for edit 195-197 (big)
  206.   ckc190.txt - Program update history for edits 189-190 (big).
  207.   ckc188.txt - Program update history, edits 179-188 (big).
  208.   ckc178.txt - Program edit history, 5A edits through 178 (very big).
  209.   ckcv4f.txt - Program edit history, version 4F.
  210.   ckcv4e.txt - Program edit history, version 4E.
  211.  
  212. BINARIES
  213.  
  214. If you have FTP access to kermit.columbia.edu (also known as
  215. kermit.cc.columbia.edu, ftp.cc.columbia.edu), you can also retrieve various
  216. C-Kermit binaries from the directory kermit/bin/ck*.*, or more conventiently
  217. from the web page:
  218.  
  219.   http://www.columbia.edu/kermit/ck80binaries.html
  220.  
  221. Test versions would be in kermit/test/bin/ck*.*.  Be sure to transfer these
  222. files in binary mode.  The READ.ME file in that directory explains what's
  223. what.
  224.  
  225. SOURCE FILES
  226.  
  227. The source files for the UNIX version (all UNIX versions) are available in
  228. kermit/archives/ckuNNN.tar.Z, approximately 1MB in size.  Transfer this file
  229. in binary mode.  This is a compressed tar archive.  There is also a gzip'd
  230. version, cku201.tar.gz.  To get the binary tar archive:
  231.  
  232.   mkdir kermit                   (at shell prompt, make a Kermit directory)
  233.   cd kermit                      (make it your current directory)
  234.  
  235.   ftp kermit.columbia.edu        (make an ftp connection)
  236.   user: anonymous                (log in as user "anonymous", lower case!)
  237.   password:                      (use your email id as a password)
  238.   cd kermit/archives             (go to the archives directory)
  239.   type binary                    (specify binary file transfer)
  240.   get cku201.tar.Z               (get the tar archive) (or get cku192.tar.gz)
  241.   bye                            (disconnect and exit from ftp)
  242.  
  243.   uncompress cku201.tar.Z        (at the shell prompt, uncompress the archive)
  244.   tar xvf cku201.tar             (extract the files from the tar archive)
  245.   make xxx                       (build C-Kermit for your system)
  246.  
  247. (where "xxx" is the makefile entry appropriate for your system.)
  248.  
  249. All C-Kermit source and other text files are also kept separately in the
  250. kermit/f directory.  The files necessary to build a particular implementation
  251. of C-Kermit are listed in the appropriate makefile or equivalent:
  252.  
  253.        UNIX: makefile (or rename ckuker.mak to makefile)
  254.    2.11 BSD: ckubs2.mak (rename to makefile), ckustr.sed
  255.      Plan 9: ckpker.mk  (rename to mkfile)
  256.   Macintosh: ckmker.mak (rename to kermit.make, use MPW C 3.2)
  257.         VMS: CKVKER.COM (DCL) (and optionally also CKVKER.MMS)
  258.              or CKVOLD.COM (for VMS 4.x)
  259.       Amiga: CKIKER.MAK (Aztec C) or CKISAS.MAK (SAS C)
  260.    Atari ST: CKSKER.MAK
  261.        OS-9: ck9ker.mak or ck9ker.gcc
  262.      AOS/VS: ckdmak.cli, ckdcc.cli, ckdlnk.cli
  263. Stratus VOS: cklmak.cm
  264.  
  265. Minimal source files for building selected versions (these patterns get all
  266. the files you need, and in some cases maybe a few extra):
  267.  
  268.    UNIX:   ck[cuw_]*.[cwh] (including QNX, Plan 9, and BeBox)
  269.    VMS:    ck[cuwv]*.[cwh]
  270.    Mac:    ck[cuwm]*.[cwhr]
  271.    AOS/VS: ck[cuwd]*.[cwh]
  272.    VOS:    ck[cwhl]*.[cwh]
  273.    Amiga:  ck[cuwi]*.[cwh]
  274.    Atari:  ck[cuws]*.[cwh]
  275.    OS-9:   ck[cuw9]*.[cwha]
  276.  
  277. For a detailed, specific source file list for this C-Kermit release, see the
  278. file ckcxxx.txt, where xxx is the current C-Kermit edit number, such as 201.
  279.  
  280. Finally, here is a more detailed description of the C-Kermit file naming
  281. conventions.  A C-Kermit filename has the form:
  282.  
  283.   CK<system><what>.<type>
  284.  
  285. where:
  286.  
  287. <system> is described earlier in this file;
  288.  
  289. <type> is the file type (use lowercase on UNIX, VOS, or AOS/VS):
  290.  
  291.   c:   C language source
  292.   h:   Header file for C language source
  293.   w:   Wart preprocessor source, converted by Wart (or Lex) to a C program
  294.   r:   Macintosh resource file (8-bit text)
  295.   a:   Assembler source
  296.  
  297.   txt: Plain text.
  298.   nr:  Nroff/Troff text formatter source for UNIX "man page"
  299.   mss: Scribe text formatter source
  300.   ps:  Typeset material to be printed on a PostScript printer
  301.   hlp: A VMS Help topic
  302.  
  303.   ini: Initialization file
  304.   ksc: A Kermit Script to be executed by the TAKE command
  305.   kdd: A Kermit Dialing Directory
  306.   knd: A Kermit Network Directory
  307.   ksd: A Kermit Services Directory
  308.  
  309.   mak: A Makefile or other build procedure (often needs renaming)
  310.   com: (VMS only) a DCL command procedure
  311.   cli: (AOS/VS only) a command procedure
  312.   cmd: (OS/2 only) a Rexx command procedure
  313.  
  314.   boo: "boo"-encoded executable program, decode with CKBUNB program.
  315.   hex: "hex"-encoded executable program, decode with CKVDEH program (VMS only).
  316.   hqx: BinHex'd Macintosh Kermit program, decode with BinHex version 4.0.
  317.   uue: A uuencoded binary file, decode with uudecode or (DG only) CKDECO.
  318.  
  319.   def: An OS/2 linker definitions file.
  320.   sh:  A UNIX shell script.
  321.   sed: A UNIX sed (editor) script.
  322.   str: A file of character strings extracted from C-Kermit (BSD 2.1x only).
  323.  
  324. <what> is mnemonic (up to 3 characters) for what's in the file:
  325.  
  326. NOTE: After C-Kermit 6.0, text filetypes such as .DOC and .HLP were changed
  327. to .TXT to avoid confusion in Windows-based Web browsers, which would
  328. otherwise mistake them for Microsoft Word or Windows Help documents.
  329.  
  330.   aaa: A "read-me" file, like this one
  331.   ins: Installation instructions or procedures
  332.   bwr: "Beware" file -- things to watch out for, hints and tips
  333.   plm: Program Logic Manual
  334.   ker: General C-Kermit definitions, information, documentation
  335.  
  336.   nnn: Digits: C-Kermit edit number (e.g. cku201.tar.gz)
  337.   cmd: Command parsing
  338.   con: CONNECT command
  339.   cns: CONNECT command (UNIX only - version that uses select(), not fork())
  340.   deb: Debug/Transaction Log formats, Typedefs
  341.   dia: Modem/Dialer control
  342.   fio: System-depdendent File I/O
  343.   fns: Protocol support functions
  344.   fn2: More protocol support functions (and FN3, ...)
  345.   lib: Common library routines module
  346.   mai: Main program
  347.   net: Network i/o module
  348.   pro: Protocol
  349.   scr: SCRIPT command
  350.   tel: Telnet protocol module
  351.   tio: System-dependent communications i/o & control and interrupt handing
  352.   sig: Signal handling module
  353.   usr: Interactive/script user interface
  354.   us2: More user interface (mainly help text)
  355.   us3: Still more user interface (and USR4, USR5, USR6, USR7)
  356.   usx: Common user interface functions
  357.   usy: Command-line parsing
  358.   xla: Character set translation module
  359.   uni: Unicode support
  360.   pty: Pseudoterminal support
  361.   mdb: Malloc-debugging module (not included in real builds)
  362.   str: Strings module (only for 2.xBSD)
  363.  
  364. (End of ckaaaa.txt)
  365.