home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / archives / ckc072.zip / ckaaaa.hlp < prev    next >
Text File  |  1989-10-03  |  4KB  |  125 lines
  1. C-Kermit Version 4E(070), Jan 88
  2.  
  3. C-Kermit is a family of Kermit programs for many different systems, which
  4. share a common set of system-independent file transfer protocol modules,
  5. written in the C language.  C-Kermit may be built for Unix (BSD, ATT, Ultrix,
  6. SUNOS, Xenix, many others), VAX/VMS, Data General AOS/VS, the Apple Macintosh,
  7. the Commodore Amiga, and OS/9.  Additional systems will be supported in the
  8. future.
  9.  
  10. File names are lowercase on Unix systems, and are uppercase on most other
  11. systems.  C-Kermit file names are of the form:
  12.  
  13. ck<system><what>.<type>  (for experimental releases, xk instead of ck)
  14.  
  15. where:
  16.  
  17. <type> is the file type:
  18.  
  19.   c:   C language source
  20.   h:   Header file for C language source
  21.   w:   Wart preprocessor source, converted by Wart (or Lex) to a C program
  22.   nr:  Nroff/Troff text formatter source
  23.   mss: Scribe text formatter source
  24.   doc: Documentation
  25.   hlp: Help text
  26.   upd: Program change log
  27.   bwr: A "beware" file - list of known bugs, restrictions
  28.   ann: The text of an announcement of a particular version
  29.   bld: Instructions for building
  30.   mak: A Makefile or other build procedure (rename to "makefile" for UNIX)
  31.   com: (VMS only) a DCL command procedure
  32.  
  33. <system> is a single character to tell what system the file applies to:
  34.  
  35.   a: Descriptive material, documentation
  36.   c: All systems with C compilers
  37.   d: Data General
  38.   h: Harris computers (reserved)
  39.   i: Commodore Amiga (Intuition)
  40.   m: Macintosh
  41.   o: IBM PC, PS/2 with OS/2
  42.   p: IBM PC, PS/2 with MS/PC-DOS (reserved)
  43.   s: Atari ST
  44.   u: Unix or systems that simulate (some features of) Unix
  45.   v: VAX/VMS
  46.   w: Wart (really belongs in 'c' category, but...)
  47.   9: OS-9
  48.  
  49. <what> is mnemonic (up to 3 characters) for what's in the file:
  50.  
  51.   aaa: A "read-me" file, like this one
  52.   cmd: Command parsing
  53.   con: Connect command
  54.   deb: Debug/Transaction Log formats, Typedefs
  55.   dia: Modem/Dialer control
  56.   fio: System-depdendent File I/O
  57.   fns: Protocol support functions
  58.   fn2: More protocol support functions
  59.   ker: General C-Kermit definitions, information, documentation
  60.   mai: Main program
  61.   pro: Protocol
  62.   scr: Script command
  63.   tio: System-dependent terminal i/o & control and interrupt handing
  64.   usr: User interface
  65.   us2: More user interface
  66.   us3: Still more user interface
  67.  
  68. Examples:
  69.  
  70. ckaaaa.hlp - This file
  71. ckufio.c   - File i/o for Unix
  72. ckmtio.c   - Terminal i/o for Macintosh
  73. ckuker.mss - Scribe source for for Unix C-Kermit Kermit User Guide chapter
  74. ckuker.nr  - Nroff source file for Unix C-Kermit man page
  75. ckuker.mak - Makefile for building Unix C-Kermit (rename to makefile)
  76. ckmker.mak - Makefile for building Macintosh C-Kermit under Unix/SUMACC
  77.  
  78. Macintosh Kermit adds a few additional items to this list:
  79.  
  80. <type>
  81.  
  82.   hqx: binhex'd Macintosh resource (binhex version 4)
  83.   sed: sed script for massaging ckcpro.c to make it smaller
  84.   rc:  rmaker input file (text)
  85.   rsrc: (or rsr) 8-bit binary Macintosh resource
  86.  
  87. <what>
  88.  
  89.   def: Macintosh definitions header
  90.   key: key redefinition package
  91.   ke2: more key redefinition package
  92.   ke3: still more key redefinition package
  93.   kkc: common defs between ckmkey and ckmker
  94.   rem: remote server command module
  95.   res: resource info
  96.   sav: settings saver module
  97.   scr: screen (conflicts with name of script module, should be changed)
  98.   sfp: standard file package
  99.   sum: sumacc workarounds
  100.   utl: utilities
  101.  
  102. All the files necessary to build a particular implementation of C-Kermit
  103. are listed in the appropriate makefile or equivalent:
  104.  
  105.        Unix: ckuker.mak
  106.   Macintosh: ckmker.mak
  107.     VAX/VMS: ckvker.com
  108.       Amiga: ckiker.mak
  109.          DG: Read ckdker.bld
  110.  
  111. Minimal source files for building selected versions:
  112.  
  113.   Unix: ckc*.[cwh], cku*.[ch], ckwart.c, ckuker.mak (= makefile)
  114.    VMS: ckc*.[cwh], cku*.[ch], ckwart.c, ckv*.c, ckv*.com
  115.    Mac: ckc*.[cwh], ckwart.c, ckm*.[ch], ckmker.mak, ckmk*.rc, ckmpro.sed
  116.  
  117. To build the Unix version, collect the appropriate files together into
  118. their own directory, rename (mv) ckuker.mak to makefile (or Makefile),
  119. and then type "make bsd" (for Berkeley-based systems) or "make sys3" (for
  120. most AT&T System 3 for System 5 Unix implementations), or "make xxx", where
  121. xxx is one of the other options provided in the makefile (read the comments
  122. at the beginning of the makefile for further information).
  123.  
  124. (end of ckaaaa.hlp)
  125.