BSD 4_3 development
[unix-history] / usr / contrib / kermit / ckaaaa.hlp
CommitLineData
ee2abe03
C
1C-Kermit File Naming Conventions:
2
3(Version 4C, 30 May 1985)
4
5File names will be lowercase on Unix systems, and probably will be uppercase
6on other systems. C-Kermit file names are of the form:
7
8ck<system><what>.<type>
9
10where:
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 Unix Makefile (should be renamed to "makefile")
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 m: Macintosh
33 u: Unix or systems that simulate (some features of) Unix
34 v: VAX/VMS
35 w: Wart (really belongs in 'c' category, but...)
36
37<what> is mnemonic (up to 3 characters) for what's in the file
38
39 aaa: A "read-me" file, like this one
40 cmd: Command parsing
41 con: Connect command
42 deb: Debug/Transaction Log formats, Typedefs
43 dia: Modem/Dialer control
44 fio: System-depdendent File I/O
45 fns: Protocol support functions
46 fn2: More protocol support functions
47 ker: General C-Kermit definitions, information, documentation
48 mai: Main program
49 pro: Protocol
50 scr: Script command
51 tio: System-dependent terminal i/o & control and interrupt handing
52 usr: User interface
53 us2: More user interface
54 us3: Still more user interface
55
56Examples:
57
58ckaaaa.hlp - This file
59ckufio.c - File i/o for Unix
60ckmtio.c - Terminal i/o for Macintosh
61ckuker.mss - Scribe source for for Unix C-Kermit Kermit User Guide chapter
62ckuker.nr - Nroff source file for Unix C-Kermit man page
63ckuker.mak - Makefile for building Unix C-Kermit (rename to makefile)
64ckmker.mak - Makefile for building Macintosh C-Kermit under Unix/SUMACC
65
66Macintosh Kermit adds a few additional items to this list:
67
68<type>
69
70 hqx: binhex'd Macintosh resource (binhex version 4)
71 sed: sed script for massaging ckcpro.c to make it smaller
72 rc: rmaker input file (text)
73 rsrc: (or rsr) 8-bit binary Macintosh resource
74
75<what>
76
77 def: Macintosh definitions header
78 key: key redefinition package
79 ke2: more key redefinition package
80 ke3: still more key redefinition package
81 kkc: common defs between ckmkey and ckmker
82 rem: remote server command module
83 res: resource info
84 sav: settings saver module
85 scr: screen (conflicts with name of script module, should be changed)
86 sfp: standard file package
87 sum: sumacc workarounds
88 utl: utilities
89
90All the files necessary to build a particular implementation of C-Kermit
91are listed in the appropriate makefile or equivalent:
92
93 Unix: ckuker.mak
94Macintosh: ckmker.mak
95 VAX/VMS: ckvker.com
96
97(end of ckaaaa.hlp)