ckcplm.txt
上传用户:dufan58
上传日期:2007-01-05
资源大小:3407k
文件大小:94k
源码类别:

通讯/手机编程

开发平台:

Windows_Unix

  1. CKCPLM.TXT                                                            Feb 2000
  2. C-KERMIT PROGRAM LOGIC MANUAL
  3. As of C-Kermit version:  7.0.197
  4. This file last updated:  Tue Feb  8 16:30:55 2000
  5. Author: Frank da Cruz, Columbia University
  6. E-Mail: fdc@columbia.edu
  7.   Copyright (C) 1985, 2000,
  8.     Trustees of Columbia University in the City of New York.
  9.     All rights reserved.  See the C-Kermit COPYING.TXT file or the
  10.     copyright text in the ckcmai.c module for disclaimer and permissions.
  11. INTRODUCTION
  12. The Kermit Protocol is specified in the book "Kermit, A File Transfer
  13. Protocol" by Frank da Cruz, Digital Press / Butterworth Heinemann, Newton, MA,
  14. USA (1987), 379 pages, ISBN 0-932376-88-6.  It is assumed the reader is
  15. familiar with the Kermit protocol specification.
  16. This file attempts to describe the relationship among the modules and
  17. functions of C-Kermit 5A and later.  Before reading this file, please read the
  18. file CKAAAA.TXT for an overview of C-Kermit file naming conventions.
  19. C-Kermit is designed to be portable to any kind of computer that has a C
  20. compiler.  The source code is broken into many files that are grouped
  21. according to their function.  There are several major groups: 1 (the protocol
  22. kernel), 2 (the user interface), 3 (system-dependent primitives), 4 (network
  23. support), and 5 (formatted screen support).
  24. CONTENTS:
  25.   FILES
  26.   SOURCE CODE PORTABILITY GUIDE
  27.   GROUP 0    Library functions
  28.   GROUP 1    System-independent file transfer protocol
  29.   GROUP 1.5  Character set translation
  30.   GROUP 2    User Interface
  31.   GROUP 3    File & communications i/o and other system dependencies
  32.   GROUP 4    Network support
  33.   GROUP 5    Formatted screen support
  34.   APPENDIX I File Permissions
  35. WARNING: C-Kermit 6.1 is probably the last version preserving this
  36. organization and naming.  The next major release after 6.1 will apply some
  37. lessons we have learned about modularity and separation, and allow easier
  38. integration of the code with other applications and/or user interfaces.
  39. FILES
  40. C-Kermit source files begin with the two letters CK (lowercase on UNIX
  41. systems, uppercase on most others).  The third character denotes something
  42. about the function group and the expected level of portability.  See the file
  43. CKAAAA.TXT for details of file naming conventions and organization.
  44. One hint before proceeding: functions are scattered all over the ckc*.c
  45. and ckuu*.c modules, where function size has begun to take precedence over
  46. the desirability of grouping related functions together, the aim being to
  47. keep any particular module from growing disproportionately large.  The easiest
  48. way (in UNIX) to find out what source file a given function is defined in is
  49. like this (where the desired function is foo()...):
  50.   grep ^foo ck*.c
  51. This works because the coding convention has been to make function names
  52. always start on the left margin with their contents indented, for example:
  53. static char *
  54. foo(x,y) int x, y; {
  55.     ...
  56. }
  57. Also please note the style for bracket placement.  This allows
  58. bracket-matching text editors (such as EMACS) to help you make sure you know
  59. which opening bracket a closing bracket matches, particularly when it is no
  60. longer visible on the screen, and it also makes it easy to find the end of a
  61. function (search for '}' on the right margin).
  62. Of course EMACS tags work nicely with this format too:
  63.   $ cd <kermit-source-directory>
  64.   $ etags ck[cu]*.[ch]
  65.   $ emacs
  66.   Esc-X Visit-Tags-Table<CR><CR>
  67. (but remember that the source file for ckcpro.c is ckcpro.w!)
  68. SOURCE CODE PORTABILITY GUIDE
  69. When writing code for the system-indendent C-Kermit modules, please stick to
  70. the following coding conventions to ensure portability to the widest possible
  71. variety of C preprocessors, compilers, and linkers, as well as certain network
  72. and/or email transports:
  73. . Tabs should be set every 8 spaces, as on a VT100.
  74. . All lines must no more than 79 characters wide after tab expansion.
  75. . Note the distinction between physical tabs (ASCII 9) and the indentation
  76.   conventions, which are: 4 for block contents, 2 for most other stuff.
  77. . Try to keep variable and function names unique within 6 characters,
  78.   especially if they are used across modules, since 6 is the maximum for
  79.   some linkers.  (Actually, I think the last system that had this limitation
  80.   was turned off in the 1980s -- remember SIXBIT? -- no now maybe it's 8?)
  81. . Keep preprocessor symbols unique within 8 characters.
  82. . Don't put #include directives inside functions or { blocks }.
  83. . Don't use the #if preprocessor construction, only use #ifdef, #ifndef, #undef
  84. . Put tokens after #endif in comment brackets, e.g. #endif /* FOO */.
  85. . Don't indent preprocessor statements - # must always be first char on line.
  86. . Don't put whitespace after # in preprocessor statements.
  87. . Don't use #pragma, even within #ifdefs - it makes some preprocessors give up.
  88. . Same goes for #module, #if, etc - #ifdefs do NOT protect them.
  89. . Don't use logical operators in preprocessor constructions.
  90. . Avoid #ifdefs inside argument list to function calls.
  91. . Always cast strlen() in expressions to int: "if ((int)strlen(foo) < x)...".
  92. . Any variable whose value might exceed 16383 should be declared as long,
  93.   or if that is not possible, then as unsigned.
  94. . Unsigned long is not portable.
  95. . Don't use initializers with automatic arrays or structs.
  96. . Don't assume that struct assignment performs a copy.
  97. . Don't put prototypes for static functions into header files that are used
  98.   by modules that don't contain that function.
  99. . Avoid the construction *++p -- the order of evaluation varies.
  100. . Reportedly, some compilers even mess up with *(++p).
  101. . Don't use triple assignments, like a = b = c = 0; (or quadruple, etc).
  102.   Some compilers generate bad code for these, or crash, etc.
  103. . Structure members may not have the same names as other identifiers.
  104. . Avoid huge switch() statements with many cases.
  105. . Don't have a switch() statement with no cases (e.g. because of #ifdefs).
  106. . Don't put anything between "switch() {" and case: --   switch blocks are not
  107.   like other blocks.
  108. . Don't make character-string constants longer than about 250.
  109. . Don't write into character-string constants even when you know you are not
  110.   writing past the end because the compiler or linker might have put them into
  111.   read-only and/or shared memory, and/or coalesced multiple equal constants
  112.   so if you change one you change them all.
  113. . Don't depend on 'r' being carriage return.
  114. . Don't depend on 'n' being linefeed or for that matter any SINGLE character.
  115. . Don't depend on 'r' and 'n' being different (e.g. in switch() statements).
  116. . In other words, don't use n or r to stand for specific characters;
  117.   use 12 and 15 instead.
  118. . Don't code for "buzzword 1.0 compliance", unless "buzzword" is K&R and
  119.   "1.0" is the first edition.
  120. . Don't use or depend on anything_t (size_t, time_t, etc).
  121. . Don't use or depend on internationalization ("i18n") features, wchar_t,
  122.   locales, etc, in portable code; they are not portable.  Anyway, locales are
  123.   not the right model for Kermit's multi-character-set support.
  124. . Don't make any assumption about signal handler type.  It can be void, int,
  125.   long, or anything else.  Always declare signal handlers as SIGTYP (see
  126.   definition in ckcdeb.h and augment it if necessary) and always use
  127.   SIGRETURN at exit points from signal handlers.
  128. . Signals should always be re-armed to be used again (this barely scratches
  129.   the surface -- the difference between BSD/V7 and System V and POSIX signal
  130.   handling are numerous, and some platforms do not even support signals,
  131.   alarms, or longjmps correctly or at all -- avoid all of this stuff if you
  132.   can).
  133. . Don't call malloc() & friends from a signal handler.
  134. . memset(), memmove(), and memcpy() are not portable, don't use them without
  135.   protecting them in ifdefs.  bzero() too, except we're guaranteed to have
  136.   bzero() when using the sockets library.  See examples in the source.
  137. . Don't assume that strncpy() stops on the first null byte -- some versions
  138.   always copy the number of bytes given in arg 3.  Probably also true of
  139.   other strnblah() functions.
  140. . DID YOU KNOW.. that some versions of inet_blah() routines return IP addresses
  141.   in network byte order, while others return them local machine byte order?
  142.   So passing them to htons(), etc, is not always the right thing to do.
  143. . Don't use ANSI-format function declarations without #ifdef CK_ANSIC,
  144.   and always provide an #else for the non-ANSI case.
  145. . Don't depend on any other ANSI preprocessor features like "pasting" -- they
  146.   are often missing or nonoperational.
  147. . Don't assume any C++ syntax or semantics.
  148. . Don't declare a string as "char foo[]" in one module and "extern char * foo"
  149.   in another, or vice-versa.
  150. . With compiler makers falling all over themselves trying to outdo each other
  151.   in ANSI strictness, it has become increasingly necessary to cast EVERYTHING.
  152. . a[x], where x is an unsigned char, can produce a wild memory reference if x,
  153.   when promoted to an int, becomes negative.  Cast it to (unsigned), even
  154.   though it ALREADY IS unsigned.
  155. . Be careful how you declare functions that have char or long arguments;
  156.   for ANSI compilers you MUST use ANSI declarations to avoid promotion
  157.   problems, but you can't use ANSI declarations with non-ANSI compilers.
  158.   Thus declarations of such functions must be hideously entwined in #ifdefs.
  159.   Example of the latter:
  160.   int        /*  Put character in server command buffer  */
  161.   #ifdef CK_ANSIC
  162.   putsrv(char c)
  163.   #else
  164.   putsrv(c) char c;
  165.   #endif /* CK_ANSIC */
  166.   /* putsrv */ {
  167.       *srvptr++ = c;
  168.       *srvptr = ''; /* Make sure buffer is null-terminated */
  169.       return(0);
  170.   }
  171. . Be careful how you return characters from functions that return int values --
  172.   "getc-like functions" -- in the ANSI world.  Unless you explicitly cast the
  173.   return value to (unsigned), it is likely to be "promoted" to an int and have
  174.   its sign extended.
  175. . Here's a good one.  At least one compiler (the one on DEC OSF/1 1.3) treats
  176.   /* and */ within string constants as comment begin and end.  No amount of
  177.   #ifdefs will get around this one.  You simply can't put an unbalanced
  178.   /* or */ in a string constant, e.g. "/usr/local/doc/*.*".
  179. . Avoid putting multiple macro references on a single line, e.g.:
  180.     putchar(BS); putchar(SP); putchar(BS)
  181.   This will overflow the CPP output buffer of more than a few C preprocessors.
  182. (many, many more...  This section needs massive filling in.)
  183. C-Kermit needs constant adjustment to new OS and compiler releases.  Every
  184. new release shuffles header files or their contents, or prototypes, or data
  185. types, or levels of ANSI strictness, etc.  Every time you make an adjustment
  186. to remove a new compilation error, BE VERY CAREFUL to #ifdef it on a symbol
  187. unique to the new configuration so that the previous configuration (and all
  188. other configurations on all other platforms) remain as before.
  189. Assume nothing.  Don't assume header files are where they are supposed to be,
  190. that they contain what you think they contain, that they define specific
  191. symbols to have certain values -- or define them at all!  Don't assume system
  192. header files protect themselves against multiple inclusion.  Don't assume that
  193. particular system or library calls are available, or that the arguments are
  194. what you think they are -- order, data type, passed by reference vs value,
  195. etc.  Be very conservative when attempting to write portable code.  Avoid all
  196. advanced features.  Stick with K&R First Edition, and even then you're on
  197. shaky ground.
  198. If you see something that does not make sense, don't assume it's a mistake --
  199. it is probably there for a reason, and changing it or removing is very likely
  200. to cause compilation, linking, or runtime failures sometime, somewhere.  Some
  201. huge percentage of the code, especially in the system-dependent modules, is
  202. workarounds for compiler, linker, or API bugs.
  203. BUT... feel free to violate any or all of these rules in system-specific
  204. modules for environments in which the rules are certain not to apply.  For
  205. example, in VMS-specific code, it is OK to use #if.  But even then, allow for
  206. different compilers or compiler versions used in that same environment,
  207. e.g. VAX C vs DEC C vs GNU C.
  208. THE "CHAR" VS "UNSIGNED CHAR" DILEMMA
  209. This is one of the most aggravating and vexing things about C.  By default,
  210. chars (and char *'s) are SIGNED.  But in the modern era, we need to process
  211. characters that can have 8-bit values, such as ISO Latin-1, IBM CP 850, and
  212. other 8-bit (or 16-bit, etc) character sets, and so this data MUST be treated
  213. as unsigned.  BUT...  Some C compilers (such as those based on the Bell UNIX
  214. V7 compiler) do not support "unsigned char" as a data type.  Therefore we have
  215. the macro or typedef CHAR, which we use when we need chars to be unsigned, but
  216. which, unfortunately, resolves itself to "char" on those compilers that don't
  217. support "unsigned char".  AND SO...  We have to do a lot of fiddling at
  218. runtime to avoid sign extension and so forth.  BUT THAT'S NOT ALL...  Now some
  219. modern compilers (e.g. IBM, DEC, Microsoft) have switches that say "make all
  220. chars be unsigned" (e.g. GNU cc "-funsigned-char").  We use these switches
  221. when they are available.  Other compilers don't have these, and at the same
  222. time, are becoming increasingly strict about type mismatches, and spew out
  223. torrents of warnings when we use a CHAR where a char is expected, or vice
  224. versa.  We fix these one by one using casts, and the code becomes increasingly
  225. ugly.  But there remains a serious problem, namely that certain library and
  226. kernel functions have arguments that are declared as signed chars (or pointers
  227. to them), whereas our character data is unsigned.  Fine, we can can use casts
  228. here too -- but who knows what happens inside these routines.
  229. MODES OF OPERATION
  230. When C-Kermit is on the far end of a connection, it is said to be in
  231. remote mode.  When C-Kermit has made a connection to another computer, it
  232. is in local mode.  (If C-Kermit is "in the middle" of a multihop connection,
  233. it is still in local mode.)
  234. On another axis, C-Kermit has three major modes of operation:
  235. Command Mode
  236.   Reading and writing from the job's controlling terminal or "console".
  237.   In this mode, all i/o is handled by the Group 3 conxxx() (console i/o)
  238.   routines.
  239. Protocol Mode
  240.   Reading and writing from the communicatons device.  In this mode, all i/o is
  241.   handled by the Group 3 ttxxx() (terminal i/o) routines.
  242. Connect Mode
  243.   Reading from the keyboard with conxxx() routines and writing to the
  244.   communications device with ttxxx() routines AND vice-versa.
  245. When in local mode, the console and communications device are distinct.
  246. During file transfer, Kermit may put up a file-transfer display on the console
  247. and sample the console for interruption signals.
  248. When in remote mode, the console and communications device are the same, and
  249. therefore there can be no file-transfer display on the console or
  250. interruptions from it (except for "in-band" interruptions such as ^C^C^C).
  251. GROUP 0:
  252. Library functions, strictly portable, can be used by all modules on all
  253. platforms.  CKCLIB.H, CKCLIB.C.
  254. GROUP 1:
  255. The Kermit protocol kernel.  The filenames start with CKC.  C means that these
  256. files are supposed to be totally portable C, and are expected to compile
  257. correctly on any platform with any C compiler.  "Portable" does not mean the
  258. same as as "ANSI" -- these modules must compile on 10- and 20-year old
  259. computers, with C preprocessors, compilers, and/or linkers that have all sorts
  260. of restrictions.  The group 1 modules do not include any header files other
  261. than those that come with Kermit itself.  They do not contain any library
  262. calls (like printf) or any system calls (like open, close, read, write).
  263. Files:
  264.   CKCSYM.H - For use by C compilers that don't allow -D on the command line.
  265.   CKCASC.H - ASCII character symbol definitions.
  266.   CKCSIG.H - System-independent signal-handling definitions and prototypes.
  267.   CKCDEB.H - Originally, debugging definitions.  Now this file also contains
  268.      all definitions and prototypes that are shared by all modules in
  269.              all groups.
  270.   CKCKER.H - Kermit protocol symbol definitions.
  271.   CKCXLA.H - Character-set-related symbol definitions (see next section).
  272.   CKCMAI.C - The main program.  This module contains the declarations of all
  273.   the protocol-related global variables that are shared among the other
  274.   modules.
  275.   CKCPRO.W - The protocol module itself, written in "wart", a lex-like
  276.   preprocessor that is distributed with Kermit under the name CKWART.C.
  277.   CKCFN*.C - The protocol support functions used by the protocol module.
  278. Group 1 modules may call upon functions from Group 3 modules, but not from
  279. Group 2 modules (with the single exception that the main program invokes the
  280. user interface, which is in Group 2).  (This last assertion is really only a
  281. conjecture.)
  282. GROUP 1.5
  283. Character set translation tables and functions.  Used by the Group I protocol
  284. modules, but may be specific to different computers.  (So far, all character
  285. character sets supported by C-Kermit are supported in CKUXLA.C and CKUXLA.H,
  286. including Macintosh and IBM character sets).  These modules should be
  287. completely portable, and not rely on any kind of system or library services.
  288.   CKCXLA.H - Character-set definitions usable by all versions of C-Kermit.
  289.   CK?XLA.H - Character-set definitions for computer "?", e.g. U for UNIX.
  290.   CK?XLA.C - Character-set translation tables and functions for computer "?",
  291.   For example, CKUXLA.C for UNIX, CKMXLA.C for Macintosh.  So far, these are
  292.   the only two such modules.  The UNIX module is used for all versions of
  293.   C-Kermit except the Macintosh version.
  294.   CKCUNI.H - Unicode definitions
  295.   CKCUNI.C - Unicode module
  296.   Used for file transfer (SEND, RECEIVE, GET, REMOTE, etc), TRANSMIT,
  297.   CONNECT, etc.
  298. Here's how to add a new file character set.  Assuming it is based on the
  299. Roman (Latin) alphabet.  Let's call it "Barbarian".  First, in CK?XLA.H,
  300. add a definition for FC_BARBA (8 chars maximum length) and increase
  301. MAXFCSETS by 1.  Then, in CK?XLA.C:
  302.   . Add a barbarian entry into the fcsinfo array.
  303.   . Add a "barbarian" entry to file character set keyword table, fcstab.
  304.   . Add a "barbarian" entry to terminal character set keyword table, ttcstab.
  305.   . Add a translation table from Latin-1 to barbarian: yl1ba[].
  306.   . Add a translation table from barbarian to Latin-1: ybal1[].
  307.   . Add a translation function from Barbarian to ASCII: xbaas().
  308.   . Add a translation function from Barbarian to Latin-1: xbal1().
  309.   . Add a translation function from Latin-1 to Barbarian: xl1ba().
  310.   .  etc etc for each transfer character set...
  311.   . Add translation function pointers to the xls and xlr tables.
  312. Other translations involving Barbarian (e.g. from Barbarian to Latin-Cyrillic)
  313. are performed through these tables and functions.  See CKUXLA.H and CKUXLA.C
  314. for extensive examples.
  315. To add a new Transfer Character Set, e.g. Latin Alphabet 9 (for the Euro
  316. symbol)...
  317. In ckcxla.h:
  318.  . Add a TC_xxxx definition and increase MAXTCSETS accordingly.
  319. In ck?xla.h (since any transfer charset is also a file charset):
  320.  . Add an FC_xxxx definition and increase MAXFCSETS accordingly.
  321. In ck?xla.c:
  322.  . Add a tcsinfo[] entry.
  323.  . Make a tcstab[] keyword table entry.
  324.  . Make an fcsinfo[] table entry.
  325.  . Make an fcstab[] keyword table entry.
  326.  . Make a tcstab[] keyword table entry.
  327.  . If necessary, make a langinfo[] table entry.
  328.  . Make entries in the function pointer arrays.
  329.  . Provide any needed functions.
  330. In ckcuni.h:
  331.  . (to be filled in)
  332. In ckcuni.c:
  333.  . (to be filled in)
  334. GROUP 2:
  335. The user interface.  This is the code that communicates with the user, gets
  336. her commands, informs her of the results.  It may be command-line oriented,
  337. interactive prompting dialog, menus and arrow keys, windows and mice, speech
  338. recognition, telepathy, etc.  The user interface has three major functions:
  339. 1. Sets the parameters for the file transfer and then starts it.  This is done
  340. by setting certain (many) global variables, such as the protocol machine start
  341. state, the file specification, file type, communication parameters, packet
  342. length, window size, character set, etc.
  343. 2. Displays messages on the user's screen during the file transfer, using the
  344. screen() function, which is called by the group-1 modules.
  345. 3. Executes any commands directly that do not require Kermit protocol, such
  346. as the CONNECT command, local file management commands, parameter-setting
  347. commands, etc.
  348. If you plan to imbed the Group 1 files into a program with a different user
  349. interface, your interface must supply an appropriate screen() function, plus a
  350. couple related ones like chkint() and intmsg() for handling keyboard (or
  351. mouse, etc) interruptions during file transfer.  The best way to find out
  352. about this is to link all the C-Kermit modules together except the CKUU*.O
  353. and CKUCON.O modules, and see which missing symbols turn up.
  354. C-Kermit's character-oriented user interface (as opposed to the Macintosh
  355. version's graphical user interface) consists of the following modules.
  356. C-Kermit can be built with an interactive command parser, a command-line-
  357. option-only parser, a graphical user interface, or any combination, and it
  358. can even be built with no user interface at all (in which case it runs as a
  359. remote-mode Kermit server).
  360.   CKUUSR.H - Definitions of symbols used in Kermit's commands.
  361.   CKUUSR.H, CKUUSR.C, CKUUS2.C, CKUUS3.C, CKUUS4.C, CKUUS5.C, ... -
  362.   Kermit's interactive command parser, including the script programming
  363.   language.
  364.   CKUUSY.C - The command-line-option parser.
  365.   CKUUSX.C - Functions that are common to both the interactive and
  366.   command-line parsers.
  367.   CKUCMD.H, CKUCMD.C - The command parsing primitives used by the
  368.   interactive command parser to parse keywords, numbers, filenames, etc,
  369.   and to give help, complete fields, supply defaults, allow abbreviations
  370.   and editing, etc.  This package is totally independent of Kermit, but
  371.   does depend on the Group 3 functions.
  372.   CKUVER.H - Version heralds for different implementations.
  373.   CKUSCR.C - The (old, uucp-like) SCRIPT command.
  374.   CKUDIA.C - The DIAL command.  Includes specific knowledge of many
  375.              types of modems.
  376.   CK?CON.C - The CONNECT command.  Terminal connection, and in some
  377.              cases (Macintosh, OS/2, etc) also terminal emulation.
  378.              NOTE: As of C-Kermit 6.1, there are two different CONNECT
  379.              modules for UNIX: ckucon.c -- the regular, portable version
  380.              -- and ckucns.c, a new version that uses select() rather
  381.              than forks so it can handle encryption.  ckucns.c is the
  382.              preferred version; ckucon.c is not likely to keep pace with
  383.              it in terms of upgrades, etc.  However, since select() is
  384.              not portable to every platform, ckucon.c will be kept
  385.              indefinitely for those platforms that can't use ckucns.c.
  386.              NOTE: SunLink X.25 support is available only in ckucon.c.
  387.   CK_CRP.* - Modules having to do with authentication and encryption.
  388.   CKUAT*.*   These are not part of the general distribution since they
  389.              contain code and algorithms that are restricted by USA
  390.              export law.
  391. For other implementations, the files may, and probably do, have different
  392. names.  For example, the Macintosh graphical user interface filenames start
  393. with CKM.  OS/2 uses the CKUCMD and CKUUS* modules, but has its own CONNECT
  394. command in CKOCON.C.  And so on.
  395. Here is a brief description of C-Kermit's "user interface interface", from
  396. CKUUSR.C.  It is nowhere near complete; in particular, hundreds of global
  397. variables are shared among the many modules.  These should, some day, be
  398. collected into classes or structures that can be passed around as needed;
  399. not only for purity's sake, but also to allow for multiple simultaneous
  400. communication sessions and or user interfaces.
  401. The ckuus*.c modules depend on the existence of C library features like fopen,
  402. fgets, feof, (f)printf, argv/argc, etc.  Other functions that are likely to
  403. vary among operating systems -- like setting terminal modes or interrupts --
  404. are invoked via calls to functions that are defined in the system-dependent
  405. modules, ck?[ft]io.c.  The command line parser processes any arguments found
  406. on the command line, as passed to main() via argv/argc.  The interactive
  407. parser uses the facilities of the cmd package (developed for this program, but
  408. usable by any program).  Any command parser may be substituted for this one.
  409. The only requirements for the Kermit command parser are these:
  410. 1. Set parameters via global variables like duplex, speed, ttname, etc.  See
  411.    ckcmai.c for the declarations and descriptions of these variables.
  412. 2. If a command can be executed without the use of Kermit protocol, then
  413.    execute the command directly and set the variable sstate to 0.  Examples
  414.    include 'set' commands, local directory listings, the 'connect' command.
  415. 3. If a command requires the Kermit protocol, set the following variables:
  416.    sstate                             string data
  417.      'x' (enter server mode)            (none)
  418.      'r' (send a 'get' command)         cmarg, cmarg2
  419.      'v' (enter receive mode)           cmarg2
  420.      'g' (send a generic command)       cmarg
  421.      's' (send files)                   nfils, cmarg & cmarg2 OR cmlist
  422.      'c' (send a remote host command)   cmarg
  423.    cmlist is an array of pointers to strings.
  424.    cmarg, cmarg2 are pointers to strings.
  425.    nfils is an integer.
  426.    cmarg can be a filename string (possibly wild), or
  427.       a pointer to a prefabricated generic command string, or
  428.       a pointer to a host command string.
  429.    cmarg2 is the name to send a single file under, or
  430.       the name under which to store an incoming file; must not be wild.
  431.       If it's the name for receiving, a null value means to store the
  432.       file under the name it arrives with.
  433.    cmlist is a list of nonwild filenames, such as passed via argv.
  434.    nfils is an integer, interpreted as follows:
  435.      -1: filespec (possibly wild) in cmarg, must be expanded internally.
  436.       0: send from stdin (standard input).
  437.      >0: number of files to send, from cmlist.
  438. The screen() function is used to update the screen during file transfer.
  439. The tlog() function writes to a transaction log (if TLOG is defined).
  440. The debug() function writes to a debugging log (if DEBUG is defined).
  441. The intmsg() and chkint() functions provide the user i/o for interrupting
  442. file transfers.
  443. GROUP 3:
  444. System-dependent function definitions.  All the Kermit modules, including the
  445. command package, call upon these functions, which are designed to provide
  446. system-independent primitives for controlling and manipulating devices and
  447. files.  For UNIX, these functions are defined in the files CKUFIO.C (files),
  448. CKUTIO.C (communication devices), and CKUSIG.C (signal handling).
  449. For VMS, the files are CKVFIO.C, CKVTIO.C, and CKUSIG.C (VMS can use the same
  450. signal handling routines as UNIX).  For OS/2, CKOFIO.C, CKOTIO.C, CKOSIG.C
  451. (OS/2 has its own signal handling).  It doesn't really matter what the files
  452. are called, except for Kermit distribution purposes (grouping related files
  453. together alphabetically), only that each function is provided with the name
  454. indicated, observes the same calling and return conventions, and has the same
  455. type.
  456. The Group 3 modules contain both functions and global variables that are
  457. accessed by modules in the other groups.  These are now described.
  458. (By the way, I got this list by linking all the C-Kermit modules together
  459. except CKUTIO and CKUFIO.  These are the symbols that ld reported as undefined)
  460. A. Variables:
  461. char *DELCMD;
  462.   Pointer to string containing command for deleting files.
  463.   Example: char *DELCMD = "rm -f ";  (UNIX)
  464.   Example: char *DELCMD = "delete "; (VMS)
  465.   Note trailing space.  Filename is concatenated to end of this string.
  466.   NOTE: DELCMD is used only in versions that do not provide their own
  467.   built-in DELETE command.
  468. char *DIRCMD;
  469.   Pointer to string containing command for listing files when a filespec
  470.   is given.
  471.   Example: char *DIRCMD = "/bin/ls -l "; (UNIX)
  472.   Example: char *DIRCMD = "directory ";  (VMS)
  473.   Note trailing space.  Filename is concatenated to end of this string.
  474.   NOTE: DIRCMD is used only in versions that do not provide their own
  475.   built-in DIRECTORY command.
  476. char *DIRCM2;
  477.   Pointer to string containing command for listing files when a filespec
  478.   is not given.  (currently not used, handled in another way.)
  479.   Example: char *DIRCMD2 = "/bin/ls -ld *";
  480.   NOTE: DIRCMD2 is used only in versions that do not provide their own
  481.   built-in DIRECTORY command.
  482. char *PWDCMD;
  483.   Pointer to string containing command to display current directory.
  484.   Example: char *PWDCMD = "pwd ";
  485.   NOTE: PWDCMD is used only in versions that do not provide their own
  486.   built-in PWD command.
  487. char *SPACMD;
  488.   Pointer to command to display free disk space in current device/directory.
  489.   Example: char *SPACMD = "df .";
  490.   NOTE: SPACMD is used only in versions that do not provide their own
  491.   built-in SPACE command.
  492. char *SPACM2;
  493.   Pointer to command to display free disk space in another device/directory.
  494.   Example: char *SPACM2 = "df ";
  495.   Note trailing space.  Device or directory name is added to this string.
  496.   NOTE: SPACMD2 is used only in versions that do not provide their own
  497.   built-in SPACE command.
  498. char *TYPCMD;
  499.   Pointer to command for displaying the contents of a file.
  500.   Example: char *TYPCMD = "cat ";
  501.   Note trailing space.  Device or directory name is added to this string.
  502.   NOTE: TYPCMD is used only in versions that do not provide their own
  503.   built-in TYPE command.
  504. char *WHOCMD;
  505.   Pointer to command for displaying logged-in users.
  506.   Example: char *WHOCMD = "who ";
  507.   Note trailing space.  Specific user name may be added to this string.
  508. int backgrd = 0;
  509.   Flag for whether program is running in foreground (0) or background
  510.   (nonzero).  Background operation implies that screen output should not be
  511.   done and that all errors should be fatal.
  512. int ckxech;
  513.   Flag for who is to echo console typein:
  514.   1 - The program (system is not echoing).
  515.   0 - The system, front end, terminal, etc (not this program)
  516. char *ckxsys;
  517.   Pointer to string that names the computer and operating system.
  518.   Example: char *ckxsys = " NeXT Mach 1.0";
  519.   Tells what computer system ckxv applies to.
  520.   In UNIX Kermit, this variable is also used to print the program herald,
  521.   and in the SHOW VERSION command.
  522. char *ckxv;
  523.   Pointer to version/edit info of ck?tio.c module.
  524.   Example: char *ckxv = "UNIX Communications Support, 6.0.169, 6 Sep 96";
  525.   Used by SHOW VERSION command.
  526. char *ckzsys;
  527.   Like ckxsys, but briefer.
  528.   Example: char *ckzsys = " 4.3 BSD";
  529.   Tells what platform ckzv applies to.
  530.   Used by the SHOW VERSION command.
  531. char *ckzv;
  532.   Pointer to version/edit info of ck?fio.c module.
  533.   Example: char *ckzv = "UNIX File support, 6.0.113, 6 Sep 96";
  534.   Used by SHOW VERSION command.
  535. int dfflow;
  536.   Default flow control.
  537.   0 = none, 1 = Xon/Xoff, ... (see FLO_xxx symbols in ckcdeb.h)
  538.   Set to by group 3 module.
  539.   Used by ckcmai.c to initialize flow control variable.
  540. int dfloc;
  541.   Default location.
  542.   0 = remote, 1 = local.
  543.   Set by group 3 module.
  544.   Used by ckcmai.c to initialize local variable.  Used in various places in
  545.   the user interface.
  546. int dfprty;
  547.   Default parity.
  548.   0 = none, 'e' = even, 'o' = odd, 'm' = mark, 's' = space.
  549.   Set by Group 3 module.  Used by ckcmai.c to initialize parity variable.
  550. char *dftty;
  551.   Default communication device.
  552.   Set by group 3 module.  Used in many places.
  553.   This variable should be initialized the the symbol CTTNAM, which is defined
  554.   in ckcdeb.h, e.g. as "/dev/tty" for UNIX, "TT:" for VAX/VMS, etc.
  555.   Example: char *dftty = CTTNAM;
  556. char *mtchs[];
  557.   Array of string pointers to filenames that matched the most recent
  558.   wildcard match, i.e. the most recent call to zxpand().  Used (at least) by
  559.   command parsing package for partial filename completion.
  560. int tilde_expand;
  561.   Flag for whether to attempt to expand leading tildes in directory names
  562.   (used in UNIX only, and then only when the symbol DTILDE is defined.
  563. int ttnproto;
  564.   The protocol being used to communicate over a network device.  Values are
  565.   defined in ckcnet.h.  Example: NP_TELNET is network protocol "telnet".
  566. int maxnam;
  567.   The maximum length for a filename, exclusive of any device or directory
  568.   information, in the format of the host operating system.
  569. int maxpath;
  570.   The maximum length for a fully specified filename, including device
  571.   designator, directory name, network node name, etc, in the format of
  572.   the host operating system, and including all punctuation.
  573. int ttyfd;
  574.   File descriptor of the communication device.  -1 if there is no open
  575.   or usable connection, including when C-Kermit is in remote mode.
  576.   Since this is not implemented everywhere, references to it are in
  577.   #ifdef CK_TTYFD..#endif.
  578. B. Functions.
  579. These are divided into three categories: file-related functions (B.1),
  580. communication functions (B.2), and miscellaneous functions (B.3).
  581. B.1.  File-related functions.
  582. In most implementations, these are collected together into a module called
  583. CK?FIO.c, where ? = U (UNIX), V (VMS), O (OS/2), etc (see CKAAAA.TXT).  To be
  584. totally system-independent, C-Kermit maintains its own file numbers, and
  585. provides the functions described in this section to deal with the files
  586. associated with them.  The file numbers are referred to symbolically, and are
  587. defined as follows in CKCKER.H:
  588. #define ZCTERM      0      /* Console terminal */
  589. #define ZSTDIO      1 /* Standard input/output */
  590. #define ZIFILE     2 /* Current input file for SEND command */
  591. #define ZOFILE      3      /* Current output file for RECEIVE command */
  592. #define ZDFILE      4      /* Current debugging log file */
  593. #define ZTFILE      5      /* Current transaction log file */
  594. #define ZPFILE      6      /* Current packet log file */
  595. #define ZSFILE      7 /* Current session log file */
  596. #define ZSYSFN     8 /* Input from a system function (pipe) */
  597. #define ZRFILE      9           /* Local file for READ command */  (NEW)
  598. #define ZWFILE     10           /* Local file for WRITE command */ (NEW)
  599. #define ZMFILE     11           /* Auxilliary file for internal use */ (NEW)
  600. #define ZNFILS     12      /* How many defined file numbers */
  601. In the descriptions below, fn refers to a filename, and n refers to one of
  602. these file numbers.  Functions are of type int unless otherwise noted, and are
  603. listed alphabetically.
  604. int
  605. chkfn(n) int n;
  606.   Checks the file number n.  Returns:
  607.   -1: File number n is out of range
  608.    0: n is in range, but file is not open
  609.    1: n in range and file is open
  610. int
  611. iswild(filspec) char *filespec;
  612.   Checks if the file specification is "wild", i.e. contains metacharacters
  613.   or other notations intended to match multiple filenames.  Returns:
  614.    0: not wild
  615.    1: wild
  616. int
  617. isdir(string) char *string;
  618.   Checks if the string is the name of an existing directory.  Returns:
  619.    0: not a directory (including any kind of error)
  620.    1: it is an existing directory
  621.   The idea is to check whether the string can be "cd'd" to, so in some cases
  622.   (e.g. OS/2) it might also indicate any file structured device, such as a
  623.   disk drive (like A:).  Other nonzero returns indicate system-dependent
  624.   information; e.g. in VMS isdir("[.FOO]") returns 1 but isdir("FOO.DIR;1")
  625.   returns 2 to indicate the directory-file name is in a format that needs
  626.   conversion before it can be combined with a filename.
  627. char *
  628. zfcdat(name) char *name;
  629.   Returns modification (preferably, otherwise creation) date/time of file
  630.   whose name is given in the argument string.  Return value is a pointer to a
  631.   string of the form yyyymmdd hh:mm:ss, for example 19931231 23:59:59, which
  632.   represents the local time (no timezone or daylight savings time finagling
  633.   required).  Returns the null string ("") on failure.  The text pointed to by
  634.   the string pointer might be in a static buffer, and so should be copied to a
  635.   safe place by the caller before any subsequent calls to this function.
  636. struct zfnfp *
  637. zfnqfp(fname, buflen, buf)  char * fname; int buflen; char * buf;
  638.   Given the filename "fname", the corresponding fully qualified, absolute
  639.   filename is placed into the buffer buf, with maximum length buflen.
  640.   On failure returns a NULL pointer.  On success returns a pointer to
  641.   a struct zfnfp (see ckcdeb.h) containing pointers to the full pathname
  642.   and to just the filename.  All references to this function in mainline
  643.   code must be protected by #ifdef ZFNQFP..#endif, because it is not present
  644.   in all of the ck*fio.c modules.  So if you implement this function in a
  645.   version that did not have it before, be sure to add #define ZFNQFP in the
  646.   appropriate spot in ckcdeb.h.
  647. int
  648. zfseek(pos) long pos;
  649.   Positions the input pointer on the current input file to the given position.
  650.   The pos argument is 0-based, the offset (distance in bytes) from beginning
  651.   of the file.  Needed for RESEND, PSEND, and other recovery operations.  This
  652.   function is not necessarily possible on all systems, e.g. record-oriented
  653.   systems.  It should only be used on binary files (i.e. files we are sending
  654.   in binary mode) and stream-oriented file systems.  Returns -1 on failure, 0
  655.   on success.
  656. int
  657. zchdir(dirnam) char *dirnam;
  658.   Change current or default directory to the one given in dirnam.
  659.   Returns 1 on success, 0 on failure.
  660. long
  661. zchki(fn) char *fn;
  662.   Check to see if file with name fn is a regular, readable, existing file,
  663.   suitable for Kermit to send -- not a directory, not a symbolic link, etc.
  664.   Returns:
  665.   -3 if file exists but is not accessible (e.g. read-protected);
  666.   -2 if file exists but is not of a readable type (e.g. a directory);
  667.   -1 on error (e.g. file does not exist, or fn is garbage);
  668.   >= 0 (length of file) if file exists and is readable.
  669.   Also see isdir(), zgetfs().
  670. int
  671. zchkpid(pid) unsigned long pid;
  672.   Returns 1 if the given process ID (e.g. pid in UNIX) is valid and active,
  673.   0 otherwise.
  674. long
  675. zgetfs(fn) char *fn;
  676.   Get the size of the given file, regardless of accessibility.  Used for
  677.   directory listings.  Unlike zchki(), should return the size of any kind
  678.   of file, even a directory.  zgetfs() also should serve as a mini "get
  679.   file info" function that can be used until we design a better one, by
  680.   also setting some global variables:
  681.     int zgfs_link   = 1/0 = file is (not) a symbolic link.
  682.     int zgfs_dir    = 1/0 = file is (not) a directory.
  683.     char linkname[] = if zgfs_link != 0, name of file link points to.
  684.   Returns:
  685.     -1 on error (e.g. file does not exist, or fn is garbage);
  686.     >= 0 (length of file) if file exists and is readable.
  687. int
  688. zchko(fn) char *fn;
  689.   Checks to see if a file of the given name can be created.  Returns:
  690.   -1 if file cannot be created, or on any kind of error.
  691.    0 if file can be created.
  692. int
  693. zchkspa(fn,len) char *f; long len;
  694.   Check to see if there is sufficient space to store the file named fn,
  695.   which is len bytes long.  Returns:
  696.   -1 on error.
  697.    0 if there is not enough space.
  698.    1 if there is enough space.
  699.   If you can't write a function to do this, then just make a dummy that
  700.   always returns 1.  Higher level code will recover from disk-full errors.
  701.   The receiving Kermit uses this function to refuse an incoming file based
  702.   on its size, via the attribute mechanism.
  703. int
  704. zchin(n,c) int n; int *c;
  705.   Get a character from file number n, return it in c (call with &c).
  706.   Returns:
  707.   -1 on failure, including EOF.
  708.    0 on success with character in c.
  709. int
  710. zchout(n,c) int n; char c;
  711.   Write the character c to file number n.  Returns:
  712.   -1 error
  713.    0 OK
  714. int
  715. zclose(n) int n;
  716.   Close file number n.  Returns:
  717.   -1 error
  718.    1 OK
  719. int
  720. zdelet(fn) char *name;
  721.   Attempts to delete the named file.  Returns:
  722.   -1 on error
  723.    0 if file was deleted successfully
  724. char *
  725. zgperm(char * f)
  726.   Returns a pointer to the system-dependent numeric permissions/protection
  727.   string for file f, or NULL upon failure.  Used if CK_PERMS is defined.
  728. char *
  729. ziperm(char * f)
  730.   Returns a pointer to the system-dependent symbolic permissions/protection
  731.   string for file f, or NULL upon failure.  Used if CK_PERMS is defined.
  732.   Example: In UNIX zgperm(f) might return "100770", but ziperm() might
  733.   return "-rwxrwx---".  In VMS, zgperm() would return a hexadecimal string,
  734.   but ziperm() would return something like "(RWED,RWED,RE,)".
  735. char *
  736. zgtdir()
  737.   Returns a pointer to the name of the current directory, folder, etc, or a
  738.   NULL pointer if the current directory cannot be determined.  If possible,
  739.   the directory specification should be (a) fully specified, e.g. as a
  740.   complete pathname, and (b) be suitable for appending a filename.  Thus, for
  741.   example, UNIX directory names should end with '/'.  VMS directory names
  742.   should look like DEV:[NAME] (rather than, say, NAME.DIR;1).
  743. char *
  744. zhome()
  745.   Returns a pointer to a string containing the user's home directory, or NULL
  746.   upon error.  Should be formatted like zgtdir() (q.v.).
  747. int
  748. zinfill()
  749.   This function is used by the macro zminchar(), which is defined in ckcker.h.
  750.   zminchar() manages its own buffer, and calls zinfill() to fill it whenever
  751.   it becomes empty.  It is only used for sending files, and reads characters
  752.   only from file number ZIFILE.  zinfill() returns -1 upon end of file,
  753.   -2 upon fatal error, and -3 upon timeout (e.g. when reading from a pipe);
  754.   otherwise it returns the first character from the buffer it just read.
  755. int
  756. zkself()
  757.   Kills the current job, session, process, etc, logs out, disappears.  Used by
  758.   the Kermit server when it receives a BYE command.  On failure, returns -1.
  759.   On success, does not return at all!  This function should not be called
  760.   until all other steps have been taken to close files, etc.
  761. VOID
  762. zstrip(fn,&fn2) char *fn1, **fn2;
  763.   Strip device and directory, etc, from file specification, leaving only the
  764.   filename.  For example DUA0:[PROGRAMS]OOFA.C;3 becomes OOFA.C, or
  765.   /usr/fdc/oofa.c becomes oofa.c.  Returns pointer to result in fn2.
  766. VOID
  767. zltor(fn,fn2) char *fn1, *fn2;
  768.   Local-To-Remote filename translation.  Translates the local filename fn into
  769.   a format suitable for transmission to an arbitrary type of computer, and
  770.   copies the result into the buffer pointed to by fn2.  Translation may involve
  771.   (a) stripping the device and/or directory/path name, (b) converting
  772.   lowercase to uppercase, (c) removing spaces and strange characters, or
  773.   converting them to some innocuous alphabetic character like X, (d)
  774.   discarding or converting extra periods (there should not be more than one).
  775.   Does its best.  Returns no value.  name2 is a pointer to a buffer, furnished
  776.   by the caller, into which zltor() writes the resulting name.  No length
  777.   checking is done.
  778. #ifdef NZLTOR
  779. VOID
  780. nzltor(fn,fn2,convert,pathnames,max) char *fn1,*fn2; int convert,pathnames,max;
  781.   Replaces zltor.  This new version handles pathnames and checks length.  fn1
  782.   and fn2 are as in zltor.  This version is called unconditionally for each
  783.   file, rather than only when filename conversion is enabled.  Pathnames can
  784.   have the following values:
  785.     PATH_OFF: Pathname, if any, is to be stripped
  786.     PATH_REL: The relative pathname is to be included
  787.     PATH_ABS: The full pathname is to be included
  788.   After handling pathnames, conversion is done to the result as in the zltor
  789.   description if convert != 0; if relative or absolute pathnames are included,
  790.   they are converted to UNIX format, i.e. with slash (/) as the directory
  791.   separator.  The max parameter specifies the maximum size of fn2.
  792. #endif /* NZLTOR */
  793. int
  794. nzxpand(fn,flags) char *fn; int flags;
  795.   Replaces zxpand(), which is obsolete as of C-Kermit 7.0.
  796.   Call with:
  797.    s = pointer to filename or pattern.
  798.    flags = option bits:
  799.      flags & ZX_FILONLY   Match regular files
  800.      flags & ZX_DIRONLY   Match directories
  801.      flags & ZX_RECURSE   Descend through directory tree
  802.      flags & ZX_MATCHDOT  Match "dot files"
  803.      flags & ZX_NOBACKUP  Don't match "backup files"
  804.   Returns the number of files that match s, with data structures set up
  805.   so that first file (if any) will be returned by the next znext() call.
  806.   If ZX_FILONLY and ZX_DIRONLY are both set, or neither one is set, files and
  807.   directories are matched.
  808.   NOTE: It is essential that the number returned by nzxpand() reflect the
  809.   actual number of filenames that will be returned by znext calls().  In
  810.   other words:
  811.     for (n = nzxpand(string,flags); n > 0; n--) {
  812.         znext(buf);
  813.         printf("%sn", buf);
  814.     }
  815.   should print all the file names; no more, no less.
  816.   NOTE 2: In UNIX, DOS, OS-9, etc, where directories contain entries
  817.   for themselves (.) and the superior directory (..), these should NOT be
  818.   included in the list under any circumstances, including when ZX_MATCHDOT
  819.   is set.
  820.   NOTE 3: Additional option bits might be added in the future, e.g. for
  821.   sorting (sort by date/name/size, reverse/ascending, etc).
  822. int
  823. zmail(addr,fn) char *addr, fn;
  824.   Send the local, existing file fn as e-mail to the address addr.  Returns:
  825.   Returns 0 on success
  826.    2 if mail delivered but temp file can't be deleted
  827.   -2 if mail can't be delivered
  828. int
  829. zmkdir(path) char *path;
  830.   The path can be a file specification that might contain directory
  831.   information, in which the filename is expected to be included, or an
  832.   unambiguous directory specification (e.g. in UNIX it must end with "/").
  833.   This routine attempts to create any directories in the given path
  834.   that don't already exist.  Returns:
  835.    0 or greater success: no directories needed creation,
  836.      or else all directories that needed creation were created successfully;
  837.      the return code is the number of directories that were created.
  838.   -1 on failure to create any of the needed directories.
  839. int
  840. zrmdir(path) char *path;
  841.   Attempts to remove the given directory.  Returns 0 on success, -1 on
  842.   failure.  The detailed semantics are open -- should it fail if the directory
  843.   contains any files or subdirectories, etc.  It is probably best for this
  844.   routine to behave in whatever manner is customary on the underlying
  845.   platform; e.g. in UNIX, VMS, DOS, etc, where directories can not be removed
  846.   unless they are empty.
  847. VOID
  848. znewn(fn,s) char *fn, **s;
  849.   Transforms the name fn into a filename which is guaranteed to be unique.
  850.   If the file fn does not exist, then the new name will be the same as fn.
  851.   Otherwise, it will be different.  Does its best, returns no value.  New
  852.   name is created in caller's space.  Call like this: znewn(old,&new);.
  853.   The second parameter is a pointer to the new name.  This pointer is set
  854.   by znewn() to point to a static string in its own space.
  855. int
  856. znext(fn) char *fn;
  857.   Copies the next file name from a file list created by zxpand() into the
  858.   string pointed to by fn (see zxpand).  If no more files, then the null
  859.   string is placed there.  Returns 0 if there are no more filenames, with
  860.   0th element the array pointed to by fn set to NUL.  If there is a filename,
  861.   it is stored in the array pointed to by fn, and a positive number is
  862.   returned.  NOTE: This is a change from earlier definitions of this function
  863.   (pre-1999), which returned the number of files remaining; thus 0 was the
  864.   return value when returning the final file.  However, no mainline code
  865.   ever depended on the return value, so this change should be safe.
  866. int
  867. zopeni(n,fn) int n; char *fn;
  868.   Opens the file named fn for input as file number n.  Returns:
  869.     0 on failure.
  870.     1 on success.
  871. (zopeno - the second two parameters are new to C-Kermit 5A)
  872. int
  873. zopeno(n,fn,zz,fcb) int n; char *name; struct zattr *zz; struct filinfo *fcb;
  874.   Attempts to open the named file for output as file number n.  zz is a Kermit
  875.   file attribute structure as defined in ckcdeb.h, containing various
  876.   information about the file, including its size, creation date, and so forth.
  877.   This function should attempt to honor as many of these as possible.  fcb is
  878.   a "file control block" in the traditional sense, defined in ckcdeb.h,
  879.   containing information of interest to complicated file systems like VAX/VMS,
  880.   IBM MVS, etc, like blocksize, record length, organization, record format,
  881.   carriage control, disposition (like create vs append), etc.  Returns:
  882.     0 on failure.
  883.     1 on success.
  884. int
  885. zoutdump()
  886.   Dumps an output buffer.  Used with the macro zmchout() defined in ckcker.h.
  887.   Used only with file number ZOFILE, i.e. the file that is being received by
  888.   Kermit during file transfer.  Returns:
  889.    -1 on failure.
  890.     0 on success.
  891. int
  892. zprint(p,fn) char *p, *f;
  893.   Prints the file with name fn on a local printer, with options p.  Returns:
  894.   Returns 0 on success
  895.     3 if file sent to printer but can't be deleted
  896.    -3 if file can't be printed
  897. int
  898. zrename(fn,fn2) char *fn, *fn2;
  899.   Changes the name of file fn to fn2.  If fn2 is the name of an existing
  900.   directory, or a file-structured device, then file fn1 is moved to that
  901.   directory or device, keeping its original name.  If fn2 lacks a directory
  902.   separator when passed to this function, an appropriate one is supplied.
  903.   Returns:
  904.    -1 on failure.
  905.     0 on success.
  906. int
  907. zcopy(source,dest) char * source, * dest;
  908.   Copies the source file to the destination.  One file only.
  909.   No wildcards.  The destination string may be a filename or a directory
  910.   name.  Returns:
  911.    0 on success.
  912.   <0 on failure:
  913.   -2 = source file is not a regular file.
  914.   -3 = source file not found.
  915.   -4 = permission denied.
  916.   -5 = source and destination are the same file.
  917.   -6 = i/o error.
  918.   -1 = other error.
  919. VOID
  920. zrtol(fn,fn2) char *fn, *fn2;
  921.   Remote-To-Local filename translation.  Translates a "standard" filename
  922.   (see zrtol) to a local filename.  For example, in Unix this function might
  923.   convert an all-uppercase name to lowercase, but leave lower- or mix-case
  924.   names alone.  Does its best, returns no value.  New name is in string
  925.   pointed to by fn2.  No length checking is done.
  926. #ifdef NZLTOR
  927. nzrtol(fn,fn2,convert,pathnames,max) char *fn1,*fn2; int convert,pathnames,max;
  928.   Replaces zrtol.  Like zrtol but handles pathnames and checks length.  See
  929.   nzltor for detailed description of parameters.
  930. #endif /* NZLTOR */
  931. int
  932. zsattr(xx) struct zattr *xx; {
  933.   Fills in a Kermit file attribute structure for the file which is to be sent,
  934.   namely the currently open ZIFILE.
  935.   Returns:
  936.   -1 on failure.
  937.    0 on success with the structure filled in.
  938.   If any string member is null, then it should be ignored by the caller.
  939.   If any numeric member is -1, then it should be ignored by the caller.
  940. int
  941. zshcmd(s) char *s;
  942.   s contains to pointer to a command to be executed by the host computer's
  943.   shell, command parser, or operating system.  If the system allows the user
  944.   to choose from a variety of command processors (shells), then this function
  945.   should employ the user's preferred shell.  If possible, the user's job
  946.   (environment, process, etc) should be set up to catch keyboard interruption
  947.   signals to allow the user to halt the system command and return to Kermit.
  948.   The command must run in ordinary, unprivileged user mode.
  949.   If possible, this function should return -1 on failure to start the command,
  950.   or else it should return 1 if the command succeeded and 0 if it failed.
  951. int
  952. pexitstatus
  953.   zshcmd() and zsyscmd() should set this to the command's actual exit status
  954.   code if possible.
  955. int
  956. zsyscmd(s) char *s;
  957.   s contains to pointer to a command to be executed by the host computer's
  958.   shell, command parser, or operating system.  If the system allows the user
  959.   to choose from a variety of command processors (shells), then this function
  960.   should employ the system standard shell (e.g. /bin/sh for Unix), so that the
  961.   results will always be the same for everybody.  If possible, the user's job
  962.   (environment, process, etc) should be set up to catch keyboard interruption
  963.   signals to allow the user to halt the system command and return to Kermit.
  964.   The command must run in ordinary, unprivileged user mode.
  965.   If possible, this function should return -1 on failure to start the command,
  966.   or else it should return 1 if the command succeeded and 0 if it failed.
  967. VOID
  968. z_exec(s,args) char * s; char * args[];
  969.   This one executes the command s (which is searched for using the system's
  970.   normal searching mechanism, such as PATH in UNIX), with the given argument
  971.   vector, which follows the conventions of UNIX argv[]: the name of the
  972.   command pointed to by element 0, the first arg by element 1, and so on.
  973.   A null args[] pointer indicates the end of the arugment list.  All open
  974.   files must remain open so the exec'd process can use them.  Returns only
  975.   if unsuccessful.
  976. int
  977. zsinl(n,s,x) int n, x; char *s;
  978.   Reads a line from file number n.
  979.   Writes the line into the address s provided by the caller.
  980.   Writing terminates when newline is read, but with newline discarded.
  981.   Writing also terminates upon EOF or if length x is exhausted.
  982.   Returns:
  983.   -1 on EOF or error.
  984.    0 on success.
  985. int
  986. zsout(n,s) int n; char *s;
  987.   Writes the string s out to file number n.  Returns:
  988.   -1 on failure.
  989.    0 on success.
  990. int
  991. zsoutl(n,s) int n; char *s;
  992.   Writes the string s out to file number n and adds a line (record) terminator
  993.   (boundary) appropriate for the system and the file format.
  994.   Returns:
  995.   -1 on failure.
  996.    0 on success.
  997. int
  998. zsoutx(n,s,x) int n, x; char *s;
  999.   Writes exactly x characters from string s to file number n.  If s has
  1000.   fewer than x characters, then the entire string s is written.  Returns:
  1001.   -1 on error.
  1002.   >= 0 on success, the number of characters actually written.
  1003. int
  1004. zstime(f,yy,x) char *f; struct zattr *yy; int x;
  1005.   Sets the creation date (and other attributes) of an existing file, or
  1006.   compares a file's creation date with a given date.  Call with:
  1007.   f  = pointer to name of existing file.
  1008.   yy = pointer to a Kermit file attribute structure in which yy->date.val
  1009.        is a date of the form yyyymmdd hh:mm:ss, e.g. 19900208 13:00:00, which
  1010.        is to be used for setting or comparing the date.  Other attributes
  1011.        in the struct can also be set, such as the protection/permission
  1012.        (See Appendix I), when it makes sense (e.g. "yy->lprotect.val" can be
  1013.        set if the remote system ID matches the local one).
  1014.   x  = is a function code: 0 means to set the file's creation date as given.
  1015.        1 means compare the date from the yy struct with the file's date.
  1016.   Returns:
  1017.   -1 on any kind of error.
  1018.    0 if x is 0 and the file date was set successfully.
  1019.    0 if x is 1 and date from attribute structure > file creation date.
  1020.    1 if x is 1 and date from attribute structure <= file creation date.
  1021. VOID
  1022. zstrip(name,name2) char *name, **name2;
  1023.   Strips pathname from filename "name".  Constructs the resulting string
  1024.   in a static buffer in its own space and returns a pointer to it in name2.
  1025.   Also strips device name, file version numbers, and other "non-name" material.
  1026. (zxcmd - arguments are new, writing to a command is new)
  1027. int
  1028. zxcmd(n,s) char *s;
  1029.   Runs a system command so its output can be accessed as if it were file n.
  1030.   The command is run in ordinary, unprivileged user mode.
  1031.   If n is ZSTDIO or ZCTERM, returns -1.
  1032.   If n is ZIFILE or ZRFILE, then Kermit reads from the command, otherwise
  1033.   Kermit writes to the command.  Returns 0 on error, 1 on success.
  1034. int
  1035. zxpand(fn) char *fn;
  1036.   OBSOLETE!  Replaced by nzxpand(), q.v.
  1037. int
  1038. zxrewind()
  1039.   Returns the number of files returned by the most recent zxpand call,
  1040.   and resets the list to the beginning so the next znext() call returns the
  1041.   first file.  Returns -1 if zxpand has not yet been called.  If this function
  1042.   is available, ZXREWIND should be defined; otherwise it should not be
  1043.   referenced.
  1044. int
  1045. xsystem(cmd) char *cmd;
  1046.   Executes the system command without redirecting any of its i/o, similar
  1047.   (well, identical) to system() in Unix.  But before passing the command to
  1048.   the system, xsystem() ensures that all privileges are turned off, so that
  1049.   the system command will execute in ordinary unprivileged user mode.
  1050. B.1.2 IKSD Functions
  1051. These must be implemented in any C-Kermit version that is to be installed as
  1052. an Internet Kermit Service Daemon (IKSD).  IKSD is expected to be started by
  1053. the Internet Daemon (e.g. inetd) with its standard i/o redirected to the
  1054. incoming connection.
  1055. int ckxanon;
  1056.   Nonzero if anonymous logins allowed.
  1057. extern int inserver;
  1058.   Nonzero if started in IKSD mode.
  1059. extern int isguest;
  1060.   Nonzero if IKSD and user logged in anonymously.
  1061. extern char * homdir;
  1062.   Pointer to user's home directory.
  1063. extern char * anonroot;
  1064.   Pointer to file-system root for anonymous users.
  1065. Existing functions must make "if (inserver && isguest)" checks for actions
  1066. that would not be legal for guests: zdelete(), zrmdir(), zprint(), zmail(),
  1067. etc.
  1068. int
  1069. zvuser(name) char * name;
  1070.   Verifies that user "name" exists and is allowed to log in.  If the name is
  1071.   "ftp" or "anonymous" and ckxanon != 0, a guest login is set up.  Returns 0
  1072.   if user not allowed to log in, nonzero if user may log in.
  1073. zvpass(string) char * string;
  1074.   Verifies password of the user from the most recent zvuser() call.  Returns
  1075.   nonzero if password is valid for user, 0 if it isn't.  Makes any appropriate
  1076.   system log entries (IKSD logins, failed login attempts, etc).  If password
  1077.   is valid, logs the user in as herself (if real user), or sets up restricted
  1078.   anonymous access if user is guest (e.g. changes file-system root to
  1079.   anonroot and sets isguest = 1).
  1080. void
  1081. zsyslog()
  1082.   Begins any desired system logging of an IKSD session.
  1083. void
  1084. zvlogout()
  1085.   Terminates an IKSD session.  In most cases this is simply a wrapper for
  1086.   exit() or doexit(), with some system logging added.
  1087. B.1.3 Security/Privilege Functions (all)
  1088. These functions are used by C-Kermit to adapt itself to operating systems
  1089. where the program can be made to run in a "privileged" mode.  C-Kermit
  1090. should NOT read and write files or start subprocesses as a privileged program.
  1091. This would present a serious threat to system security.  The security package
  1092. has been installed to prevent such security breaches by turning off the
  1093. program's special privileges at all times except when they are needed.
  1094. In UNIX, the only need Kermit has for privileged status is access to the UUCP
  1095. lockfile directory, in order to read, create, and destroy lockfiles, and to
  1096. open communication devices that are normally protected against the user.
  1097. Therefore, privileges should only be enabled for these operations and disabled
  1098. at all other times.  This relieves the programmer of the responsibility of
  1099. putting expensive and unreliable access checks around every file access and
  1100. subprocess creation.
  1101. Strictly speaking, these functions are not required in all C-Kermit
  1102. implementations, because their use (so far, at least) is internal to the group
  1103. 3 modules.  However, they should be included in all C-Kermit implementations
  1104. for operating systems that support the notion of a privileged program (UNIX,
  1105. RSTS/E, what else?).
  1106. int
  1107. priv_ini()
  1108.   Determine whether the program is running in privileged status.  If so,
  1109.   turn off the privileges, in such a way that they can be turned on again
  1110.   when needed.  Called from sysinit() at program startup time.  Returns:
  1111.     0 on success
  1112.     nonzero on failure, in which case the program should halt immediately.
  1113. int
  1114. priv_on()
  1115.   If the program is not privileged, this function does nothing.  If the
  1116.   program is privileged, this function returns it to privileged status.
  1117.   priv_ini() must have been called first.  Returns:
  1118.     0 on success
  1119.     nonzero on failure
  1120. int
  1121. priv_off()
  1122.   Turns privileges off (if they are on) in such a way that they can be
  1123.   turned back on again.  Returns:
  1124.     0 on success
  1125.     nonzero on failure
  1126. int
  1127. priv_can()
  1128.   Turns privileges off in such a way that they cannot be turned back on.
  1129.   Returns:
  1130.     0 on success
  1131.     nonzero on failure
  1132. int
  1133. priv_chk()
  1134.   Attempts to turns privileges off in such a way that they can be turned on
  1135.   again later.  Then checks to make sure that they were really turned off.
  1136.   If they were not really turned off, then they are cancelled permanently.
  1137.   Returns:
  1138.     0 on success
  1139.     nonzero on failure
  1140. B.2.  Console-Related Functions.
  1141. These relate to the program's "console", or controlling terminal, i.e. the
  1142. terminal that the user is logged in on and types commands at, or on a PC or
  1143. workstation, the actual keyboard and screen.
  1144. int
  1145. conbin(esc) char esc;
  1146.   Puts the console into "binary" mode, so that Kermit's command parser can
  1147.   control echoing and other treatment of characters that the user types.
  1148.   esc is the character that will be used to get Kermit's attention during
  1149.   packet mode; puts this in a global place.  Sets the ckxech variable.
  1150.   Returns:
  1151.   -1 on error.
  1152.    0 on success.
  1153. int
  1154. concb(esc) char esc;
  1155.   Put console in "cbreak" (single-character wakeup) mode.  That is, ensure
  1156.   that each console character is available to the program immediately when the
  1157.   user types it.  Otherwise just like conbin().  Returns:
  1158.   -1 on error.
  1159.    0 on success.
  1160. int
  1161. conchk()
  1162.   Returns a number, 0 or greater, the number of characters waiting to be read
  1163.   from the console, i.e. the number of characters that the user has typed that
  1164.   have not been read yet.
  1165. long
  1166. congspd();
  1167.   Returns the speed ("baud rate") of the controlling terminal, if known,
  1168.   otherwise -1L.
  1169. int
  1170. congks(timo) int timo;
  1171.   Get Keyboard Scancode.  Reads a keyboard scan code from the physical console
  1172.   keyboard.  If the timo parameter is greater than zero, then times out and
  1173.   returns -2 if no character appears within the given number of seconds.  Upon
  1174.   any other kind of error, returns -1.  Upon success returns a scan code,
  1175.   which may be any positive integer.  For situations where scan codes cannot
  1176.   be read (for example, when an ASCII terminal is used as the job's
  1177.   controlling terminal), this function is identical to coninc(), i.e. it
  1178.   returns an 8-bit character value.  congks() is for use with workstations
  1179.   whose keyboards have Alternate, Command, Option, and similar modifier keys,
  1180.   and Function keys that generate codes greater than 255.
  1181. int
  1182. congm()
  1183.   Console get modes.  Gets the current console terminal modes and saves them
  1184.   so that conres() can restore them later.  Returns 1 if it got the modes OK,
  1185.   0 if it did nothing (e.g. because Kermit is not connected with any terminal),
  1186.   -1 on error.
  1187. int
  1188. coninc(timo) int timo;
  1189.   Console Input Character.  Reads a character from the console.  If the timo
  1190.   parameter is greater than zero, then coninc() times out and returns -2 if no
  1191.   character appears within the given number of seconds.  Upon any other kind
  1192.   of error, returns -1.  Upon success, returns the character itself, with a
  1193.   value in the range 0-255 decimal.
  1194. VOID
  1195. conint(f,s) SIGTYP (*f)(), (*s)();
  1196.   Sets the console to generate an interrupt if the user types a keyboard
  1197.   interrupt character, and to transfer control the signal-handling function f.
  1198.   For systems with job control, s is the address of the function that suspends
  1199.   the job.  Sets the global variable "backgrd" to zero if Kermit is running in
  1200.   the foreground, and to nonzero if Kermit is running in the background.
  1201.   See ckcdeb.h for the definition of SIGTYP.  No return value.
  1202. VOID
  1203. connoi()
  1204.   Console no interrupts.  Disable keyboard interrupts on the console.
  1205.   No return value.
  1206. int
  1207. conoc(c) char c;
  1208.   Write character c to the console terminal.  Returns:
  1209.   0 on failure, 1 on success.
  1210. int
  1211. conol(s) char *s;
  1212.   Write string s to the console.  Returns -1 on error, 0 or greater on
  1213.   success.
  1214. int
  1215. conola(s) char *s[]; {
  1216.   Write an array of strings to the console.  Returns -1 on error, 0 or greater
  1217.   on success.
  1218. int
  1219. conoll(s) char *s;
  1220.   Write string s to the console, followed by the necessary line termination
  1221.   characters to put the console cursor at the beginning of the next line.
  1222.   Returns -1 on error, 0 or greater on success.
  1223. int
  1224. conres()
  1225.   Restore the console terminal to the modes obtained by congm().  Returns:
  1226.   -1 on error, 0 on success.
  1227. int
  1228. conxo(x,s) int x; char *s;
  1229.   Write x characters from string s to the console.  Returns 0 or greater on
  1230.   success, -1 on error.
  1231. char *
  1232. conkbg();
  1233.   Returns a pointer to the designator of the console keyboard type.
  1234.   For example, on a PC, this function would return "88", "101", etc.
  1235.   Upon failure, returns a pointer to the empty string.
  1236. B.3 - Communication Device Functions
  1237. The communication device is the device used for terminal emulation and file
  1238. transfer.  It may or may not be the same device as the console, and it may
  1239. or may not be a terminal device (it could also be a network device).  For
  1240. brevity, the communication device is referred to here as the "tty".  When the
  1241. communication device is the same as the console device, Kermit is said to be
  1242. in remote mode.  When the two devices are different, Kermit is in local mode.
  1243. int
  1244. ttchk()
  1245.   Returns the number of characters that have arrived at the communication
  1246.   device but have not yet been read by ttinc(), ttinl(), and friends.  If
  1247.   communication input is buffered (and it should be), this is the sum of the
  1248.   number of unread characters in Kermit's buffer PLUS the number of unread
  1249.   characters in the operating system's internal buffer.  The call must be
  1250.   nondestructive and nonblocking, and as inexpensive as possible.
  1251.   Returns:
  1252.    0 or greater on success,
  1253.    0 in case of internal error,
  1254.   -1 or less when it determines the  connection has been broken,
  1255.      or there is no connection.
  1256.   That is, a negative return from ttchk() should reliably indicate that there
  1257.   is no usable connection.  Furthermore, ttchk() should be callable at any
  1258.   time to see if the connection is open.  When the connection is open, every
  1259.   effort must be made to ensure that ttchk returns an accurate number of
  1260.   characters waiting to be read, rather than just 0 (no characters) or 1
  1261.   (1 or more characters), as would be the case when we use select().  This
  1262.   aspect of ttchk's operation is critical to successful operation of sliding
  1263.   windows and streaming, but "nondestructive buffer peeking" is an obscure
  1264.   operating system feature, and so when it is not available, we have to do it
  1265.   ourselves by managing our own internal buffer at a level below ttinc(),
  1266.   ttinl(), etc, as in the UNIX version (non-FIONREAD case).
  1267.   An external global variable, clsondisc, if nonzero, means that if a serial
  1268.   connection drops (carrier on-to-off transition detected by ttchk()), the
  1269.   device should be closed and released automatically.
  1270. int
  1271. ttclos()
  1272.   Closes the communication device (tty or network).  If there were any kind of
  1273.   exclusive access locks connected with the tty, these are released.  If the
  1274.   tty has a modem connection, it is hung up.  For true tty devices, the
  1275.   original tty device modes are restored.  Returns:
  1276.   -1 on failure.
  1277.    0 on success.
  1278. int
  1279. ttflui()
  1280.   Flush communications input buffer.  If any characters have arrived but have
  1281.   not yet been read, discard these characters.  If communications input is
  1282.   buffered by Kermit (and it should be), this function flushes Kermit's buffer
  1283.   as well as the operating system's internal input buffer.
  1284.   Returns:
  1285.   -1 on failure.
  1286.    0 on success.
  1287. int
  1288. ttfluo()
  1289.   Flush tty output buffer.  If any characters have been written but not
  1290.   actually transmitted (e.g. because the system has been flow-controlled),
  1291.   remove them from the system's output buffer.  (Note, this function is
  1292.   not actually used, but it is recommended that all C-Kermit programmers
  1293.   add it for future use, even if it is only a dummy function that returns 0
  1294.   always.)
  1295. int
  1296. ttgmdm()
  1297.   Looks for the modem signals CTS, DSR, and CTS, and returns those that are
  1298.   on in as its return value, in a bit mask as described for ttwmdm,
  1299.   in which a bit is on (1) or off (0) according to whether the corresponding
  1300.   signal is on (asserted) or off (not asserted).  Return values:
  1301.   -3 Not implemented
  1302.   -2 if the line does not have modem control
  1303.   -1 on error
  1304.   >= 0 on success, with bit mask containing the modem signals.
  1305. long
  1306. ttgspd()
  1307.   Returns the current tty speed in BITS (not CHARACTERS) per second, or -1
  1308.   if it is not known or if the tty is really a network, or upon any kind of
  1309.   error.  On success, the speed returned is the actual number of bits per
  1310.   second, like 1200, 9600, 19200, etc.
  1311. int
  1312. ttgwsiz()
  1313.   Get terminal window size.  Returns -1 on error, 0 if the window size can't
  1314.   be obtained, 1 if the window size has been successfully obtained.  Upon
  1315.   success, the external global variables tt_rows and tt_cols are set to the
  1316.   number of screen rows and number of screen columns, respectively.
  1317.   As this function is not implemented in all ck*tio.c modules, calls to it
  1318.   must be wrapped in #ifdef CK_TTGWSIZ..#endif.  NOTE: This function must
  1319.   be available to use the TELNET NAWS feature (Negotiate About Window Size)
  1320.   as well as Rlogin.
  1321. int
  1322. tthang()
  1323.   Hang up the current tty device.  For real tty devices, turn off DTR for
  1324.   about 1/3-1/2 second (or other length of time, depending on the system).
  1325.   If the tty is really a network connection, close it.  Returns:
  1326.   -1 on failure.
  1327.    0 if it does not even try to hang up.
  1328.    1 if it believes it hung up successfully.
  1329. VOID
  1330. ttimoff()
  1331.   Turns off all pending timer interrupts.
  1332. int
  1333. ttinc(timo) int timo; (function is old, return codes are new)
  1334.   Reads one character from the communication device.  If timo is greater than
  1335.   zero, wait the given number of seconds and then time out if no character
  1336.   arrives, otherwise wait forever for a character.  Returns:
  1337.   -3 internal error (e.g. tty modes set wrong)
  1338.   -2 communications disconnect
  1339.   -1 timeout or other error
  1340.   >= 0 the character that was read.
  1341.   It is HIGHLY RECOMMENDED that ttinc() be internally buffered so that calls
  1342.   to it are relatively inexpensive.  If it is possible to to implement ttinc()
  1343.   as a macro, all the better, for example something like:
  1344.   #define ttinc(t) ( (--txbufn >= 0) ? txbuf[ttbufp++] : txbufr(t) )
  1345.   (see description of txbufr() below)
  1346. (ttinl - 5th arg, requirement not to destroy read-ahead characters)
  1347. int
  1348. ttinl(dest,max,timo,eol,start,turn)
  1349.  int max,timo,turn; CHAR *dest, eol, start;
  1350.   ttinl() is Kermit's packet reader.  Reads a packet from the communications
  1351.   device, or up to max characters, whichever occurs first.  A line is a string
  1352.   of characters starting with the start character up to and including the
  1353.   character given in eol or until the length is exhausted, or, if turn != 0,
  1354.   until the line turnaround character (turn) is read.  If turn is 0, ttinl()
  1355.   *should* use the packet length field to detect the end, to allow for the
  1356.   possibility that the eol character appears unprefixed in the packet data.
  1357.   (The turnaround character is for half-duplex linemode connections.)
  1358.   If timo is greater than zero, ttinl() times out if the eol character is not
  1359.   encountered within the given number of seconds and returns -1.
  1360.   The characters that were input are copied into "dest" with their parity bits
  1361.   stripped if parity is not none.  The first character copied into dest should
  1362.   be the start character, and the last should be the final character of the
  1363.   packet (the last block check character).  ttinl() should also absorb and
  1364.   discard the eol and turn characters, and any other characters that are
  1365.   waiting to be read, up until the next start character, so that subsequent
  1366.   calls to ttchk() will not succeed simply because there are some terminators
  1367.   still sitting in the buffer that ttinl() didn't read.  This operation, if
  1368.   performed, MUST NOT BLOCK (so if it can't be performed in a guaranteed
  1369.   nonblocking way, don't do it).
  1370.   On success, ttinl() returns the number of characters read.  Optionally,
  1371.   ttinl() can sense the parity of incoming packets.  If it does this, then it
  1372.   should set the global variable ttprty accordingly.  ttinl() should be coded
  1373.   to be as efficient as possible, since it is at the "inner loop" of packet
  1374.   reception.  ttinl() returns:
  1375.    -1 Timeout or other possibly correctable error.
  1376.    -2 Interrupted from keyboard.
  1377.    -3 Uncorrectable i/o error -- connection lost, configuration problem, etc.
  1378.    >= 0 on success, the number of characters that were actually read
  1379.         and placed in the dest buffer, not counting the trailing null.
  1380. int
  1381. ttoc(c) char c;
  1382.   Outputs the character c to the communication line.  If the operation fails
  1383.   to complete within two seconds, this function returns -1.  Otherwise it
  1384.   returns the number of characters actually written to the tty (0 or 1).  This
  1385.   function should only be used for interactive, character-mode operations, like
  1386.   terminal connection, script execution, dialer i/o, where the overhead of the
  1387.   signals and alarms does not create a bottleneck.  (THIS DESCRIPTION NEEDS
  1388.   IMPROVEMENT -- If the operation fails within a "certain amount of time"...
  1389.   which might be dependent on the communication method, speed, etc.  In
  1390.   particular, flow-control deadlocks must be accounted for and broken out of
  1391.   to prevent the program from hanging indefinitely, etc.)
  1392. int
  1393. ttol(s,n) int n; char *s;
  1394.   Kermit's packet writer.  Writes the n characters of the string pointed to
  1395.   to by s.  NOTE: It is ttol's responsibility to write ALL of the characters,
  1396.   not just some of them.  Returns:
  1397.   -1 on a possibly correctable error (so it can be retried).
  1398.   -3 on a fatal error, e.g. connection lost.
  1399.   >= 0 on success, the actual number of characters written (the specific
  1400.      number is not actually used for anything).
  1401. (ttopen - negative value for modem = network, new timeout feature)
  1402. int
  1403. ttopen(ttname,lcl,modem,timo) char *ttname; int *lcl, modem, timo;
  1404.   Opens a tty device, if it is not already open.  ttopen must check to make
  1405.   sure the SAME device is not already open; if it is, ttopen returns
  1406.   successfully without doing anything.  If a DIFFERENT device is currently
  1407.   open, ttopen() must call ttclos() to close it before opening the new one.
  1408. Parameters:
  1409.     ttname: character string - device name or network host name.
  1410.     lcl:   If called with lcl < 0, sets value of lcl as follows:
  1411.       0: the terminal named by ttname is the job's controlling terminal.
  1412.       1: the terminal named by ttname is not the job's controlling terminal.
  1413.       If the line is already open, or if the requested line can't
  1414.       be opened, then lcl remains (and is returned as) -1.
  1415.     modem:
  1416.       Less than zero: this is the negative of the network type,
  1417.       and ttname is a network host name.  Network types (from ckcnet.h):
  1418.         NET_TCPB 1   TCP/IP Berkeley (socket)  (implemented in ckutio.c)
  1419.         NET_TCPA 2   TCP/IP AT&T (streams)     (not yet implemented)
  1420.         NET_DEC  3   DECnet                    (not yet implemented)
  1421.       Zero or greater: ttname is a terminal device name.
  1422.       Zero means a direct connection (don't use modem signals).
  1423.       Positive means use modem signals depending on the current setting
  1424.       of ttcarr ( see ttscarr() ).
  1425.     timo:
  1426.       > 0: number of seconds to wait for open() to return before timing out.
  1427.       <=0: no timer, wait forever (e.g. for incoming call).
  1428.     For real tty devices, ttopen() attempts to gain exclusive access to the
  1429.     tty device, for example in UNIX by creating a "lockfile" (in other
  1430.     operating systems, like VMS, exclusive access probably requires no special
  1431.     action).
  1432.   Side effects:
  1433.     Copies its arguments and the tty file descriptor to global variables that
  1434.     are available to the other tty-related functions, with the lcl value
  1435.     altered as described above.   Gets all parameters and settings associated
  1436.     with the line and puts them in a global area, so that they can be restored
  1437.     by ttres(), e.g. when the device is closed.
  1438.   Returns:
  1439.     0 on success
  1440.    -5 if device is in use
  1441.    -4 if access to device is denied
  1442.    -3 if access to lock mechanism denied
  1443.    -2 upon timeout waiting for device to open
  1444.    -1 on other error
  1445. int
  1446. ttpkt(speed,flow,parity) long speed; int flow, parity;
  1447.   Puts the currently open tty device into the appropriate modes for
  1448.   transmitting Kermit packets.  The arguments are interpreted as follows:
  1449.   speed: if speed > -1, and the device is a true tty device, and Kermit is in
  1450.          local mode, ttpkt also sets the speed.
  1451.   flow:  if in the range 0-3, ttpkt selects the corresponding type of flow
  1452.          control.  Currently 0 is defined as no flow control, 1 is Xon/Xoff,
  1453.          and no other types are defined.  If (and this is a horrible hack, but
  1454.          it goes back many years and will be hard to eradicate) flow is 4,
  1455.          then the appropriate tty modes are set for modem dialing, a special
  1456.          case in which we talk to a modem-controlled line without requiring
  1457.          carrier.  If flow is 5, then we require carrier.
  1458.   parity:  This is simply copied into a global variable so that other
  1459.          functions (like ttinl, ttinc, etc) can use it.
  1460.   Side effects: Copies its arguments to global variables, flushes the terminal
  1461.          device input buffer.
  1462.   Returns:
  1463.    -1 on error.
  1464.     0 on success.
  1465. int
  1466. ttsetflow(int)
  1467.   Enables the given type of flow control on the open serial communications
  1468.   device immediately.  Arguments are the FLO_xxx values from ckcdeb.h, except
  1469.   FLO_DIAL, FLO_DIAX, or FLO_AUTO, which are not actual flow-control types.
  1470.   Returns 0 on success, -1 on failure.  This definition added 6 Sep 96.
  1471. long *
  1472. ttspdlist() 6 Sep 1997
  1473.   Returns a pointer to an array of longs, or NULL on failure.  On success,
  1474.   element 0 of the array contains number, n, indicating how many follow.
  1475.   Elements 1-n are serial speeds, expressed in bits per second, that are legal
  1476.   on this platform.  The user interface may use this list to construct a menu,
  1477.   keyword table, etc.  As this is a new function, its use is protected by
  1478.   #ifdef TTSPDLIST..#endif.
  1479. int
  1480. ttres()
  1481.   Restores the tty device to the modes and settings that were in effect at
  1482.   the time it was opened (see ttopen).  Returns:
  1483.   -1 on error.
  1484.    0 on success.
  1485. int
  1486. ttruncmd(string) char * string;
  1487.   Runs the given command on the local system, but redirects its input and
  1488.   output to the communication (SET LINE, SET PORT, or SET HOST) device.
  1489.   Returns 1 on success, 0 on failure.
  1490. int
  1491. ttscarr(carrier) int carrier;
  1492.   Copies its argument to a variable that is global to the other tty-related
  1493.   functions, and then returns it.  The values for carrier are defined in
  1494.   ckcdeb.h: CAR_ON, CAR_OFF, CAR_AUTO.  ttopen(), ttpkt(), and ttvt() use this
  1495.   variable when deciding how to open the tty device and what modes to select.
  1496.   The meanings are these:
  1497.   CAR_OFF:  Ignore carrier at all times.
  1498.   CAR_ON:   Require carrier at all times, except when dialing.
  1499.             This means, for example, that ttopen() could hang forever waiting
  1500.             for carrier if it is not present.
  1501.   CAR_AUTO: If the modem type is zero (i.e. the connection is direct), this
  1502.             is the same as CAR_OFF.  If the modem type is positive, then heed
  1503.             carrier during CONNECT (ttvt mode), but ignore it at other times
  1504.             (packet mode, during SET LINE, etc).  Compatible with pre-5A
  1505.             versions of C-Kermit.  This should be the default carrier mode.
  1506.   Kermit's DIAL command ignores the carrier setting, but ttopen(), ttvt(), and
  1507.   ttpkt() all honor the carrier option in effect at the time they are called.
  1508.   None of this applies to remote mode (the tty device is the job's controlling
  1509.   terminal) or to network host connections (modem type is negative).
  1510. int
  1511. ttsndb()
  1512.   Send a BREAK signal on the tty device.  On a real tty device, send a real
  1513.   BREAK lasting approximately 275 milliseconds.  If this is not possible,
  1514.   simulate a BREAK by (for example) dropping down some very low baud rate,
  1515.   like 50, and sending a bunch of null characters.  On a network connection,
  1516.   do the appropriate network protocol for BREAK.  Returns:
  1517.   -1 on error.
  1518.    0 on success.
  1519. int
  1520. ttsndlb()
  1521.   Like ttsndb(), but sends a "Long BREAK" (approx 1.5 seconds).
  1522.   For network connections, it is identical to ttsndb().
  1523.   Currently, this function is used only if CK_LBRK is defined (as it is
  1524.   for UNIX and VAX/VMS).
  1525. int
  1526. ttsspd(cps) int cps; (argument is now cps instead of bps)
  1527.   For real tty devices only, set the device transmission speed to (note
  1528.   carefully) TEN TIMES the argument.  The argument is in characters per
  1529.   second, but transmission speeds are in bits per second.  cps are used rather
  1530.   than bps because high speeds like 38400 are not expressible in a 16-bit int
  1531.   but longs cannot be used because keyword-table values are ints and not longs.
  1532.   If the argument is 7, then the bps is 75, not 70.  If the argument is 888,
  1533.   this is a special code for 75/1200 split-speed operation (75 bps out, 1200
  1534.   bps in).  Returns:
  1535.   -1 on error, meaning the requested speed is not valid or available.
  1536.   >= 0 on success (don't try to use this value for anything).
  1537. int
  1538. ttvt(speed,flow) long speed; int flow;
  1539.   Puts the currently open tty device into the appropriate modes for terminal
  1540.   emulation.  The arguments are interpreted as in ttpkt().  Side effects:
  1541.   ttvt() stores its arguments in global variables, and sets a flag that it has
  1542.   been called so that subsequent calls can be ignored so long as the arguments
  1543.   are the same as in the last effective call.  Other functions, such as
  1544.   ttopen(), ttclose(), ttres(), ttvt(), etc, that change the tty device in any
  1545.   way must unset this flag.  In UNIX Kermit, this flag is called tvtflg.
  1546. int
  1547. ttwmdm(mdmsig,timo) int mdmsig, timo;
  1548.   Waits up to timo seconds for all of the given modem signals to appear.
  1549.   mdmsig is a bit mask, in which a bit is on (1) or off (0) according to
  1550.   whether the corresponding signal is to be waited for.  These symbols are
  1551.   defined in ckcdeb.h:
  1552.      BM_CTS (bit 0) means wait for Clear To Send
  1553.      BM_DSR (bit 1) means wait for Data Set Ready
  1554.      BM_DCD (bit 2) means wait for Carrier Detect
  1555.   Returns:
  1556.     -3 Not implemented.
  1557.     -2 This line does not have modem control.
  1558.     -1 Timeout: time limit exceeded before all signals were detected.
  1559.      1 Success.
  1560. int
  1561. ttxin(n,buf) int n; CHAR *buf;
  1562.   (note: CHAR is used throughout this program, and should be typedef'd to
  1563.   unsigned char if your C compiler supports it.  See ckcdeb.h.)
  1564.   Read x characters from the tty device into the specified buf, stripping
  1565.   parity if parity is not none.  This call waits forever, there is no timeout.
  1566.   This function is designed to be called only when you know that at least x
  1567.   characters are waiting to be read (as determined, for example, by ttchk()).
  1568.   This function should use the same buffer as ttinc().
  1569. int
  1570. txbufr(timo) int timo;
  1571.   Read characters into the interal communications input buffer.  timo is a
  1572.   timeout interval, in seconds.  0 means no timeout, wait forever.  Called by
  1573.   ttinc() (and possibly ttxin() and ttinl()) when the communications input
  1574.   buffer is empty.  The buffer should be called ttxbuf[], its length is
  1575.   defined by the symbol TXBUFL.  The global variable txbufn is the number of
  1576.   characters available to be read from ttxbuf[], and txbufp is the index of
  1577.   the next character to be read.  Should not be called if txbufn > 0, in which
  1578.   case the buffer does not need refilling.  This routine returns:
  1579.    -2    Communications disconnect
  1580.    -1    Timeout
  1581.    >= 0  A character (0 - 255), the first character that was read, with
  1582.          the variables txbufn and txbufp set appropriately for any remaining
  1583.          characters.
  1584.   NOTE: Currently this routine is used internally only by the UNIX and VMS
  1585.   versions.  The aim is to make it available to all versions so there is one
  1586.   single coherent and efficient way of reading from the communications device
  1587.   or network.
  1588. B.4 - Miscellaneous system-dependent functions.
  1589. VOID
  1590. ztime(s) char **s;
  1591.   Returns a pointer, s, to the current date-and-time string in s.  This string
  1592.   must be in the fixed-field format associated with the C runtime asctime()
  1593.   function, like: "Sun Sep 16 13:23:45 1973n" so that callers of this
  1594.   function can extract the different fields.  The pointer value is filled in
  1595.   by ztime, and the data it points to is not safe, so should be copied to a
  1596.   safe place before use.  ztime() has no return value.  As a side effect,
  1597.   this routine can also fill in the following two external variables (which
  1598.   must be defined in the system-dependendent modules for each platform):
  1599.     long ztusec:  Fraction of seconds of clock time, microseconds.
  1600.     long ztmsec:  Fraction of seconds of clock time, milliseconds.
  1601.   If these variables are not set by zstime(), they remain at their initial
  1602.   value of -1L.
  1603. int
  1604. gtimer()
  1605.   Returns the current value of the elapsed time counter in seconds (see
  1606.   rtimer), or 0 on any kind of error.
  1607. #ifdef GFTIMER
  1608. float
  1609. gtimer()
  1610.   Returns the current value of the elapsed time counter in seconds, as
  1611.   a floating point number, capable of representing not only whole seconds,
  1612.   but also the fractional part, to the millisecond or microsecond level,
  1613.   whatever precision is available.  Requires a function to get times at
  1614.   subsecond precision, as well as floating-point support.  That's why it's
  1615.   #ifdef'd.
  1616. #endif /* GFTIMER */
  1617. int
  1618. msleep(m) int m;
  1619.   Sleeps (pauses, does nothing) for m milliseconds (a millisecond is one
  1620.   thousandth of a second).  Returns:
  1621.   -1 on failure.
  1622.    0 on success.
  1623. VOID
  1624. rtimer()
  1625.   Sets the elapsed time counter to zero.  If you want to time how long an
  1626.   operation takes, call rtimer() when it starts and gtimer when it ends.
  1627.   rtimer() has no return value.
  1628. #ifdef GFTIMER
  1629. VOID
  1630. rftimer()
  1631.   Sets the elapsed time counter to zero.  If you want to time how long an
  1632.   operation takes, call rftimer() when it starts and gftimer when it ends.
  1633.   rftimer() has no return value.  Note: rftimer() is to be used with gftimer()
  1634.   and rtimer() is to be used with gtimer().  See rftimer() description.
  1635. #endif /* GFTIMER */
  1636. int
  1637. sysinit()
  1638.   Does whatever needs doing upon program start.  In particular, if the
  1639.   program is running in any kind of privileged mode, turns off the privileges
  1640.   (see priv_ini()).  Returns:
  1641.   -1 on error.
  1642.    0 on success.
  1643. int
  1644. syscleanup()
  1645.   Does whatever needs doing upon program exit.  Returns:
  1646.   -1 on error.
  1647.    0 on success.
  1648. int
  1649. psuspend()
  1650.   Suspends the Kermit process, puts it in the background so it can be
  1651.   continued ("foregrounded") later.  Returns:
  1652.   -1 if this function is not supported.
  1653.    0 on success.
  1654. GROUP 4 - Network Support.
  1655. As of version 5A, C-Kermit includes support for several networks.  Originally,
  1656. this was just worked into the ttopen(), ttclos(), ttinc(), ttinl(), and
  1657. similar routines in CKUTIO.C.  However, this made it impossible to share this
  1658. code with non-UNIX versions, like VMS.
  1659. As of edit 168, this support has been separated out into its own module and
  1660. header file, CKCNET.C and CKCNET.H.
  1661. As of edit 195, Telnet protocol is split out into its own files, since it
  1662. can be implemented in remote mode, which does not have a network connection:
  1663.   CKCNET.H - Network-related symbol definitions.
  1664.   CKCNET.C - Network i/o (TCP/IP, X.25, etc), shared by most platforms.
  1665.   CKLNET.C - Network i/o (TCP/IP, X.25, etc) specific to Stratus VOS.
  1666.   CKCTEL.H - Telnet protocol symbol definitions.
  1667.   CKCTEL.C - Telnet protocol.
  1668. The routines and variables in these modules fall into two categories: (1)
  1669. support for specific network packages like SunLink X.25 and TGV MultiNet, and
  1670. (2) support for specific network virtual terminal protocols like CCITT X.3 and
  1671. TCP/IP telnet.  Category (1) functions are analogs to the tt*() functions, and
  1672. have names like netopen, netclos, nettinc, etc.  Group I and II modules do not
  1673. (and must not) know anything about these functions -- they continue to call
  1674. the old Group III functions (ttopen, ttinc, etc).  Category (2) functions are
  1675. protocol specific and have names prefixed by a protocol identifier, like tn
  1676. for telnet x25 for X.25.
  1677. CKCNET.H contains prototypes for all these functions, as well as symbol
  1678. definitions for network types, protocols, and network- and protocol- specific
  1679. symbols, as well as #includes for the header files necessary for each network
  1680. and protocol.
  1681. The following functions are to be provided for networks that do not use normal
  1682. system i/o (open, read, write, close):
  1683. int
  1684. netopen()
  1685.   To be called from within ttopen() when a network connection is requested.
  1686.   Calling conventions and purpose same as Group III ttopen().
  1687. int
  1688. netclos()
  1689.   To be called from within ttclos() when a network connection is being closed.
  1690.   Calling conventions and purpose same as Group III ttclos().
  1691. int
  1692. nettchk()
  1693.   To be called from within ttchk().
  1694.   Calling conventions and purpose same as Group III ttchk().
  1695. int
  1696. netflui()
  1697.   To be called from within ttflui().
  1698.   Calling conventions and purpose same as Group III ttflui().
  1699. int
  1700. netbreak()
  1701.   To send a network break (attention) signal.
  1702.   Calling conventions and purpose same as Group III ttsndbrk().
  1703. int
  1704. netinc()
  1705.   To get a character from the network.
  1706.   Calling conventions same as Group III ttsndbrk().
  1707. int
  1708. nettoc()
  1709.   Send a "character" (byte) to the network.
  1710.   Calling conventions same as Group III ttoc().
  1711. int
  1712. nettol()
  1713.   Send a "line" (sequence of bytes) to the network.
  1714.   Calling conventions same as Group III ttol().
  1715. Conceivably, some systems support network connections simply by letting
  1716. you open a device of a certain name and letting you do i/o to it.  Others
  1717. (like the Berkeley sockets TCP/IP library on UNIX) require you to open the
  1718. connection in a special way, but then do normal i/o (read, write).  In such
  1719. a case, you would use netopen(), but you would not use nettinc, nettoc, etc.
  1720. TGV MultiNET on VAX/VMS has its own set of functions for all network
  1721. operations, so in that case the full range of netxxx() functions is used.
  1722. The technique is to put a test in each corresponding ttxxx() function to
  1723. see if a network connection is active (or is being requested), test for which
  1724. kind of network it is, and if necessary route the call to the corresponding
  1725. netxxx() function.  The netxxx() function must also contain code to test for
  1726. the network type, which is available via the global variable ttnet.
  1727. TELNET SUPPORT:
  1728. The telnet protocol is supported by the following variables and routines:
  1729. (global) int tn_init: nonzero if telnet protocol initialized, zero otherwise.
  1730. int
  1731. tn_init()
  1732.   Initialize the telnet protocol (send initial options).
  1733. int
  1734. tn_sopt()
  1735.   Send a telnet option.
  1736. int
  1737. tn_doop()
  1738.   Receive and act on a telnet option from the remote.
  1739. int
  1740. tn_sttyp()
  1741.   Send terminal type using telnet protocol.
  1742. X.25 SUPPORT:
  1743. These are presently specific to SunLink X.25, but it is hoped that they can
  1744. be integrated better with the functions above, and made more general so they
  1745. could be used, for instance, with VAX PSI.
  1746. x25diag()
  1747.   Read and print X.25 diagnostic
  1748. x25oobh()
  1749.   X.25 out of band signal handler
  1750. x25intr()
  1751.   Send X.25 interrupt packet
  1752. x25reset()
  1753.   Reset X.25 virtual circuit
  1754. x25clear()
  1755.   Clear X.25 virtual circuit
  1756. x25stat()
  1757.   X.25 status
  1758. setqbit()
  1759.   Set X.25 Q-bit
  1760. resetqbit()
  1761.   Reset X.25 Q-bit
  1762. x25xin()
  1763.   Read n characters from X.25 circuit.
  1764. x25inl()
  1765.   Read a Kermit packet from X.25 circuit.
  1766. ADDING SUPPORT FOR A NEW NETWORK TYPE
  1767. Example: Adding support for IBM X.25 and Hewlett Packard X.25.
  1768. First, add new network type symbols for each one.  There are already
  1769. some network types defined for other X.25 packages:
  1770.   NET_SX25 is the network-type ID for SunLink X.25.
  1771.   NET_VX25 is the network-type ID for VOS X.25.
  1772. So first you should new symbols for the new network types, giving them
  1773. the next numbers in the sequence, e.g.:
  1774. #define NET_HX25 11 /* Hewlett-Packard X.25 */
  1775. #define NET_IX25 12 /* IBM X.25 */
  1776. This is in ckcnet.h.
  1777. Then we need symbols to say that we are actually compiling in the code
  1778. for these platforms.  These would be defined on the cc command line:
  1779.   -DIBMX25  (for IBM)
  1780.   -DHPX25   (for HP)
  1781. So we can build C-Kermit versions for AIX and HP-UX both with and without
  1782. X.25 support (since not all AIX and IBM systems have the needed libraries,
  1783. and so an executable that was linked with them might no load).
  1784. Then in ckcnet.h:
  1785. #ifdef IBMX25
  1786. #define ANYX25
  1787. #endif /* IBMX25 */
  1788. #ifdef HPX25
  1789. #define ANYX25
  1790. #endif /* HPX25 */
  1791. And then use ANYX25 for code that is common to all of them,
  1792. and IBMX25 or HPX25 for code specific to IBM or HP.
  1793. It might also happen that some code can be shared between two or more of
  1794. these, but not the others.  Suppose, for example, that you write code that
  1795. applies to both IBM and HP, but not Sun or VOS X.25.  Then you add the
  1796. following definition to ckcnet.h:
  1797. #ifndef HPORIBMX25
  1798. #ifdef HPX25
  1799. #define HPORIBMX25
  1800. #else
  1801. #ifdef IBMX25
  1802. #define HPORIBMX25
  1803. #endif /* IBMX25 */
  1804. #endif /* HPX25 */
  1805. #endif /* HPORIBMX25 */
  1806. You can NOT use constructions like "#if defined (HPX25 || IBMX25)"; they
  1807. are not portable (see ckcplm.txt).
  1808. GROUP 5 - Formatted Screen Support
  1809. So far, this is used only for the fullscreen local-mode file transfer display.
  1810. In the future, it might be extended to other uses.  The fullscreen display
  1811. code is in and around the routine screenc() in ckuusx.c.
  1812. In the UNIX version, we use the curses library, plus one call from the termcap
  1813. library.  In other versions (OS/2, VMS, etc) we insert dummy routines that
  1814. have the same names as curses routines.  So far, there are two methods for
  1815. simulating curses routines:
  1816.  1. In VMS, we use the Screen Management Library (SMG), and insert stubs
  1817.     to convert curses calls into SMG calls.
  1818.  2. In OS/2, we use the MYCURSES code, in which the stub routines
  1819.     actually emit the appropriate escape sequences themselves.
  1820. Here are the stub routines:
  1821. tgetent(char *buf, char *term)
  1822.   Arguments are ignored.  Returns 1 if the user has a supported terminal
  1823.   type, 0 otherwise.  Sets a global variable (for example, "isvt52" or
  1824.   "isdasher") to indicate the terminal type.
  1825. move(int row, int col)
  1826.   Sends the escape sequence to position the cursor at the indicated row
  1827.   and column.  The numbers are 0-based, e.g. the home position is 0,0.
  1828. clear()
  1829.   Sends the escape sequence to clear the screen.
  1830. clrtoeol()
  1831.   Sends the escape sequence to clear from the current cursor position to
  1832.   the end of the line.
  1833. In the MYCURSES case, code must be added to each of the last three routines
  1834. to emit the appropriate escape sequences for a new terminal type.
  1835. clearok(curscr), wrefresh()
  1836.   In real curses, these two calls are required to refresh the screen, for
  1837.   example after it was fractured by a broadcast message.  These are useful
  1838.   only if the underlying screen management service keeps a copy of the entire
  1839.   screen, as curses and SMG do.  C-Kermit does not do this itself.
  1840. APPENDIX I - File Permissions
  1841. I.1. Format of System-Dependent File Permissions in A-Packets
  1842. The format of this field (the "," attribute) is interpreted according to the
  1843. System ID ("." Attribute).
  1844. For UNIX (System ID = U1), it's the familiar 3-digit octal number, the
  1845. low-order 9 bits of the filemode: Owner, Group, World, e.g. 660 = read/write
  1846. access for owner and group, none for world, recorded as a 3-digit octal string.
  1847. High-order UNIX permission bits are not transmitted.
  1848. For VMS (System ID = D7), it's a 4-digit hex string, representing the 16-bit
  1849. file protection WGOS fields (World,Group,Owner,System), in that order (which
  1850. is the reverse of how they're shown in a directory listing); in each field,
  1851. Bit 0 = Read, 1 = Write, 2 = Execute, 3 = Delete.  A bit value of 0 means
  1852. permission is granted, 1 means permission is denied.  Sample:
  1853.   r-01-00-^A/!FWERMIT.EXE'"
  1854.   s-01-00-^AE!Y/amd/watsun/w/fdc/new/wermit.exe.DV
  1855.   r-02-01-^A]"A."D7""B8#119980101 18:14:05!#8531&872960,$A20B-!7(#512@ #.Y
  1856.   s-02-01-^A%"Y.5!                                     ^^^^^^
  1857. A VMS directory listing shows the file's protection as (E,RWED,RED,RE) which
  1858. really means (S=E,O=RWED,G=RED,W=RE), which is reverse order from the internal
  1859. storage, so (RE,RED,RWED,E).  Now translate each letter to its corresponding
  1860. bit:
  1861.   RE=0101, RED=1101, RWED=1111, E=0010
  1862. Now reverse the bits:
  1863.   RE=1010, RED=0010, RWED=0000, E=1101
  1864. This gives the 16-bit quantity:
  1865.   1010001000001101
  1866. This is the internal representation of the VMS file permission; in hex:
  1867.   A20B
  1868. as shown in the sample packet above.
  1869. The VMS format probably would also apply to RSX or any other FILES-11 system.
  1870. I.2. Handling of Generic Protection
  1871. To be used when the two systems are different (and/or do not recognize or
  1872. understand each other's local protection codes).
  1873. First of all, the book is wrong.  This should not be the World protection,
  1874. but the Owner protection.  The other fields should be set according to system
  1875. defaults (e.g. UNIX umask, VMS default protection, etc), except that no
  1876. non-Owner field should give more permissions than the Owner field.
  1877. (End of CKCPLM.TXT)