CKAAAA.HLP                                                           April 1991

	    GUIDE TO C-KERMIT 5A FILES AND FILE NAMING CONVENTIONS

C-Kermit is a family of Kermit programs for several different computer
systems.  The program shares a common set of system-independent file transfer
protocol modules, written in the C language.  System-dependent operations are
collected into system-specific modules for each system, or in some cases,
selected via conditional compilation (#ifdef) in the UNIX system dependent
modules.

C-Kermit may be built for Unix (BSD, ATT, Ultrix, SUNOS, Xenix, many others),
VAX/VMS, Data General AOS/VS, the Apple Macintosh, the Commodore Amiga, and
OS/9.  Additional systems can be supported in the future.

To build the UNIX version, collect the appropriate files together into their
own directory, rename (mv) ckuker.mak to makefile (or Makefile), and then read
and follow the instructions at the top of the makefile.  For more detailed
installation instructions, read ckuins.doc.

For detailed information about the VAX/VMS-specific files, see CKVAAA.HLP.

Important files:

  ckaaaa.hlp - This file (overview of other files).
  ckuker.ann - Brief list of new features of 5A.
  ckuker.upd - Edit history since version 4E (long, detailed).
  ckuker.mss - Scribe text formatter source for the C-Kermit User Guide
  ckuhdr.mss - Scribe text formatter source for the User Guide cover
  ckuker.doc - C-Kermit User Guide (plain ASCII text)
  ckuker.ps  - C-Kermit User Guide (Postscript)
  ckuker.nr  - Unix "man page"
  ckuker.mak - Makefile for UNIX (rename to "makefile")
  ckvker.com - DCL procedure to build C-Kermit for VAX/VMS
  ckvker.mak - Makefile to build C-Kermit for VAX/VMS (rename to "MAKEFILE.")
  ckvker.hlp - Help file for VMS C-Kermit
  ckuins.doc - Installation instructions and hints
  ckaplm.doc - Program logic manual

File names are lowercase on Unix systems, and are uppercase on most other
systems.  C-Kermit file names are of the form:

  ck<system><what>.<type>

where:

<type> is the file type:

  c:   C language source
  h:   Header file for C language source
  w:   Wart preprocessor source, converted by Wart (or Lex) to a C program
  nr:  Nroff/Troff text formatter source for Unix "man page"
  mss: Scribe text formatter source
  doc: Documentation
  hlp: Help text
  upd: Program update history
  bwr: A "beware" file - list of known bugs, limitations
  ann: The text of an announcement of a particular version
  mak: A Makefile or other build procedure (rename to "makefile" for UNIX)
  com: (VMS only) a DCL command procedure
  boo: "boo"-encoded executable program, decode with msbpct program (OS/2).
  hex: "hex"-encoded executable program, decode with CKVDEH program (VMS only).
  hqx: binhex'd Macintosh Kermit program, decode with binhex version 4.
  sed: sed script
  rc:  Macintosh rmaker input file (text)
  rsrc: (or rsr, or simply r)  8-bit binary Macintosh resource

<system> is a single character to tell what system the file applies to:

  a: Descriptive material, documentation
  c: All systems with C compilers
  d: Data General
  h: Harris computers (reserved)
  i: Commodore Amiga (Intuition)
  m: Macintosh
  o: IBM PS/2 with OS/2
  p: IBM PC, PS/2 with MS/PC-DOS (reserved)
  r: DEC PDP-11 with RSTS/E
  s: Atari ST
  t: DEC PDP-11 with RT-11
  u: UNIX or systems that simulate (some features of) UNIX
  v: VAX/VMS
  w: Wart (used with all systems)
  x: DEC PDP-11 with RSX-11
  9: OS-9

<what> is mnemonic (up to 3 characters) for what's in the file:

  aaa: A "read-me" file, like this one
  cmd: Command parsing
  con: Connect command
  deb: Debug/Transaction Log formats, Typedefs
  dia: Modem/Dialer control
  fio: System-depdendent File I/O
  fns: Protocol support functions
  fn2: More protocol support functions (and fn3, ...)
  ker: General C-Kermit definitions, information, documentation
  mai: Main program
  pro: Protocol
  scr: Script command
  tio: System-dependent communications i/o & control and interrupt handing
  usr: User interface
  us2: More user interface
  us3: Still more user interface (and usr4, usr5, usr6, ...)
  xla: Character set translation module
  net: Network support module
  mdb: Malloc-debugging module

Examples:

ckaaaa.hlp - This file
ckufio.c   - File i/o for Unix
ckmtio.c   - Communications i/o for Macintosh
ckuker.mss - Scribe source for for Unix C-Kermit Kermit User Guide chapter
ckuker.nr  - Nroff source file for Unix C-Kermit man page
ckuker.mak - Makefile for building Unix C-Kermit
ckmker.mak - Makefile for building Macintosh C-Kermit

All the files necessary to build a particular implementation of C-Kermit
are listed in the appropriate makefile or equivalent:

       Unix: ckuker.mak
  Macintosh: ckmker.mak
    VAX/VMS: ckvker.com
      Amiga: ckiker.mak
       OS/2: ckoker.mak
         DG: Read ckdker.bld

Minimal source files for building selected versions:

UNIX:
   ckc*.[cwh], cku*.[ch], ckwart.c, ckuker.mak (= makefile)
   VMS: ckc*.[cwh], cku*.[ch], ckwart.c, ckv*.[ch], ckvker.com
   Mac: ckc*.[cwh], ckwart.c, ckm*.[ch], ckmker.mak, ckmk*.rc

[End of CKAAAA.HLP]
