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