home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / archives / ckv196.zip / ckaaaa.txt next >
Text File  |  2000-01-02  |  16KB  |  386 lines
  1. CKAAAA.TXT                                                         1 Jan 2000
  2.  
  3.                C-KERMIT VERSION 7.0.196
  4.  
  5.                   OVERVIEW OF FILES
  6.  
  7.     Communications software for UNIX, (Open)VMS, Stratus VOS, AOS/VS, QNX,
  8.          Plan 9, OS-9, Apollo Aegis, and the Commodore Amiga.
  9.  
  10.  
  11.   Copyright (C) 1985, 2000,
  12.     Trustees of Columbia University in the City of New York.
  13.     All rights reserved.  See the C-Kermit COPYING.TXT file or the
  14.     copyright text in the ckcmai.c module for disclaimer and permissions.
  15.  
  16.  
  17. DOCUMENTATION
  18.  
  19.   C-Kermit is documented in the book "Using C-Kermit", Second Edition, by
  20.   Frank da Cruz and Christine M. Gianone, Digital Press, ISBN 1-55558-164-1.
  21.   Available at book and computer stores, or order from Columbia University
  22.   by calling +1 212 854-3703 (MasterCard and Visa accepted), or by calling
  23.   Digital Press / Butterworth-Heinemann at one of the numbers below
  24.   (MasterCard, Visa, and American Express accepted).  PLEASE PURCHASE THE
  25.   DOCUMENTATION: it shows you step-by-step how to use C-Kermit with lots of
  26.   examples and illustrations, it will answer most of your questions, and
  27.   sales help to fund the Kermit development and support effort.  Digital
  28.   Press phone numbers:
  29.  
  30.     +1 800 366-2665   (Newton, Massachusetts office for USA & Canada)
  31.     +44 1865 314627   (Oxford, England distribution centre for UK & Europe)
  32.     +61 03 9245 7111  (Melbourne, Vic, office for Australia & NZ)
  33.     +65 356-1968      (Singapore office for Asia)
  34.     +27 (31) 2683111  (Durban office for South Africa)
  35.  
  36.   The second editon of Using C-Kermit corresponds to version 6.0.  The changes
  37.   since 6.0 are documented in the file ckermit2.txt, which supplements the
  38.   second edition of the manual until the third edition is published.
  39.  
  40.   A German edition is available from Verlag Heinz Heise in Hannover, Germany,
  41.   Tel. +49 (05 11) 53 52-0, Fax. +49 (05 11) 53 52-1 29.
  42.  
  43. FILE NAMING CHANGES
  44.  
  45.   After C-Kermit 6.1 Beta.05, the names of all the text files were changed
  46.   to have a filetype of ".txt" to allow them to be handled properly by
  47.   Windows-based applications, Web browsers, etc:
  48.  
  49.     ckermit2.upd => ckermit2.txt
  50.     ckaaaa.hlp   => ckaaaa.txt
  51.     ckc195.upd   => ckc195.txt
  52.     ckuins.doc   => ckuins.txt
  53.     ckvins.doc   => ckvins.txt
  54.     ckermit.bwr  => ckcbwr.txt
  55.     ckuker.bwr   => ckubwr.txt
  56.     ckvker.bwr   => ckvbwr.txt
  57.     ckcplm.doc   => ckcplm.txt
  58.     ckccfg.doc   => ckccfg.txt
  59.  
  60.  
  61. QUICK START FOR FTP USERS (UNIX, VMS, AOS/VS, VOS, ...)
  62.  
  63.   If you have a Web browser, go to:
  64.  
  65.     http://www.columbia.edu/kermit/ckermit.html
  66.  
  67.   And take it from there.  Otherwise...
  68.  
  69.   The definitive FTP source for Kermit software is kermit.columbia.edu.
  70.   Kermit software obtained from other FTP sites is not necessarily complete
  71.   or up to date, and may have been modified.  (Note: C-Kermit is now available
  72.   from the Kermit Project on CDROM.)
  73.  
  74. C-Kermit for UNIX computers that have a C compiler and 'make' program:
  75.  
  76.   Directory kermit/archives, binary mode, file cku196.tar.Z or cku196.tar.gz
  77.  
  78.   This is a compressed tar archive of UNIX C-Kermit source code, makefile, and
  79.   other files.  Transfer in binary mode, uncompress (or gunzip), untar (tar
  80.   xvf cku196.tar), and then give the appropriate "make" command to build for
  81.   your UNIX system; read the comments in the makefile and ckuins.txt for
  82.   further info.
  83.  
  84. C-Kermit for VMS:
  85.  
  86.   If you have VMS UNZIP, get the file kermit/archives/ckv196.zip in binary
  87.   mode, unzip, and build with CKVKER.COM.  Otherwise get the file
  88.   kermit/f/ckvaaa.hlp in text mode, read it, take it from there.
  89.  
  90. Others:  In the kermit/f or kermit/test directories under the appropriate
  91. prefixes, explained below.
  92.  
  93.  
  94. INSTALLATION
  95.  
  96. Installation procedures depend on the system.  Please read the CK?INS.TXT,
  97. if any, file for your system (?=U for UNIX, V for VMS, etc).  Please note
  98. the naming and placement for the initialization files:
  99.  
  100.   CKERMIT.INI
  101.     The standard initialization file.  Please leave it as is unless you
  102.     know what you are doing and (if you are changing it or replacing it
  103.     for others to use) you are prepared to support it.  Rename this file
  104.     to .kermrc in UNIX, OS-9, BeBox, or Plan 9.  In Stratus VOS, rename
  105.     it ckermit.ini (lowercase).  On multiuser systems, it goes either in the
  106.     (or EACH) user's home (login) directory, or else in a common shared
  107.     place if C-Kermit has been configured to look in that place (see
  108.     ckccfg.txt for details).
  109.  
  110.   CKERMOD.INI
  111.     A *sample* customization file.  On multiuser OS's, a copy of this file
  112.     goes in each user's home directory, and then each user edits it to suit
  113.     her needs and preferences; e.g. by defining macros for their common
  114.     connections.
  115.  
  116.   DIALING DIRECTORIES
  117.     Dialing directory files can be system-wide, per-group, or per-user, or
  118.     any combination.  For example, there can be a corporate wide directory
  119.     shared by all users, a supplemental directory for each division or
  120.     department, and a personal directory for each user.  Simply be sure the
  121.     dialing directory files are identified a SET DIAL DIRECTORY command in
  122.     the user's (or the system-wide) C-Kermit initialization file, or in the
  123.     environment variable (logical name, symbol) K_DIAL_DIRECTORY.  (The
  124.     standard initialization file looks by default in the user's home or login
  125.     directory.)  When installing C-Kermit on multiuser platforms from which
  126.     users will dial out, you can also set environment variables for area
  127.     code, country code, and the various dialing prefixes as described on page
  128.     478 of "Using C-Kermit" (second edition), so users don't have to worry
  129.     about defining these items themselves.   Network directories and service
  130.     directories can also be set up in a similar manner.
  131.  
  132.   DOCUMENTATION
  133.     In UNIX, the general C-Kermit man page (or one of the versions tailored
  134.     for a specific platform, like HP-UX or Solaris) should be installed in
  135.     the appropriate place.  In VMS, the VMS help topic (CKVKER.HLP) should
  136.     be installed as described in CKVINS.TXT.  Plain-text documentation such
  137.     as CKERMIT2.TXT should be put in whatever place people are accustomed
  138.     to looking.
  139.  
  140. FILES AND FILE NAMING CONVENTIONS
  141.  
  142. C-Kermit is a family of Kermit programs for many different computer systems.
  143. The program shares a common set of system-independent file transfer protocol
  144. modules, written in the C language.  System-dependent operations are collected
  145. into system-specific modules for each system.
  146.  
  147. C-Kermit file names all start with the letters "CK", followed by a single
  148. letter indicating the subgroup.  When referring to these files in the UNIX,
  149. AOS/VS, or VOS environments, use lowercase letters, rather than the uppercase
  150. letters shown here.  Subgroups:
  151.  
  152.   A: General descriptive material and documentation
  153.   B: BOO file encoders and decoders (obsolete)
  154.   C: All systems with C compilers
  155.   D: Data General AOS/VS
  156.   E: Reserved for "ckermit" files, like CKERMIT.INI, CKERMIT2.TXT
  157.   F: (reserved)
  158.   G: (reserved)
  159.   H: (reserved)
  160.   I: Commodore Amiga (Intuition)
  161.   J: (unused)
  162.   K: (unused)
  163.   L: Stratus VOS
  164.   M: Macintosh with Mac OS
  165.   N: Microsoft Windows NT
  166.   O: OS/2 and/or Microsoft Windows 95/98/NT
  167.   P: Bell Labs Plan 9
  168.   Q: (reserved)
  169.   R: DEC PDP-11 with RSTS/E (reserved)
  170.   S: Atari ST GEMDOS (last supported in version 5A(189))
  171.   T: DEC PDP-11 with RT-11 (reserved)
  172.   U: UNIX or environments with UNIX-like C libraries
  173.   V: VMS and OpenVMS
  174.   W: Wart (Lex-like preprocessor, used with all systems)
  175.   X: Build lists (most recent build for each platform), e.g. ckx196.txt.
  176.   Y: (reserved)
  177.   Z: (reserved)
  178.   0-3: (reserved)
  179.   4: IBM AS/400
  180.   5-8: (reserved)
  181.   9: Microware OS-9
  182.  
  183. Examples (use lowercase on UNIX, VOS, or AOS/VS):
  184.  
  185.   CKAAAA.TXT - This file
  186.   CKVAAA.TXT - Read-me file for the VMS version
  187.   CKUFIO.C   - File i/o for UNIX
  188.   CKSTIO.C   - Communications i/o for the Atari ST
  189.   MAKEFILE   - Makefile for building UNIX C-Kermit
  190.   CKOKER.MAK - Makefile for building OS/2 C-Kermit
  191.  
  192. IMPORTANT FILES (use lowercase names on UNIX, VOS, or AOS/VS):
  193.  
  194.   CKAAAA.TXT  - This file (overview of the C-Kermit files).
  195.                 For system-specific distributions, this will normally
  196.                 be replaced by a system-specific READ.ME file.
  197.  
  198.   CKERMIT2.TXT - Updates: Supplement to "Using C-Kermit", 2nd Ed.
  199.   CKCBWR.TXT  - "Beware file" (limitations, known bugs, hints), general.
  200.   CKERMIT.INI - Standard initialization file (rename to .kermrc in UNIX, OS-9)
  201.   CKERMOD.INI - Sample customization file (rename to .mykermrc in UNIX, OS-9)
  202.   CKERMIT.KDD - Sample dialing directory file (rename to .kdd in UNIX, OS-9)
  203.   CKERMIT.KND - Sample dialing directory file (rename to .knd in UNIX, OS-9)
  204.   CKERMIT.KSD - Sample services directory file (rename to .ksd in UNIX, OS-9)
  205.   CKEDEMO.KSC - Demonstration macros from "Using C-Kermit"
  206.   CKEPAGE.KSC - Ditto
  207.   CKEVT.KSC   - Ditto
  208.  
  209. UNIX-specific files (use lowercase names on UNIX, VOS, or AOS/VS):
  210.  
  211.   CKUINS.TXT - UNIX-specific installation instructions.
  212.   CKUBWR.TXT - UNIX-specific beware file.
  213.   CKUKER.NR  - "man page" for UNIX.
  214.   CKURZSZ.INI - Macros for external protocols.
  215.  
  216. VMS-specific files:
  217.  
  218.   CKVINS.TXT - VMS-specific installation instructions.
  219.   CKVBWR.TXT - VMS-specific beware file
  220.   CKVKER.HLP - VMS C-Kermit HELP topic
  221.  
  222. DG AOS/VS-specific files:
  223.  
  224.   CKDINS.TXT - Data General AOS/VS C-Kermit installation instructions
  225.   CKDBWR.TXT - AOS/VS "beware" file
  226.   CKD*.CLI   - Procedures for building AOS/VS C-Kermit
  227.  
  228. The following files are of interest mainly to programmers and historians:
  229.  
  230.   CKCKER.ANN - Release announcements.
  231.   CKCCFG.TXT - Configuration information (feature selection), general.
  232.   CKCPLM.TXT - Program logic manual (for programmers).
  233.   CKC196.TXT - Program update history for edit 195-196 (big)
  234.   CKC190.TXT - Program update history for edits 189-190 (big).
  235.   CKC188.TXT - Program update history, edits 179-188 (big).
  236.   CKC178.TXT - Program edit history, 5A edits through 178 (very big).
  237.   CKCV4F.TXT - Program edit history, version 4F.
  238.   CKCV4E.TXT - Program edit history, version 4E.
  239.  
  240. BINARIES
  241.  
  242. If you have FTP access to kermit.columbia.edu (also known as
  243. kermit.cc.columbia.edu, ftp.cc.columbia.edu, watsun.cc.columbia.edu), you can
  244. also retrieve various C-Kermit binaries from the directory kermit/bin/ck*.*.
  245. Test versions would be in kermit/test/bin/ck*.*.  Be sure to transfer these
  246. files in binary mode.  The READ.ME file in that directory explains what's what.
  247.  
  248. SOURCE FILES
  249.  
  250. The source files for the UNIX version (all UNIX versions) are available in
  251. kermit/archives/ckuNNN.tar.Z, approximately 1MB in size.  Transfer this file
  252. in binary mode.  This is a compressed tar archive.  There is also a gzip'd
  253. version, cku196.tar.gz.  To get the binary tar archive:
  254.  
  255.   mkdir kermit                   (at shell prompt, make a Kermit directory)
  256.   cd kermit                      (make it your current directory)
  257.  
  258.   ftp kermit.columbia.edu        (make an ftp connection)
  259.   user: anonymous                (log in as user "anonymous", lower case!)
  260.   password:                      (use your email id as a password)
  261.   cd kermit/archives             (go to the archives directory)
  262.   type binary                    (specify binary file transfer)
  263.   get cku196.tar.Z               (get the tar archive) (or get cku192.tar.gz)
  264.   bye                            (disconnect and exit from ftp)
  265.  
  266.   uncompress cku196.tar.Z        (at the shell prompt, uncompress the archive)
  267.   tar xvf cku196.tar             (extract the files from the tar archive)
  268.   make xxx                       (build C-Kermit for your system)
  269.  
  270. (where "xxx" is the makefile entry appropriate for your system.)
  271.  
  272. All C-Kermit source and other text files are also kept separately in the
  273. kermit/f directory.  The files necessary to build a particular implementation
  274. of C-Kermit are listed in the appropriate makefile or equivalent:
  275.  
  276.        UNIX: makefile (or rename ckuker.mak to makefile)
  277.    2.11 BSD: ckubs2.mak (rename to makefile), ckustr.sed
  278.      Plan 9: ckpker.mk  (rename to mkfile)
  279.   Macintosh: ckmker.mak (rename to kermit.make, use MPW C 3.2)
  280.         VMS: CKVKER.COM (DCL) (and optionally also CKVKER.MMS)
  281.              or CKVOLD.COM (for VMS 4.x)
  282.       Amiga: CKIKER.MAK (Aztec C) or CKISAS.MAK (SAS C)
  283.    Atari ST: CKSKER.MAK
  284.        OS-9: CK9KER.MAK or CK9KER.GCC
  285.      AOS/VS: CKDMAK.CLI, CKDCC.CLI, CKDLNK.CLI
  286. Stratus VOS: CKLMAK.CM
  287.  
  288. Minimal source files for building selected versions (these patterns get all
  289. the files you need, and in some cases maybe a few extra):
  290.  
  291.    UNIX:   ck[cuw]*.[cwh] (including QNX, Plan 9, and BeBox)
  292.    VMS:    ck[cuwv]*.[cwh]
  293.    Mac:    ck[cuwm]*.[cwhr]
  294.    AOS/VS: ck[cuwd]*.[cwh]
  295.    VOS:    ck[cwhl]*.[cwh]
  296.    Amiga:  ck[cuwi]*.[cwh]
  297.    Atari:  ck[cuws]*.[cwh]
  298.    OS-9:   ck[cuw9]*.[cwha]
  299.  
  300. For a detailed, specific source file list for this C-Kermit release, see the
  301. file CKCxxx.TXT, where xxx is the current C-Kermit edit number, such as 196.
  302.  
  303. Finally, here is a more detailed description of the C-Kermit file naming
  304. conventions.  A C-Kermit filename has the form:
  305.  
  306.   CK<system><what>.<type>
  307.  
  308. where:
  309.  
  310. <system> is described earlier in this file;
  311.  
  312. <type> is the file type (use lowercase on UNIX, VOS, or AOS/VS):
  313.  
  314.   C:   C language source
  315.   H:   Header file for C language source
  316.   W:   Wart preprocessor source, converted by Wart (or Lex) to a C program
  317.   R:   Macintosh resource file (8-bit text)
  318.   A:   Assembler source
  319.  
  320.   TXT: Plain text.
  321.   NR:  Nroff/Troff text formatter source for UNIX "man page"
  322.   MSS: Scribe text formatter source
  323.   PS:  Typeset material to be printed on a PostScript printer
  324.   HLP: A VMS Help topic
  325.  
  326.   INI: Initialization file
  327.   KSC: A Kermit Script to be executed by the TAKE command
  328.   KDD: A Kermit Dialing Directory
  329.   KND: A Kermit Network Directory
  330.   KSD: A Kermit Services Directory
  331.  
  332.   MAK: A Makefile or other build procedure (often needs renaming)
  333.   COM: (VMS only) a DCL command procedure
  334.   CLI: (AOS/VS only) a command procedure
  335.   CMD: (OS/2 only) a Rexx command procedure
  336.  
  337.   BOO: "boo"-encoded executable program, decode with CKBUNB program.
  338.   HEX: "hex"-encoded executable program, decode with CKVDEH program (VMS only).
  339.   HQX: BinHex'd Macintosh Kermit program, decode with BinHex version 4.0.
  340.   UUE: A uuencoded binary file, decode with uudecode or (DG only) CKDECO.
  341.  
  342.   DEF: An OS/2 linker definitions file.
  343.   SED: A UNIX sed (editor) script.
  344.   STR: A file of character strings extracted from C-Kermit (BSD 2.1x).
  345.  
  346. <what> is mnemonic (up to 3 characters) for what's in the file:
  347.  
  348. NOTE: After C-Kermit 6.0, text filetypes such as .DOC and .HLP were changed
  349. to .TXT to avoid confusion in Windows-based Web browsers, which would
  350. otherwise mistake them for Microsoft Word or Windows Help documents.
  351.  
  352.   AAA: A "read-me" file, like this one
  353.   INS: Installation instructions or procedures
  354.   BWR: "Beware" file -- things to watch out for, hints and tips
  355.   KER: General C-Kermit definitions, information, documentation
  356.  
  357.   nnn: Digits: C-Kermit edit number (e.g. cku196.tar.gz)
  358.   CMD: Command parsing
  359.   CON: CONNECT command
  360.   CNS: CONNECT command (UNIX only - version that uses select(), not fork())
  361.   DEB: Debug/Transaction Log formats, Typedefs
  362.   DIA: Modem/Dialer control
  363.   FIO: System-depdendent File I/O
  364.   FNS: Protocol support functions
  365.   FN2: More protocol support functions (and FN3, ...)
  366.   LIB: Common library routines module
  367.   MAI: Main program
  368.   NET: Network i/o module
  369.   PRO: Protocol
  370.   SCR: SCRIPT command
  371.   TEL: Telnet protocol module
  372.   TIO: System-dependent communications i/o & control and interrupt handing
  373.   SIG: Signal handling module
  374.   USR: Interactive/script user interface
  375.   US2: More user interface (mainly help text)
  376.   US3: Still more user interface (and USR4, USR5, USR6, USR7)
  377.   USX: Common user interface functions
  378.   USY: Command-line parsing
  379.   XLA: Character set translation module
  380.   UNI: Unicode support
  381.   PTY: Pseudoterminal support
  382.   MDB: Malloc-debugging module (not included in real builds)
  383.   STR: Strings module (only for 2.xBSD)
  384.  
  385. (End of CKAAAA.TXT)
  386.