home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / archives / ckc190.zip / ckccfg.doc < prev    next >
Text File  |  1994-10-28  |  38KB  |  732 lines

  1. C-KERMIT 5A CONFIGURATION INFORMATION                                -*-text-*-
  2.  
  3.   As of C-Kermit version:  5A(190)
  4.   This file last updated:  October 4, 1994
  5.  
  6.   F. da Cruz, Columbia University
  7.  
  8.   Copyright (C) 1985, 1994, Trustees of Columbia University in the City of New
  9.   York.  The C-Kermit software may not be, in whole or in part, licensed or
  10.   sold for profit as a software product itself, nor may it be included in or
  11.   distributed with commercial products or otherwise distributed by commercial
  12.   concerns to their clients or customers without written permission of the
  13.   Office of Kermit Development and Distribution, Columbia University.  This
  14.   copyright notice must not be removed, altered, or obscured.
  15.  
  16. DOCUMENTATION:
  17.  
  18. C-Kermit 5A is documented in the book "Using C-Kermit" by Frank da Cruz and
  19. Christine M. Gianone, Digital Press / Butterworth-Heinemann, Woburn, MA, USA
  20. (1993), ISBN 1-55558-108-0, Price: US $34.95.  To order call Kermit
  21. Distribution at Columbia University, +1 212 854-3703, and order with Master
  22. Card or Visa, or call Digital Press, +1 800 366-2665, and order with Master
  23. Card, Visa, or American Express.
  24.  
  25. DISCLAIMER:
  26.  
  27.   The C-Kermit software is provided in source code form by Kermit Development
  28.   and Distribution, Columbia University.  The software is provided "as is;" no
  29.   other warranty is provided, express or implied, including without
  30.   limitations, any implied warranty of merchantability or implied warranty of
  31.   fitness for a particular purpose.
  32.  
  33.   Neither Columbia University nor any of the contributors to the C-Kermit
  34.   development effort, including, but not limited to, AT&T, Digital Equipment
  35.   Corporation, Data General Corporation, or International Business Machines
  36.   Corporation, warrant C-Kermit software or documentation in any way.  In
  37.   addition, neither the authors of any Kermit programs, publications or
  38.   documentation, nor Columbia University nor any contributing institutions or
  39.   individuals acknowledge any liability resulting from program or
  40.   documentation errors.
  41.  
  42.  
  43. OVERVIEW
  44.  
  45. This file gives more-or-less system-independent configuration information for
  46. C-Kermit 5A.  The major topics covered include program size (and how to reduce
  47. it), how to include or exclude particular features, notes on modem and network
  48. support, and a list of C-Kermit's compile-time options.
  49.  
  50. For details about your particular operating system, consult the system-specific
  51. installation instructions file:
  52.  
  53.   CK?INS.DOC
  54.  
  55. (? = U for UNIX, V for VMS, etc, for example, CKUINS.DOC for UNIX, CKVINS.DOC
  56. for VAX/VMS, CKDINS.DOC for Data General AOS/VS, etc).  Also consult the
  57. following files:
  58.  
  59.   CKAAAA.HLP   Explanation of file naming conventions
  60.   CKCPLM.DOC   C-Kermit "program logic manual"
  61.   CK?KER.HLP   System-specific help file, if any
  62.   CK?KER.MAK   System-specific build procedure
  63.   CKCKER.BWR   "Beware file": C-Kermit bugs, limitations, workarounds
  64.   CK?KER.BWR   System-specific "beware file"
  65.   CKCKER.UPD   User-level documentation for new features
  66.   CKCnnn.UPD   Program edit history for edit nnn, e.g. CKC190.UPD.
  67.  
  68.  
  69. SERIAL COMMUNICATION SPEEDS
  70.  
  71. These are defined in two places: the SET SPEED keyword list in the command
  72. parser (as of this writing, in the ckuus3.c source file), and in the system-
  73. dependent communications i/o module, CK?TIO.C, functions ttsspd() (set speed)
  74. and ttgspd() (get speed).  The following speeds are assumed to be available
  75. in all versions:
  76.  
  77.   0, 110, 300, 600, 1200, 2400, 4800, 9600
  78.  
  79. If one or more of these speeds is not supported by your system, you'll need
  80. to change the source code (this has never happened so far).  Other speeds
  81. that are not common to all systems have Kermit-specific symbols:
  82.  
  83.                Symbol       Symbol
  84.   Speed (bps)  to enable    to disable
  85.        50       BPS_50       NOB_50
  86.        75       BPS_75       NOB_75  
  87.        75/1200  BPS_7512     NOB_7512
  88.       134.5     BPS_134      NOB_134
  89.       150       BPS_150      NOB_150
  90.       200       BPS_200      NOB_200
  91.      1800       BPS_1800     NOB_1800
  92.      3600       BPS_3600     NOB_3600
  93.      7200       BPS_7200     NOB_7200
  94.     14400       BPS_14K      NOB_14K
  95.     19200       BPS_19K      NOB_19K
  96.     28800       BPS_28K      NOB_28K
  97.     38400       BPS_38K      NOB_38K
  98.     57600       BPS_57K      NOB_57K
  99.     76800       BPS_76K      NOB_76K
  100.    115200       BPS_115K     NOB_155K
  101.    230400       BPS_230K     NOB_230K
  102.  
  103. The ckcdeb.h header file contains default speed configurations for the many
  104. systems that C-Kermit supports.  You can override these defaults by (a)
  105. editing ckcdeb.h, or (b) defining the appropriate enabling and/or disabling
  106. symbols on the CC command line, for example:
  107.  
  108.   -DBPS_14400 -DNOB_115200
  109.  
  110. or the "make" command line, e.g.:
  111.  
  112.   make blah "KFLAGS=-DBPS_14400 -DNOB_115200"
  113.  
  114. Note: some speeds have no symbols defined for them, because they have never
  115. been needed: 12.5bps, 45.5bps, 20000bps, etc.  These can easily be added if
  116. required.
  117.  
  118. FULLSCREEN DISPLAY
  119.  
  120. New to edit 180 is support for an MS-DOS-Kermit-like local-mode full screen
  121. file transfer display, accomplished using the curses library, or something
  122. equivalent (for example, the Screen Manager on DEC VMS).  To enable this
  123. feature, include the following in your CFLAGS:
  124.  
  125.   -DCK_CURSES
  126.  
  127. and then change your build procedure (if necessary) to include the necessary
  128. libraries, usually "curses", perhaps also "termcap" or "termlib".  See
  129. OS-dependent installation instructions and/or build procedure for details.  
  130.  
  131. New to edit 190 is the ability to refresh a messed-up full-screen display,
  132. e.g. after receiving a broadcast message.  This depends on the curses package
  133. including the wrefresh() and clearok() functions and the curscr variable.  If
  134. your version has these, or has code to simulate them, then add:
  135.  
  136.   -DCK_WREFRESH
  137.  
  138. The curses and termcap libraries add considerable size to the program image
  139. (e.g. about 20K on a SUN-4, 40K on a 386).  On some small systems, such as the
  140. AT&T 6300 PLUS, curses support can push Kermit over the edge... even though it
  141. compiles, loads, and runs correctly, its increased size apparently makes it
  142. swap constantly, slowing it down to a crawl, even when the curses display is
  143. not in use.  Some new makefile entries have been added to take care of this
  144. (e.g. sys3upcshcc), but similar tricks might be necessary in other cases too.
  145.  
  146. Also new to edit 190 is an ASCII-graphic percent-done "thermometer".  This is
  147. not included unless you add:
  148.  
  149.   -DCK_PCT_BAR
  150.  
  151. to your CFLAGS.
  152.  
  153. Just below the bar is a running display of the transfer rate, as a flat
  154. quotient of file characters per elapsed seconds so far.  You can change this
  155. to an average that gives greater weight to recent history (0.25 *
  156. instantaneous cps + 0.75 * historical cps) by adding -DCPS_WEIGHTED to
  157. your CFLAGS (sorry folks, this one is not worth a SET command).  You can
  158. choose a second type of weighted average in which the weighting smooths
  159. out progressively as the transfer progresses by adding -DCPS_VINCE to
  160. -DCPS_WEIGHTED.
  161.  
  162. An alternative to curses is also available at compile time, but should be
  163. selected if your version of Kermit is to be run in local mode only in an ANSI
  164. terminal environment, for example on a desktop workstation that has an ANSI
  165. console driver.  To select this option in place of curses, define the symbol
  166. MYCURSES:
  167.  
  168.   -DMYCURSES
  169.  
  170. instead of CK_CURSES.  The MYCURSES option uses built-in ANSI (VT100) escape
  171. sequences, and depends upon your terminal or console driver to interpret them
  172. correctly.
  173.  
  174. To use the fullscreen display feature, SET FILE DISPLAY FULLSCREEN.  Beware, it
  175. can slow the transfer down a bit (or a lot).  The faster the connection speed,
  176. the more likely the fullscreen display will become the bottleneck.  To test
  177. whether the fullscreen display is slowing your transfers down on a particular
  178. connection, transfer the same with it and without it, and compare the figures
  179. given in the STATISTICS command.  The default file transfer display is still
  180. the old SERIAL ("dots") display, even if you build in curses support.
  181.  
  182. A compromise between the two styles (new to edit 183), that can be used on any
  183. video display terminal, can be elected at runtime with the SET FILE DISPLAY
  184. CRT.  It relies only on the ability of the terminal to write over the current
  185. line when it receives a bare carriage return.  The same performance comments
  186. apply to this display option.
  187.  
  188.  
  189. CHARACTER-SET SUPPORT
  190.  
  191. By default, C-Kermit is built with support for translation of character sets
  192. for Western European languages (i.e. languages that originated in Western
  193. Europe, but are now also spoken in the Western Hemisphere and other parts of
  194. the world), via ISO 8859-1 Latin Alphabet 1, for Eastern European languages
  195. (ISO Latin-2), Hebrew (and Yiddish), and Cyrillic-alphabet languages (ISO
  196. Latin/Cyrillic).  Many file (local) character sets are supported: ISO 646
  197. 7-bit national sets, IBM code pages, Apple, DEC, DG, NeXT, etc.
  198.  
  199. Japanese language support is available by defining the following symbol in
  200. your CFLAGS (for example in UNIX, you can "make xxx KFLAGS=-KANJI"):
  201.  
  202. -DKANJI
  203.    Japanese.
  204.    Transfer character-set: Japanese EUC (= JIS X 0201 + JIS X 0208)
  205.    File character-sets: EUC, JIS-7, DEC Kanji, Shift JIS
  206.  
  207. To build Kermit with no character-set translation at all, include -DNOCSETS in
  208. the CFLAGS.  To build with no Latin-2, add -DNOLATIN2.  To build with no
  209. Cyrillic, add -DNOCYRIL.  To omit Hebrew, add -DNOHEBREW.  If -DNOCSETS is
  210. *not* included, you'll always get LATIN1.  There is presently no way to
  211. include Latin-2, Cyrillic, Hebrew, or Kanji without also including Latin-1.
  212.  
  213. If Kanji support happens to be included in your version by default (as it is
  214. for OS/2), but you don't want it, include add -DNOKANJI to your CFLAGS.
  215.  
  216.  
  217. APC EXECUTION
  218.  
  219. The Kermit CONNECT module can be coded to execute Application Program Command
  220. escape sequences from the host.  These are of the form:
  221.  
  222.   ESC _ text ESC \
  223.  
  224. where "text" is a C-Kermit command, or a list of C-Kermit commands separated
  225. by commas, up to about 1K in length.
  226.  
  227. To date, this feature has been coded into the OS/2 and UNIX versions, for
  228. which the symbol:
  229.  
  230.   CK_APC
  231.  
  232. is defined automatically in ckuusr.h.  For OS/2, APC is enabled at runtime
  233. by default, for UNIX it is disabled.  It is controlled by the SET TERMINAL
  234. APC command.  Configuring APC capability into a version that gets it by
  235. default (because CK_APC is defined in ckuusr.h) can be overridden by including:
  236.  
  237.   -DNOAPC
  238.  
  239. on the CC command line.
  240.  
  241. PROGRAM SIZE
  242.  
  243. C-Kermit 5A is a large program, much larger than previous releases because of
  244. all the new features, primarily the script programming language, sliding
  245. window packet protocol, and international character set translation.  On some
  246. systems, the size of the program prevents it from being successfully linked
  247. and loaded.  On some others, it occupies so much memory that it is constantly
  248. swapping or paging.  In such cases, you can reduce C-Kermit's size in various
  249. ways, outlined in this section.  The following options can cut down on the
  250. program's size at compile time by removing features or changing the size of
  251. storage areas.
  252.  
  253. These are symbols that are defined on the CC (C compiler) command line. "-D"
  254. is the normal CC directive to define a symbol so, for example, "-DNODEBUG"
  255. defines the symbol NODEBUG.  Some C compilers might use different syntax, e.g.
  256. "-d NODEBUG" or "/DEFINE=NODEBUG".  For C compilers that do not take
  257. command-line arguments, you can put the corresponding #define statements in
  258. the file CKCSYM.H, for example:
  259.  
  260. #define NODEBUG
  261.  
  262. (The #define statement must be on the left margin.)  Here are C-Kermit's
  263. size-related compile-time options.  The ones that take up the most space are
  264. marked by asterisk (*).  If you are desperate to save space, remove debugging
  265. first, rather than some more useful feature.  Remove built-in help only if
  266. absolutely necessary.  The final resort is to remove the interactive command
  267. parser completely, leaving only a UNIX-style command-line interface
  268. ("kermit -s foo").  This cuts the program down to about 25% of its fully
  269. configured size.
  270.  
  271. * -DNODEBUG:  Add this option to omit all debugging code.
  272.   -DNOTLOG:   Add this option to omit transaction logging.
  273. * -DNOHELP:   Add this option to omit built-in help.
  274.   -DTCPSOCKET:Remove this option to omit TCP/IP support.
  275.   -DSUNX25:   Remove this option to omit SunLink X.25 support.
  276.   -DNOMSEND:  Add this option to remove the MSEND command.
  277. * -DNOLOCAL:  Add this option to remove all local-mode support.
  278. * -DNODIAL:   Add this option to remove the DIAL command and modem support.
  279. * -DMINIDIAL: Add this option to support only CCITT, Hayes, and Unknown modems.
  280.   -DNOXMIT:   Add this option to remove the TRANSMIT command.
  281.   -DNOSCRIPT: Add this option to remove the UUCP-style SCRIPT command.
  282.   -DNOCMDL:   Add this option to remove the command-line option interface.
  283. * -DNOSPL:    Add this option to remove the script programming language.
  284. * -DNOICP:    Add this option to remove the entire interactive command parser.
  285.   -DDCMDBUF:  Add this option to allocate command buffers dynamically.
  286. * -DNOCSETS:  Add this option to remove international character set support.
  287.   -DNOLATIN2  Add this option to remove ISO Latin-2 character-set translation.
  288.   -DNOCYRIL:  Add this option to remove Cyrillic character set translation.
  289.   -DNOLATIN2: Add this option to remove Latin-2 character set translation.
  290.   -DNOHEBREW: Add this option to remove Hebrew character set translation.
  291.   -DKANJI:    Omit this option to exclude Kanji character set translation.
  292.   -DNOESCSEQ: Add this option to omit ANSI escape sequence recognition.
  293.   -DNOSERVER: Add this option to remove server mode.
  294.   -DNOSETKEY: Add this option to remove the SET KEY command.
  295.   -DNOPUSH:   Add this option to remove escapes to operating system.
  296.   -DNOFRILLS: Add this option to remove "frills".
  297. * -DCK_CURSES: Omit this option to keep the curses library out of Kermit.
  298.  
  299.   -DSBSIZ=nnnn -DRBSIZ=nnnnn
  300.      Change the overall size of the packet send and receive buffers.
  301.  
  302. -DNOFRILLS removes various command synonyms; the following top-level commands:
  303. CLEAR, DELETE, DISABLE, ENABLE, the multiline version of GET, GETOK, MAIL,
  304. RENAME, TYPE, WHO; and the following REMOTE commands: KERMIT, LOGIN, LOGOUT,
  305. PRINT, TYPE, WHO.
  306.  
  307. There are options to control Kermit's packet buffer allocations.  The
  308. following symbols are defined in ckcker.h in such a way that you can override
  309. them by redefining them in CFLAGS:
  310.  
  311.   -DMAXSP=xxxx - Maximum send-packet length, default 2048.
  312.   -DMAXRP=xxxx - Maximum receive-packet length, 2048 for UNIX, 1920 for VMS.
  313.   -DSBSIZ=xxxx - Total allocation for send-packet buffers, default 3008.
  314.   -DRBSIZ=xxxx - Total allocation for receive-packet buffers, default 3008.
  315.  
  316. The program size is affected by SBSIZ and RBSIZ (send and receive packet
  317. buffer size).  These are static character arrays compiled into the program.
  318. If you wish, you can have Kermit allocate packet buffers dynamically at
  319. runtime using malloc() by including the CFLAGS switch:
  320.  
  321.   -DDYNAMIC
  322.  
  323. In this case, the default packet and buffers sizes are changed to:
  324.  
  325.   -DMAXSP=9024 (for UNIX, 2048 for VMS)
  326.   -DMAXRP=9024 (for UNIX, 1920 for VMS)
  327.   -DSBSIZ=9050
  328.   -DRBSIZ=9050
  329.  
  330. but you can change the packet buffer sizes (not the maximum packet size) at
  331. runtime using the command:
  332.  
  333.   SET BUFFERS <sbsiz> <rbsiz>
  334.  
  335. Using dynamic allocation (-DDYNAMIC) reduces storage requirements for the
  336. executable program on disk, and allows more and bigger packets at runtime.
  337. But dynamic allocation might not work on all systems.  Try it.  If it works
  338. for you, there is no reason not to use it.  But if the program hangs or core
  339. dumps, then omit the -DDYNAMIC option from CFLAGS.
  340.  
  341. The CK_CURSES option, at least on UNIX, requires C-Kermit be linked with
  342. a large external library.  On certain small systems, C-Kermit programs built
  343. this way have been observed to cause swapping and/or performance problems.
  344.  
  345. OTHER SIZE-RELATED ITEMS
  346.  
  347. To make Kermit compile and load successfully, you might have to change your
  348. build procedure to:
  349.  
  350.    a. Request a larger ("large" or "huge") model.  This is particularly true
  351.       for 16-bit PC-based UNIX versions.  This is typically done with a -M
  352.       and/or -F switch (see your cc manual or man page for details).
  353.  
  354.    b. Some systems support overlays.  If the program is too big to be built
  355.       as is, check your loader manual ("man ld") to see if an overlay feature
  356.       is available.  See the 2.10/2.11 BSD example in the UNIX makefile. 
  357.  
  358.    c. Similarly, some systems support "code mapping", which is similar to
  359.       overlays.  Again, see "man ld".
  360.  
  361. It is also possible to reduce the size of the executable program file in
  362. several other ways:
  363.  
  364.    a. Include the -O (optimize) compiler switch if it isn't already included
  365.       in your "make" entry (and if it works!).  If your compiler supports
  366.       higher levels of optimization (e.g. -O2), try it.
  367.  
  368.    b. If your UNIX system supports shared libraries, change the make entry to
  369.       take advantage of this feature.  The way to do this depends on your
  370.       particular system.  Some (like SUNOS) do it automatically.  See the NeXT
  371.       entry for an example.
  372.  
  373.    c. Strip the program image after building ("man strip" for further info),
  374.       or add -s to the LNKFLAGS (UNIX only).  This strips the program of its
  375.       symbol table and relocation information.
  376.  
  377.    d. Move character strings into a separate file.  See the 2.10 BSD entry
  378.       for an example.
  379.  
  380. SPACE/TIME TRADEOFFS
  381.  
  382. There are over 1000 debug() statements in the program.  If you want to save
  383. both space (program size) and time (program execution time), include -DNODEBUG
  384. in the compilation.  If you want to include debugging for tracking down
  385. problems, omit -DNODEBUG from the make entry.  But when you include debugging,
  386. you have two choices for how it's done.  One definition defines debug() to be
  387. a function call; this is cheap in space but expensive in execution.  The other
  388. defines debug as "if (deblog)" and then the function call, to omit the
  389. function call overhead when the debug log is not active.  But this adds a lot
  390. of space to the program.  Both methods work, take your choice.  The first
  391. method is the default.  To select the second method, include -DIFDEBUG in the
  392. compilation (and don't include -DNODEBUG).
  393.  
  394. DIALER SUPPORT
  395.  
  396. -DNODIAL removes automatic modem dialing completely, including the entire
  397. ckudia.c module, plus all commands that refer to dialing in the various
  398. ckuus*.c modules.
  399.  
  400. -DMINIDIAL leaves the DIAL and related commands (SET/SHOW MODEM, SET/SHOW DIAL)
  401. intact, but removes support for all types of modems except CCITT, Hayes,
  402. Unknown, and None (= Direct).  The MINIDIAL option cuts the size of the dial
  403. module approximately in half.  Use this option if you have only Hayes or
  404. CCITT modems and don't want to carry the baggage for the other types.
  405.  
  406. Note that MINIDIAL is quite sufficient to control any type of modem that uses
  407. the Hayes command and response set, even modern high-speed, error-correcting,
  408. data-compressing ones, if you use a macro such as the ones listed in the
  409. CKCKER.BWR file (such as PPDIAL) to set up the modem's initialization string,
  410. etc.  In fact, it might ultimately make good sense to replace the bulk of the
  411. DIAL module with a set of macros for each brand of modem, as in MS-DOS Kermit.
  412.  
  413.  
  414. NETWORK SUPPORT
  415.  
  416. C-Kermit supports not only RS-232 serial connections, direct and modem, but
  417. also TCP/IP and X.25 network connections.  The OS/2 version supports DECnet
  418. (LAT) connections.
  419.  
  420. TCP/IP support requires the Berkeley sockets library, and is generally
  421. available on any BSD-based UNIX system.  It is also available on non-BSD-based
  422. UNIX systems that have a sockets library, including HP-UX and Xenix versions
  423. with Excelan TCP/IP, and many others, and also in OS/2, VMS, AOS/VS, VOS, etc.
  424. The TCP/IP support includes built-in TELNET negotiation handling.  To select
  425. TCP/IP support, include -DTCPSOCKET in your makefile entry's CFLAGS, or the
  426. appropriate variant (e.g. -DWOLLONGONG, -DMULTINET, -DEXCELAN, -DWINTCP, etc).
  427. The network support for TCP/IP and X.25 is in the source files CKCNET.H and
  428. CKCNET.C, with miscellaneous SHOW commands, etc, in the various CKUUS*.C
  429. modules, plus code in the CK*CON.C (CONNECT command) and several other modules
  430. to detect TELNET negotiations, etc.
  431.  
  432. Within the TCPSOCKET code, there are two optional features that are normally
  433. disabled, but which you can enable at compile time:
  434.  
  435. CK_LINGER
  436.   If defined, this will add code to turn of the socket linger parameter (if it
  437.   is not off already), which has been observed on some systems to cause Kermit
  438.   to hang when trying to close a connection to a misbehaving server, or in
  439.   some cases, to a TELNET modem server whose modems are in use.
  440.  
  441. CK_SOCKBUF
  442.   This enables code that attempts to increase the socket buffer size to 32K,
  443.   which results in better performance on some systems.
  444.  
  445. If you get a compilation error in CKCNET.C, with a complaint like "incompatible
  446. types in assignment", it probably has something to do with the data type your
  447. system uses for the inet_addr() function, which is declared (usually) in
  448. <arpa/inet.h>.  Kermit uses "unsigned long" unless the symbol INADDRX is
  449. defined, in which case "struct inaddr" is used instead.  Try adding -DINADDRX
  450. to CFLAGS in your make entry.
  451.  
  452. TELNET Negotiation About Window Size (NAWS) support requires the ability to
  453. find out the terminal screen's dimensions.  E.g. in UNIX, we need something
  454. like ioctl(0, TIOCGWINSZ, ...).  If your version of Kermit was built with NAWS
  455. capability, SHOW VERSIONS will include CK_NAWS among the compiler options.  If
  456. it doesn't, you can add it by defining CK_NAWS at compile time.  Then, if the
  457. compiler or linker complain about undefined or missing symbols, or there is no
  458. complaint but SHOW TERMINAL fails to show reasonable "Rows =, Columns ="
  459. values, then take a look at (or write) the appropriate ttgwsiz() routine.  On
  460. the other hand, if CK_NAWS is defined by default for your system (in ckcnet.h),
  461. but causes trouble, you can override this definition by including the -DNONAWS
  462. switch on your CC command line, thus disabling the NAWS feature.
  463.  
  464. This appears to be needed at least on the AT&T 3B2, where in ckutio.c,
  465. the routine ttgwsiz() finds that the TIOCGWINSZ symbol is defined but lacks
  466. definitions for the corresponding winsize struct and its members ws_col
  467. and ws_row.
  468.  
  469. The UNIX version of C-Kermit also traps SIGWINCH, so it can send a NAWS any
  470. time the console terminal window size changes, e.g. when you stretch it with a
  471. mouse.  The SIGWINCH-trapping code is enabled if SIGWINCH is defined (i.e. in
  472. signal.h).  If this code should cause problems, you can disable it without
  473. disabling the NAWS feature altogether, by defining NOSIGWINCH at compile time.
  474.  
  475. X.25 support requires (a) a SUN, (b) the SunLink product (libraries and header
  476. files), and (c) an X.25 connection into your SUN.  Special makefile entries
  477. sunos4x25 and sunos41x25 (for SUNOS 4.0 and 4.1, respectively) are provided to
  478. build in this feature, but they only work if conditions (a)-(c) are met.  To
  479. request this feature, include -DSUNX25 in CFLAGS.
  480.  
  481.  
  482. SECURITY FEATURES
  483.  
  484. Compiling with the NOPUSH symbol defined removes all the "shell escape"
  485. features from the program, including the PUSH, RUN, and SPAWN commands, the "!"
  486. and "@" command prefixes, OPEN !READ, OPEN !WRITE, job control (including the
  487. SUSPEND command), shell/DCL escape from CONNECT mode, as well as the server's
  488. execution of REMOTE HOST commands (and, of course, the ENABLE HOST command).
  489. Add NODISPO to also prevent acceptance of incoming MAIL or REMOTE PRINT files.
  490. For UNIX, also be sure to read CKUINS.DOC about set[ug]id installation.
  491. Additional restrictions can be enforced when in server mode; read about the
  492. DISABLE command.
  493.  
  494.  
  495. APPENDIX I: SUMMARY OF COMPILE-TIME OPTIONS
  496.  
  497. These are the symbols that can be specified on the cc command line, listed
  498. alphabetically.  Others are used internally, including those taken from header
  499. files, those defined by the compiler itself, and those inferred from the ones
  500. given below.  Kermit's SHOW VERSIONS command attempts to display most of
  501. these.  See ckcdeb.h and ckcnet.h for inference rules.  For example SVR3
  502. implies ATTSV, MULTINET implies TCPSOCKET, and so on.
  503.  
  504. The following options are not included in all makefile entries, but they are
  505. beneficial if they work.  It is recommended that you add them to your makefile
  506. entry if they are lacking and test the result.  If it's OK, let me know and
  507. I'll add them to the official makefile:
  508.  
  509. DYNAMIC        Dynamic packet buffer allocation, bigger packets allowed, etc.
  510. NOSETBUF       Don't do unbuffered single-character writes to the console.
  511.                This tends to speed up CONNECT mode.
  512.  
  513. Here is the complete list of the Kermit-specific compile-time switches:
  514.  
  515. ACUCNTRL       Select BSD 4.3-style acucntrl() bidirectional tty control.
  516. aegis          Build for Apollo Aegis (predefined on Apollo systems).
  517. AIX370         Build for IBM AIX/370 for IBM mainframes.
  518. AIXESA         Build for IBM AIX/ESA for IBM mainframes.
  519. AIXPS2         Build for IBM AIX 3.0 for PS/2 series (never formally released).
  520. AIXRS          Build for IBM AIX 3.x on RS/6000.
  521. AIX41          Build for IBM AIX 4.x on RS/6000.
  522. AMIGA          Build for Commodore Amiga with Intuition OS.
  523. ATT6300        Build for AT&T 6300 PLUS.
  524. ATT7300        Build for AT&T 7300 UNIX PC (3B1).
  525. ATTSV          Build for AT&T System III or V UNIX.
  526. AUX            Build for Apple A/UX for the Macintosh.
  527. BPS_xxxx       Enable SET SPEED xxxx
  528. BSD29          Build for BSD 2.9 or 2.10.
  529. BSD4           Build for BSD 4.2.
  530. BSD41          Build for BSD 4.1.
  531. BSD43          Build for BSD 4.3.
  532. BSD44          Build for BSD 4.4.
  533. C70            Build for BBN C/70.
  534. CIE            Build for CIE Systems 680/20.
  535. CK_ANSIC       Enable ANSI C constructs - prototypes, etc.
  536. CK_ANSILIBS    Use header files for ANSI C libraries.
  537. CK_APC         Enable APC execution by CONNECT module.
  538. CK_CURSES      Enable fullscreen file transfer display.
  539. CK_DSYSINI     Use system-wide init file, with name supplied by Kermit.
  540. CK_DTRCD       DTR/CD flow control is available.
  541. CK_FORK_SIG    UNIX only: signal() number for CONNECT module forks.
  542. CK_IFRO        IF REMOTE command is available (and can run in remote mode).
  543. CK_INI_A       System-wide init file takes precedence over user's.
  544. CK_INI_B       User's init file takes precedence over the system-wide one.
  545. CK_LABELED     Include support for SET FILE TYPE LABELED.
  546. CK_LBRK        This version can send Long BREAK.
  547. CK_LINGER      Add code to turn of TCP socket "linger" parameter.
  548. CK_MKDIR       This version has a zmkdir() command to create directories.
  549. CK_NAWS        Include TELNET Negotiate About Window Size support.
  550. CK_NEWTERM     Use newterm() rather than initscr() to initialize curses.
  551. CK_PCT_BAR     Fullscreen file transfer display should include "thermometer".
  552. CK_POLL        System-V or POSIX based UNIX has poll() function.
  553. CK_POSIX_SIG   Use POSIX signal handing: sigjmp_buf, sigsetjmp, siglongjmp.
  554. CK_READ0       read(fd,&x,0) can be used to test TCP/IP connections.
  555. CK_REDIR       Enable the REDIRECT command.
  556. CK_RESEND      Include the RESEND command (needs zfseek() + append).
  557. CK_RTSCTS      RTS/CTS flow control is available.
  558. CK_SOCKBUF     Enable TCP socket-buffer-size-increasing code.
  559. CK_SPEED       Enable control-character unprefixing.
  560. CK_SYSINI="xxxxx"  Quoted string to be used as system-wide init file name.
  561. CK_TMPDIR      This version of Kermit has an isdir() function.
  562. CK_XONXOFF     Xon/Xoff flow control available.
  563. CK_WREFRESH    Curses package includes wrefresh(),clearok() for screen refresh.
  564. CKTYP_H=xxx    Force include of xxx as <types.h> file.
  565. CLSOPN         When hanging up a tty device, also close and reopen it.
  566. CMDDEP         Maximum recursion depth for self-referential user-defined fn's.
  567. COHERENT       Build for Mark Williams Coherent UNIX
  568. datageneral    Build for Data General AOS/VS or AOS/VS II
  569. DCLPOPEN       popen() is available but needs to be declared
  570. DEC_TCPIP      Build with support for DEC TCP/IP (UCX) for (Open)VMS
  571. DGUX430        Build for DG/UX 4.30
  572. DGUX540        Build for DG/UX 5.40
  573. DEFPAR=x       Default parity, 0, 'e', 'o', 'm', or 's'.
  574. DFTTY=xxx      Default communications device name.
  575. DIRENT         UNIX directory structure to be taken from <dirent.h>
  576. DIRPWDRP       Prompt for password in REMOTE CWD command.
  577. DYNAMIC        Allocate file transfer packet buffers dynamically with malloc.
  578. ENCORE         Build for Encore Multimax computers.
  579. EXCELAN        Build with excelan TCP/IP.
  580. FT18           Build for Fortune For:Pro 1.8.
  581. FT21           Build for Fortune For:Pro 2.1.
  582. GEMDOS         Build for Atari ST GEMDOS.
  583. GID_T=xxx      Group IDs are of type xxx (usually int, short, or gid_t).
  584. HDBUUCP        Build with support for Honey DanBer UUCP.
  585. HPUX           Build for Hewlett Packard HP-UX.
  586. HPUX9          Build for Hewlett Packard HP-UX 9.x.
  587. HPUX10         Build for Hewlett Packard HP-UX 10.x.
  588. I386IX         Build for Interactive System V R3.
  589. IFDEBUG        Add IF stmts "if (deblog)" before "debug()" calls.
  590. INADDRX        TCP/IP inet_addr() type is struct inaddr, not unsigned long.
  591. INTERLAN       Build with support for Racal/Interlan TCP/IP.
  592. ISDIRBUG       System defs of S_ISDIR and S_ISREG have bug, define ourselves.
  593. ISIII          Build for Interactive System III.
  594. IX370          Build for IBM IX/370.
  595. KANJI          Build with Kanji character-set translation support.
  596. LCKDIR         UUCP lock directory is /usr/spool/uucp/LCK/.
  597. LFDEVNO        UUCP lockfile name uses device numbers, as in SVR4.
  598. LINUXFSSTND    For Linux, use FSSTND UUCP lockfile conventions.
  599. LOCK_DIR=xxx   UUCP lock directory is xxx.
  600. LOCKF          Use lockf() (in addition to lockfiles) on serial lines
  601. LONGFN         BSD long filenames supported using <dir.h> and opendir().
  602. LYNXOS         Build for Lynx OS 2.2 or later (POSIX-based).
  603. MAC            Build for Apple Macintosh with Mac OS.
  604. MATCHDOT       Make wildcards to match filenames starting with period (.)
  605. MAXRP=xxx      Maximum receive-packet length.
  606. MAXSP=xxx      Maximum send-packet length.
  607. MDEBUG         Malloc-debugging requested.
  608. MINIDIAL       Minimum modem dialer support: CCITT, Hayes, Unkown, and None.
  609. MINIX          Build for MINIX.
  610. MIPS           Build for MIPS workstation.
  611. MULTINET       Build with support for TGV MultiNet TCP/IP (VAX/VMS).
  612. NAP            The nap() is available (conflicts with SELECT and USLEEP)
  613. NAPHACK        The nap() call is availabe but only as syscall(3112,...)
  614. NDIR           BSD long filenames supported using <ndir.h> and opendir().
  615. NDGPWNAM       Don't declare getpwnam().
  616. NDSYSERRLIST   Don't declare sys_errlist[].
  617. NEXT           Build for NeXT Mach 1.x or 2.x or 3.x.
  618. NOANSI         Disable ANSI C function prototyping.
  619. NOAPC          Do not include CK_APC code.
  620. NOB_xxxx       Disable SET SPEED xxxx
  621. NOBRKC         Don't try to refer to t_brkc or t_eof tchars structure members.
  622. NOCCTRAP       Disable Control-C (SIGINT) trapping.
  623. NOCKSPEED      Disable control-prefix removal feature (SET CONTROL).
  624. NOCMDL         Build with no command-line option processing.
  625. NOCOTFMC       No close(open()) to force mode change (UNIX version).
  626. NOCSETS        Build with no support for character set translation.
  627. NOCYRIL        Build with no support for Cyrillic character set translation.
  628. NODEBUG        Build with no debug logging capability.
  629. NODIAL         Build with no DIAL or SET DIAL commands.
  630. NODISPO        Build to always refuse incoming MAIL or REMOTE PRINT files.
  631. NOESCSEQ       Build with no support for ANSI escape sequence recognition.
  632. NOFDZERO       Do not use file descriptor 0 for remote-mode file transfer.
  633. NOFILEH        Do not #include <sys/file.h>.
  634. NOFRILLS       Build with "no frills".
  635. NOHEBREW       Build with no support for Hebrew character sets.
  636. NOHELP         Build with no built-in help.
  637. NOHISPEED      Build without serial high speeds (Linux).
  638. NOICP          Build with no interactive command parser.
  639. NOJC           Build with no support for job control (suspend).
  640. NOKANJI        Build with no support for Japanese Kanji character sets.
  641. NOKVERBS       Build with no support for keyboard verbs (\Kverbs).
  642. NOLOCAL        Build without any local-mode features.
  643. NOLATIN2       Build with no ISO Latin-2 character-set translation support.
  644. NOMDMHUP       Build without "modem-specific hangup" (e.g. ATH0) feature.
  645. NOMINPUT       Build without MINPUT command.
  646. NOMSEND        Build with no MSEND command.
  647. NONAWS         Do not include TELNET Negotiate About Window Size support.
  648. NOPARSEN       Build without automatic parity detection.
  649. NOPOLL         Override CK_POLL definition.
  650. NOPOPEN        The popen() system call is not available.
  651. NOPUSH         Build with no escapes to operating system.
  652. NORECALL       Disable the command-recall feature.
  653. NOREDIRECT     Disable REDIRECT command.
  654. NORENAME       Don't use rename() system call, use link()/unlink() (UNIX).
  655. NORESEND       Build with no RESEND command.
  656. NORETRY        Build with no command-retry feature.
  657. NOSCRIPT       Build with no SCRIPT command.
  658. NOSELECT       Don't try to use select().
  659. NOSERVER       Build with no SERVER mode and no server-related commands.
  660. NOSETBUF       Don't make console writes unbuffered.
  661. NOSETREU       setreuid() and/or setregid() not available.
  662. NOSHOW         Build with no SHOW command (not recommended!).
  663. NOSIGWINCH     Disable SIGWINCH signal trapping.
  664. NOSPL          Build with no script programming language. 
  665. NOSYSIOCTLH    Do not #include <sys/ioctl.h>.
  666. NOTLOG         Build with no support for transaction logging.
  667. NOUUCP         Build with no UUCP lockfile support (dangerous!).
  668. NOWREFRESH     Override built-in definition of CK_WREFRESH (q.v.).
  669. NOXMIT         Build with no TRANSMIT command.
  670. OLDMSG         Use old "entering server mode" message (see ckcmai.c).
  671. OS2            Build for OS/2.
  672. OSF            Build for OSF/1.
  673. OSFPC          Build for OSF/1 on a PC.
  674. OSK            Build for OS-9.
  675. OXOS           Build for Olivetti X/OS 2.3.
  676. PCIX           Build for PC/IX
  677. PID_T=xxx      Type for pids is xxx (normally int or pid_t).
  678. POSIX          Build for POSIX: use POSIX header files, functions, etc.
  679. _POSIX_SOURCE  Disable non-POSIX features.
  680. PROVX1         Build for Venix 1.0 on DEC Professional 3xx.
  681. PTX            Build for Dynix/PTX
  682. PWID_T=xxx     getpwid() type is xxx.
  683. RBSIZ=xxx      Define overall size of receive-packet buffer (with DYNAMIC).
  684. RDCHK          rdchk() system call is available.
  685. RENAME         rename() system call is available (UNIX).
  686. RTAIX          Build for AIX 2.2.1 on IBM RT PC.
  687. RTU            Build for Masscomp / Concurrent RTU.
  688. SAVEDUID       BSD or other non-AT&T UNIX has saved-setuid feature.
  689. SBSIZ=xxx      Define overall size of send-packet buffer (use with DYNAMIC).
  690. SDIRENT        Directory structure specified in <sys/dirent.h>.
  691. SELECT         select() function available (conflicts with NAP and USLEEP)
  692. SETEUID        BSD 4.4-style seteXid() functions available.
  693. SIG_V          Type for signal() is void.  Used to override normal assumption.
  694. SIG_I          Type for signal() is int.  Used to override normal assumption.
  695. SONYNEWS       Build for Sony NEWS-OS.
  696. STERMIOX       <sys/termiox.h> is available.
  697. STRATUS        Build for Stratus VOS.
  698. STRATUSX25     Include Stratus VOS X.25 support.
  699. SUN4S5         Build for SUNOS 4.x in the System V R3 environment.
  700. SUNOS4         Build for SUNOS 4.0 in the BSD environment.
  701. SUNOS41        Build for SUNOS 4.1 in the BSD environment.
  702. SUNX25         Build with support for SunLink X.25.
  703. SVR3           Build for AT&T System V Release 3.
  704. SVR3JC         Allow job control support on System V Release 3 UNIX versions.
  705. SVR4           Build for AT&T System V Release 4.
  706. SW_ACC_ID      UNIX only -- swap real & effective ids around access() calls.
  707. sxaE50         Build for PFU Compact A Series SX/A TISP.
  708. SYSUTIMEH      Include <sys/utime.h> for setting file dates (88OPEN)
  709. TCPSOCKET      Build with support for TCP/IP via Berkeley sockets library.
  710. TERMIOX        <termiox.h> header file is available (mostly SVR4).
  711. TNCODE         Include TELNET-specific code.
  712. TOWER1         Build for NCR Tower 1632 with OS 1.02.
  713. TRS16          Build for Tandy 16/6000.
  714. UID_T=xxx      Type for uids is xxx (normally int or uid_t).
  715. USLEEP         usleep() system call available (conflicts with NAP & SELECT).
  716. UTEK           Build for Tektronix workstations with UTEK OS.
  717. UTIMEH         Include <utime.h> for setting file dates (SVR4, POSIX)
  718. UTS24          Build for Amdahl UTS 2.4.
  719. V7             Build for Version 7 UNIX.
  720. VMS            Build for VAX/VMS.
  721. VOID=xxx       VOID type for functions (int or void).
  722. VXVE           Build for CDC VX/VE 5.2.1.
  723. WAIT_T=xxx     Type of argument passed to wait().
  724. WINTCP         Build with Wollongong VAX/VMS TCP/IP (implies TCPSOCKET)
  725. WOLLONGONG     Build with Wollongong UNIX TCP/IP (implies TCPSOCKET)
  726. XENIX          Build for Xenix (SCO, Tandy, others).
  727. XNDIR          Support for BSD long filenames via <sys/ndir.h>.
  728. ZFCDAT         Define this if zfcdat() function is available in Kermit.
  729. ZILOG          Build for Zilog ZEUS.
  730.  
  731. (End of CKCCFG.DOC)
  732.