-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathckccfg.txt
1496 lines (1232 loc) · 66.1 KB
/
ckccfg.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
The Kermit Project
Columbia University
612 West 115th Street
New York NY 10025 USA
...since 1981
C-Kermit Configuration Options
As of: C-Kermit 9.0.300, 30 June 2011
This page last updated: Fri Jul 1 15:48:21 2011 (New York USA Time)
IF YOU ARE READING A PLAIN-TEXT version of this document, note that
this file is a plain-text dump of a Web page. You can visit the
original (and possibly more up-to-date) Web page here:
http://www.columbia.edu/kermit/ckccfg.html
CONTENTS
1. FILE TRANSFER
2. SERIAL COMMUNICATION SPEEDS
3. FULLSCREEN FILE TRANSFER DISPLAY
4. CHARACTER SETS
5. APC EXECUTION
6. PROGRAM SIZE
7. MODEM DIALING
8. NETWORK SUPPORT
9. EXCEPTION HANDLING
10. SECURITY FEATURES
11. ENABLING SELECT()
12. I/O REDIRECTION
13. FLOATING-POINT NUMBERS, TIMERS, AND ARITHMETIC
14. SPECIAL CONFIGURATIONS
I. SUMMARY OF COMPILE-TIME OPTIONS
OVERVIEW
This document describes configuration options for C-Kermit (5A and
later). The major topics covered include program size (and how to
reduce it), how to include or exclude particular features, notes on
serial-port, modem, and network support, and a list of C-Kermit's
compile-time options.
For details about your particular operating system, also see the
system-specific installation instructions file, such as the
C-Kermit Installation Instructions for Unix.
1. FILE TRANSFER
Prior to version 7.0, C-Kermit was always built with the most
conservative Kermit file-transfer protocol defaults on every platform:
no control-character prefixing, 94-byte packets, and a window size of
1.
Starting in version 7.0, fast settings are the default. To override
these at compile time, include:
-DNOFAST
in the C compiler CFLAGS. Even with the fast defaults, C-Kermit
automatically drops down to whatever window and packet sizes requested
by the other Kermit, if these are smaller, when sending files (except
for control-character unprefixing, which is not negotiated, and which
is now set to CAUTIOUS rather than NONE at startup). C-Kermit's
settings prevail when it is receiving.
2. SERIAL COMMUNICATION SPEEDS
As of 6 September 1997, a new simplified mechanism for obtaining the
list of legal serial interface speeds is in place:
* If the symbol TTSPDLIST is defined, the system-dependent routine
ttspdlist() is called at program initialization to obtain the list.
* This symbol should be defined only for C-Kermit implementations
that have implemented the ttspdlist() function, typically in the
ck?tio.c module. See ckutio.c for an example.
* TTSPDLIST is automatically defined in ckcdeb.h for UNIX. Add
the appropriate #ifdefs for other platforms when the corresponding
ttspdlist() functions are filled in.
* If TTSPDLIST is (or normally would be) defined, the old code
(described below) can still be selected by defining NOTTSPDLIST.
The ttspdlist() function can obtain the speeds in any way that works.
For example, based simply on #ifdef Bnnnn..#endif (in UNIX). Although
it might be better to actually check each speed against the currently
selected hardware interface before allowing it in the array, there is
usually no passive and/or reliable and safe way to do this, and so it's
better to let some speeds into the array that might not work, than it
is to erroneously exclude others. Speeds that don't work are caught
when the SET SPEED command is actually given.
Note that this scheme does not necessarily rule out split speed
operation, but effectively it does in C-Kermit as presently constituted
since there are no commands to set input and output speed separately
(except the special case "set speed 75/1200").
Note that some platforms, notably AIX 4.2 and 4.3, implement high
serial speeds transparently to the application, e.g. by mapping 50 bps
to 57600 bps, and so on.
That's the whole deal. When TTSPDLIST is not defined, the following
applies:
Speeds are defined in two places: the SET SPEED keyword list in the
command parser (as of this writing, in the ckuus3.c source file),
and in the system- dependent communications i/o module, ck?tio.c,
functions ttsspd() (set speed) and ttgspd() (get speed). The following
speeds are assumed to be available in all versions:
0, 110, 300, 600, 1200, 2400, 4800, 9600
If one or more of these speeds is not supported by your system, you'll
need to change the source code (this has never happened so far). Other
speeds that are not common to all systems have Kermit-specific symbols:
Symbol Symbol
Speed (bps) to enable to disable
50 BPS_50 NOB_50
75 BPS_75 NOB_75
75/1200 BPS_7512 NOB_7512
134.5 BPS_134 NOB_134
150 BPS_150 NOB_150
200 BPS_200 NOB_200
1800 BPS_1800 NOB_1800
3600 BPS_3600 NOB_3600
7200 BPS_7200 NOB_7200
14400 BPS_14K NOB_14K
19200 BPS_19K NOB_19K
28800 BPS_28K NOB_28K
38400 BPS_38K NOB_38K
57600 BPS_57K NOB_57K
76800 BPS_76K NOB_76K
115200 BPS_115K NOB_155K
230400 BPS_230K NOB_230K
460800 BPS_460K NOB_460K
921600 BPS_921K NOB_921K
The ckcdeb.h header file contains default speed configurations for
the many systems that C-Kermit supports. You can override these
defaults by (a) editing ckcdeb.h, or (b) defining the appropriate
enabling and/or disabling symbols on the CC command line, for example:
-DBPS_14400 -DNOB_115200
or the "make" command line, e.g.:
make blah "KFLAGS=-DBPS_14400 -DNOB_115200"
Note: some speeds have no symbols defined for them, because they have
never been needed: 12.5bps, 45.5bps, 20000bps, etc. These can easily be
added if required (but they will work only if the OS supports them).
IMPORTANT: Adding one of these flags at compile time does not
necessarily mean that you will be able to use that speed. A particular
speed is usable only if your underlying operating system supports it.
In particular, it needs to be defined in the appropriate system header
file (e.g. in UNIX, cd to /usr/include and grep for B9600 in *.h and
sys/*.h to find the header file that contains the definitions for the
supported speeds), and supported by the serial device driver, and of
course by the physical device itself.
ALSO IMPORTANT: The list of available speeds is independent of how they
are set. The many UNIXes, for example, offer a wide variety of APIs
that are BSD-based, SYSV-based, POSIX-based, and purely made up. See
the ttsspd(), ttgspd(), and ttspdlist() routines in ckutio.c for
illustrations.
The latest entries in this horserace are the tcgetspeed() and
ttsetspeed() routines found in UnixWare 7. Unlike other methods, they
accept the entire range of integers (longs really) as speed values,
rather than certain codes, and return an error if the number is not, in
fact, a legal speed for the device/driver in question. In this case,
there is no way to build a list of legal speeds at compile time, since
no Bnnnn symbols are defined (except for "deprecated, legacy"
interfaces like ioctl()) and so the legal speed list must be enumerated
in the code -- see ttspdlist() in ckutio.c.
3. FULLSCREEN FILE TRANSFER DISPLAY
New to edit 180 is support for an MS-DOS-Kermit-like local-mode full
screen file transfer display, accomplished using the curses library, or
something equivalent (for example, the Screen Manager on DEC VMS). To
enable this feature, include the following in your CFLAGS:
-DCK_CURSES
and then change your build procedure (if necessary) to include the
necessary libraries. For example, in Unix these are usually "curses" or
"ncurses" (and more recently, "ncursesw" and "slang"), perhaps also
"termcap", "termlib", or "tinfo":
"LIBS= -lcurses -ltermcap"
"LIBS= -lcurses -ltermlib"
"LIBS= -lncurses"
"LIBS= -ltermlib"
"LIBS= -ltinfo"
"man curses" for further information, and search through the Unix
makefile for "CK_CURSES" to see many examples, and also see the
relevant sections of the Unix C-Kermit Installation Instructions,
particularly Sections 4 and 9.2.
There might still be a complication. Some implementations of curses
reserve the right to alter the buffering on the output file without
restoring it afterwards, which can leave Kermit's command processing in
a mess when the prompt comes back after a fullscreen file transfer
display. The typical symptom is that characters you type at the prompt
after a local-mode file transfer (i.e. after seeing the curses
file-transfer display) do not echo until you press the Return (Enter)
key. If this happens to you, try adding
-DCK_NEWTERM
to your makefile target (see comments in screenc() in ckuusx.c for
an explanation).
If that doesn't fix the problem, then use a bigger hammer and replace
-DCK_NEWTERM with:
-DNONOSETBUF
which tells Kermit to force stdout to be unbuffered so CBREAK mode can
work.
In SCO Xenix and SCO UNIX, there are two separate curses libraries, one
based on termcap and the other based on terminfo. The default library,
usually terminfo, is established when the development system is
installed. To manually select terminfo (at compile time):
compile -DM_TERMINFO and link -ltinfo
and to manually select termcap:
compile -DM_TERMCAP and link -ltcap -ltermlib
<curses.h> looks at M_TERMINFO and M_TERMCAP to decide which header
files to use. /usr/lib/libcurses.a is a link to either libtinfo.a or
libtcap.a. The C-Kermit compilation options must agree with the version
of the curses library that is actually installed.
NOTE: If you are doing an ANSI-C compilation and you get compile time
warnings like the following:
Warning: function not declared in ckuusx.c: wmove, printw, wclrtoeol,
wclear, wrefresh, endwin, etc...
it means that your <curses.h> file does not contain prototypes for
these functions. The warnings should be harmless.
New to edit 190 is the ability to refresh a messed-up full-screen
display, e.g. after receiving a broadcast message. This depends on the
curses package including the wrefresh() and clearok() functions and the
curscr variable. If your version has these, or has code to simulate
them, then add:
-DCK_WREFRESH
The curses and termcap libraries add considerable size to the program
image (e.g. about 20K on a SUN-4, 40K on a 386). On some small systems,
such as the AT&T 6300 PLUS, curses can push Kermit over the edge...
even though it compiles, loads, and runs correctly, its increased size
apparently makes it swap constantly, slowing it down to a crawl, even
when the curses display is not in use. Some new makefile targets have
been added to take care of this (e.g. sys3upcshcc), but similar tricks
might be necessary in other cases too.
On the curses file-transfer display, just below the "thermometer", is a
running display of the transfer rate, as a flat quotient of file
characters per elapsed seconds so far. You can change this to an
average that gives greater weight to recent history (0.25 *
instantaneous cps + 0.75 * historical cps) by adding -DCPS_WEIGHTED to
your CFLAGS (sorry folks, this one is not worth a SET command). You can
choose a second type of weighted average in which the weighting smooths
out progressively as the transfer progresses by adding -DCPS_VINCE to
-DCPS_WEIGHTED.
An alternative to curses is also available at compile time, but should
be selected if your version of Kermit is to be run in local mode only
in an ANSI terminal environment, for example on a desktop workstation
that has an ANSI console driver. To select this option in place of
curses, define the symbol MYCURSES:
-DMYCURSES
instead of CK_CURSES. The MYCURSES option uses built-in ANSI (VT100)
escape sequences, and depends upon your terminal or console driver to
interpret them correctly.
In some C-Kermit builds, we replace printf() via #define printf...
However, this can cause conflicts with the [n]curses header files.
Various hacks are required to get around this -- see ckutio.c,
ckufio.c, ckuusx.c, ckucmd.c, etc.
4. CHARACTER SETS
Since version 5A, C-Kermit has included support for conversion of
character sets for Western European languages (i.e. languages that
originated in Western Europe, but are now also spoken in the Western
Hemisphere and other parts of the world), via ISO 8859-1 Latin Alphabet
1, for Eastern European languages (ISO Latin-2), Hebrew (and Yiddish),
Greek, and Cyrillic-alphabet languages (ISO Latin/Cyrillic). Many file
(local) character sets are supported: ISO 646 7-bit national sets, IBM
code pages, Apple, DEC, DG, NeXT, etc.
To build Kermit with no character-set translation at all, include
-DNOCSETS in the CFLAGS. To build with no Latin-2, add -DNOLATIN2. To
build with no Cyrillic, add -DNOCYRIL. To omit Hebrew, add -DNOHEBREW.
If -DNOCSETS is *not* included, you'll always get LATIN1. To build with
no KANJI include -DNOKANJI. There is presently no way to include
Latin-2, Cyrillic, Hebrew, or Kanji without also including Latin-1.
Unicode support was added in C-Kermit 7.0, and it adds a fair
amount of tables and code (and this is only a "Level 1" implementation
-- a higher level would also require building in the entire Unicode
database). On a PC with RH 5.2 Linux, building C-Kermit 7.0, we get the
following sizes:
NOCSETS NOUNICODE NOKANJI Before After
[ ] [ ] [ ] 1329014 (Full)
[ ] [ ] [ X ] 1325686 (Unicode but no Kanji)
[ ] [ X ] [ ] 1158837 (All charsets except Unicode)
[ X ] [ x ] [ x ] 1090845 (NOCSETS implies the other two)
Note, by the way, that NOKANJI without NOUNICODE only removes the
non-Unicode Kanji sets (Shift-JIS, EUC-JP, JIS-7, etc). Kanji is still
representable in UCS-2 and UTF-8.
5. APC EXECUTION
The Kermit CONNECT and INPUT commands are coded to execute Application
Program Command escape sequences from the host:
<ESC>_<text><ESC>\
where <text> is a C-Kermit command, or a list of C-Kermit commands
separated by commas, up to about 1K in length.
To date, this feature has been included in the OS/2, Windows, VMS,
OS-9, and Unix versions, for which the symbol:
CK_APC
is defined automatically in ckuusr.h. For OS/2, APC is enabled at
runtime by default, for UNIX it is disabled. It is controlled by the
SET TERMINAL APC command. Configuring APC capability into a version
that gets it by default (because CK_APC is defined in ckuusr.h) can
be overridden by including:
-DNOAPC
on the CC command line.
C-Kermit's autodownload feature depends on the APC feature, so
deconfiguring APC also disables autodownload (it doesn't use APC escape
sequences, but uses the APC switching mechanism internally).
6. PROGRAM SIZE
SECTION CONTENTS
6.1. Feature Selection
6.2. Changing Buffer Sizes
6.3. Other Size-Related Items
6.4. Space/Time Tradeoffs
(Also see Section 4)
Each release of C-Kermit is larger than the last. On some computers
(usually old ones) the size of the program prevents it from being
successfully linked and loaded. On some others (also usually old ones),
it occupies so much memory that it is constantly swapping or paging. In
such cases, you can reduce C-Kermit's size in various ways, outlined in
this section. The following options can cut down on the program's size
at compile time by removing features or changing the size of storage
areas.
If you are reading this section because all you want is a small, fast,
quick-to-load Kermit file-transfer application for the remote end of
your connection, and the remote end is Unix based, take a look at
G-Kermit:
http://www.columbia.edu/kermit/gkermit.html
6.1. Feature Selection
Features can be added or removed by defining symbols on the CC (C
compiler) command line. "-D" is the normal CC directive to define a
symbol so, for example, "-DNODEBUG" defines the symbol NODEBUG. Some C
compilers might use different syntax, e.g. "-d NODEBUG" or
"/DEFINE=NODEBUG". For C compilers that do not accept command-line
definitions, you can put the corresponding #define statements in the
file ckcsym.h, for example:
#define NODEBUG
The following table shows the savings achieved when building C-Kermit
8.0 (Beta.04) with selected feature-deselection switches on an
Intel-based PC with Red Hat Linux 7.0 and gcc 2.96. The sizes are for
non-security builds. The fully configured non-security build is 2127408
bytes.
Option Size Savings Effect
NOICP 545330 74.4% No Interactive Command Parser (command-line only)
NOLOCAL 1539994 27.6% No making connections.
NOXFER 1551108 27.1% No file transfer.
IKSDONLY 1566608 26.4% Internet Kermit Server only.
NOCSETS 1750097 17.7% No character-set conversion.
NOSPL 1800293 15.4% No Script Programming Language.
NONET 1808575 15.0% No making network connections.
NOUNICODE 1834426 13.8% No Unicode character-set conversion.
NOHELP 1837877 13.6% No built-in help text.
NODEBUG 1891669 11.1% No debug log.
NOFRILLS 1918966 9.8% No "frills".
NOFTP 1972496 7.3% No FTP client.
NODIAL 1984488 6.7% No automatic modem dialing.
NOPUSH 2070184 2.7% No shell access, running external programs, etc.
NOIKSD 2074129 2.5% No Internet Kermit Server capability.
NOHTTP 2082610 2.1% No HTTP client.
NOFLOAT 2091332 1.7% No floating-point arithmetic.
NOCHANNELIO 2095978 1.5% No FOPEN/FREAD/FWRITE/FCLOSE, etc.
MINIDIAL 2098035 1.4% No built-in support for many kinds of modems.
NOSERVER 2098987 1.3% No server mode.
NOSEXP 2105898 1.0% No S-Expressions.
NOPTY 2117743 0.5% No pseudoterminal support.
NORLOGIN 2121089 0.3% No RLOGIN connections.
NOOLDMODEMS 2124038 0.2% No built-in support for old kinds of modems.
NOSSH 2125696 0.1% No SSH command.
And here are a few combinations
Options Size Savings Effect
NODEBUG NOICP NOCSETS NOLOCAL 281641 86.7% No debug log, parser,
character sets, or making connections.
NOICP NOCSETS NOLOCAL 376468 82.3% No parser, character sets, or making
connections.
NOICP NOCSETS NONET 427510 79.9% No parser, character sets, or network
connections.
NOSPL NOCSETS 1423784 33.1% No script language, or character sets.
-DNOFRILLS removes various command synonyms; the following top-level
commands: CLEAR, DELETE, DISABLE, ENABLE, GETOK, MAIL, RENAME, TYPE,
WHO; and the following REMOTE commands: KERMIT, LOGIN, LOGOUT, PRINT,
TYPE, WHO.
6.2. Changing Buffer Sizes
Most modern computers have so much memory that (a) there is no need to
scrimp and save, and (b) C-Kermit, even when fully configured, is
relatively small by today's standards.
Two major factors affect Kermit's size: feature selection and buffer
sizes. Buffer sizes affect such things as the maximum length for a
Kermit packet, the maximum length for a command, for a macro, for the
name of a macro, etc. Big buffer sizes are used when the following
symbol is defined:
BIGBUFOK
as it is by default for most modern platforms (Linux, AIX 4 and 5,
HP-UX 10 and 11, Solaris, etc) in ckuusr.h. If your build does not
get big buffers automatically (SHOW FEATURES tells you), you can
include them by rebuilding with BIGBUFOK defined; e.g. in Unix:
make xxxx KFLAGS=-DBIGBUFOK
where xxxx is the makefile target. On the other hand, if you want to
build without big buffers when they normally would be selected, use:
make xxxx KFLAGS=-DNOBIGBUF
There are options to control Kermit's packet buffer allocations. The
following symbols are defined in ckcker.h in such a way that you
can override them by redefining them in CFLAGS:
-DMAXSP=xxxx - Maximum send-packet length.
-DMAXRP=xxxx - Maximum receive-packet length.
-DSBSIZ=xxxx - Total allocation for send-packet buffers.
-DRBSIZ=xxxx - Total allocation for receive-packet buffers.
The defaults depend on the platform.
Using dynamic allocation (-DDYNAMIC) reduces storage requirements for
the executable program on disk, and allows more and bigger packets at
runtime. This has proven safe over the years, and now most builds (e.g.
all Unix, VMS, Windows, and OS/2 ones) use dynamic memory allocation by
default. If it causes trouble, however, then omit the -DDYNAMIC option
from CFLAGS, or add -DNODYNAMIC.
6.3. Other Size-Related Items
To make Kermit compile and load successfully, you might have to change
your build procedure to:
a. Request a larger ("large" or "huge") compilation / code-generation
model. This is needed for 16-bit PC-based UNIX versions (most or
all of which fail to build C-Kermit 7.0 and later anyway). This is
typically done with a -M and/or -F switch (see your cc manual or
man page for details).
b. Some development systems support overlays. If the program is too
big to be built as is, check your loader manual ("man ld") to see
if an overlay feature is available. See the 2.10/2.11 BSD example
in the UNIX makefile. (Actually, as of version 7.0, C-Kermit is too
big to build, period, even with overlays, on 2.xx BSD).
c. Similarly, some small and/or segment-based architectures support
"code mapping", which is similar to overlays (PDP11-based VENIX
1.0, circa 1984, was an example). See the linker documentation on
the affected platform.
It is also possible to reduce the size of the executable program file
in several other ways:
a. Include the -O (optimize) compiler switch if it isn't already
included in your "make" entry (and if it works!). If your compiler
supports higher levels of optimization (e.g. -O2 or higher number,
-Onolimit (HP-UX), etc), try them; the greater the level of
optimization, the longer the compilation and more likely the
compiler will run out of memory. The latter eventuality, some
compilers also provide command-line options to allocate more memory
for the optimizer, like "-Olimit number" in Ultrix.
b. If your platform supports shared libraries, change the make entry
to take advantage of this feature. The way to do this is, of
course, platform dependent; see the NeXT makefile target for an
example. some platforms (like Solaris) do it automatically and give
you no choice. But watch out: executables linked with shared
libraries are less portable than statically linked executables.
c. Strip the program image after building ("man strip" for further
info), or add -s to the LNKFLAGS (UNIX only). This strips the
program of its symbol table and relocation information.
d. Move character strings into a separate file. See the 2.11 BSD
target for an example.
6.4. Space/Time Tradeoffs
There are more than 6000 debug() statements in the program. If you want
to save both space (program size) and time (program execution time),
include -DNODEBUG in the compilation. If you want to include debugging
for tracking down problems, omit -DNODEBUG from the make entry. But
when you include debugging, you have two choices for how it's done. One
definition defines debug() to be a function call; this is cheap in
space but expensive in execution. The other defines debug as "if
(deblog)" and then the function call, to omit the function call
overhead when the debug log is not active. But this adds a lot of space
to the program. Both methods work, take your choice; IFDEBUG is
preferred if memory is not a constraint but the computer is likely to
be slow. The first method is the default, i.e. if nothing is done to
the CFLAGS or in ckcdeb.h (but in some cases, e.g. VMS, it is). To
select the second method, include -DIFDEBUG in the compilation (and
don't include -DNODEBUG).
7. MODEM DIALING
-DNODIAL removes automatic modem dialing completely, including the
entire ckudia.c module, plus all commands that refer to dialing in
the various ckuus*.c modules.
-DMINIDIAL leaves the DIAL and related commands (SET/SHOW MODEM,
SET/SHOW DIAL) intact, but removes support for all types of modems
except CCITT, Hayes, Unknown, User-defined, Generic-high-speed, and
None (= Direct). The MINIDIAL option cuts the size of the dial module
approximately in half. Use this option if you have only Hayes or CCITT
modems and don't want to carry the baggage for the other types.
A compromise between full dialer support and MINIDIAL is obtained by
removing support for "old" modems -- all the strange non-Hayes
compatible 1200 and 2400 bps modems that C-Kermit has been carrying
around since 1985 or so. To remove support for these modems, add
-DNOOLDMODEMS to CFLAGS at compilation time.
Finally, if you keep support for old modems, you will notice that their
names appear on the "set modem ?" menu. That's because their names are,
by default, "visible". But the list is confusing to the younger
generation, who have only heard of modems from the V.32bis-and-later
era. If you want to be able to use old modems, but don't want their
names cluttering up menus, add this to CFLAGS:
-DM_OLD=1
8. NETWORK SUPPORT
SECTION CONTENTS
8.1. TCP/IP
8.2. X.25
8.3. Other Networks
C-Kermit supports not only serial-port and modem connections, but also
TCP/IP and X.25 network connections. Some versions support other
network types too like DECnet, LAT, NETBIOS, etc. If you define the
following symbol:
NONET
then all network support is compiled away.
8.1. TCP/IP
SUBSECTION CONTENTS
8.1.1. Firewalls
8.1.2. Compilation and Linking Problems
8.1.3. Enabling Host Address Lists
8.1.4. Enabling Telnet NAWS
8.1.5. Enabling Incoming TCP/IP Connections
8.1.6. Disabling SET TCP Options
C-Kermit's TCP/IP features require the Berkeley sockets library or
equivalent, generally available on any Unix system, as well as in
Windows 9x/NT, OS/2, VMS, AOS/VS, VOS, etc. The TCP/IP support includes
built-in TELNET, FTP, and HTTP protocol. To select TCP/IP support,
include -DTCPSOCKET in your makefile target's CFLAGS, or (in VMS) the
appropriate variant (e.g. -DWOLLONGONG, -DMULTINET, -DEXCELAN,
-DWINTCP, etc).
The VMS and/or early Unix third-party TCP/IP products are often
incompatible with each other, and sometimes with different versions of
themselves. For example, Wollongong reportedly put header files in
different directories for different UNIX versions:
* in.h can be in either /usr/include/sys or /user/include/netinet.
* telnet.h can be in either /usr/include/arpa or
/user/include/netinet.
* inet.h can be in either /usr/include/arpa or /user/include/sys.
In cases like this, use the -I cc command-line option when possible;
otherwise it's better to make links in the file system than it is to
hack up the C-Kermit source code. Suppose, for example, Kermit is
looking for telnet.h in /usr/include/arpa, but on your computer it is
in /usr/include/netinet. Do this (as root, or get the system
administrator to do it):
cd /usr/include/arpa
ln /usr/include/netinet/telnet.h telnet.h
("man ln" for details about links.)
The network support for TCP/IP and X.25 is in the source files
ckcnet.h, ckctel.c, ckctel.c, ckctel.h,
ckcftp.c, with miscellaneous SHOW commands, etc, in the various
ckuus*.c modules, plus code in the ck*con.c or ckucns.c (CONNECT
command) and several other modules to detect TELNET negotiations, etc.
Within the TCPSOCKET code, some socket-level controls are included if
TCPSOCKET is defined in the C-Kermit CFLAGS and SOL_SOCKET is defined
in in the system's TCP-related header files, such as <sys/socket.h>.
These are:
SET TCP KEEPALIVE
SET TCP LINGER
SET TCP RECVBUF
SET TCP SENDBUF
In addition, if TCP_NODELAY is defined, the following command is also
enabled:
SET TCP NODELAY (Nagle algorithm)
See the C-Kermit user documentation for descriptions of these
commands.
8.1.1. Firewalls
There exist various types of firewalls, set up to separate users of an
internal TCP/IP network ("Intranet") from the great wide Internet, but
then to let selected users or services get through after all.
One firewall method is called SOCKS, in which a proxy server allows
users inside a firewall to access the outside world, based on a
permission list generally stored in a file. SOCKS is enabled in one of
two ways. First, the standard sockets library is modified to handle the
firewall, and then all the client applications are relinked (if
necessary, i.e. if the libraries are not dynamically loaded) with the
modified sockets library. The APIs are all the same, so the
applications do not need to be recoded or recompiled.
In the other method, the applications must be modified to call
replacement routines, such as Raccept() instead of accept(), Rbind()
instead of bind(), etc, and then linked with a separate SOCKS library.
This second method is accomplished (for SOCKS4) in C-Kermit by
including -DCK_SOCKS in your CFLAGS, and also adding:
-lsocks
to LIBS, or replacing -lsockets with -lsocks (depending on whether the
socks library also includes all the sockets entry points).
For SOCKS5, use -DCK_SOCKS5.
Explicit firewall support can, in general, not be a standard feature or
a feature that is selected at runtime, because the SOCKS library tends
to be different at each site -- local modifications abound.
The ideal situation occurs when firewalls are supported by the first
method, using dynamically linked sockets-replacement libraries; in this
case, all your TCP/IP client applications negotiate the firewall
transparently.
8.1.2. Compilation and Linking Problems
If you get a compilation error in ckcnet.c, with a complaint like
"incompatible types in assignment", it probably has something to do
with the data type your system uses for the inet_addr() function, which
is declared (usually) in <arpa/inet.h>. Kermit uses "unsigned long"
unless the symbol INADDRX is defined, in which case "struct inaddr" is
used instead. Try adding -DINADDRX to CFLAGS in your make entry, and if
that fixes the problem, please send a report to [email protected].
Compilation errors might also have to do with the data type used for
getsockopt() and setsockopt() option-length field. This is normally an
int, but sometimes it's a short, a long, or an unsigned any of those,
or a size_t. To fix the compilation problem, add -DSOCKOPT_T=xxx to the
CFLAGS in your makefile target, where xxx is the appropriate type (use
"man getsockopt" or grep through your system/network header files to
find the needed type).
8.1.3. Enabling Host Address Lists
When you give Kermit an IP host name, it calls the socket routine
gethostbyname() to resolve it. gethostbyname() returns a hostent
struct, which might or might not not include a list of addresses; if it
does, then if the first one fails, Kermit can try the second one, and
so on. However, this will only work if the symbol "h_addr" is a macro
defined as "h_addr_list", usually in netdb.h. If it is, then you can
activate this feature by defining the following symbol in CFLAGS:
HADDRLIST
8.1.4. Enabling Telnet NAWS
The Telnet Negotiation About Window Size (NAWS) option requires the
ability to find out the terminal screen's dimensions. E.g. in Unix, we
need something like ioctl(0, TIOCGWINSZ, ...). If your version of
Kermit was built with NAWS capability, SHOW VERSIONS includes CK_NAWS
among the compiler options. If it doesn't, you can add it by defining
CK_NAWS at compile time. Then, if the compiler or linker complain about
undefined or missing symbols, or there is no complaint but SHOW
TERMINAL fails to show reasonable "Rows =, Columns =" values, then take
a look at (or write) the appropriate ttgwsiz() routine. On the other
hand, if CK_NAWS is defined by default for your system (in
ckcnet.h), but causes trouble, you can override this definition by
including the -DNONAWS switch on your CC command line, thus disabling
the NAWS feature.
This appears to be needed at least on the AT&T 3B2, where in
ckutio.c, the routine ttgwsiz() finds that the TIOCGWINSZ symbol
is defined but lacks definitions for the corresponding winsize struct
and its members ws_col and ws_row.
The UNIX version of C-Kermit also traps SIGWINCH, so it can send a NAWS
to the Telnet server any time the local console terminal window size
changes, e.g. when you stretch it with a mouse. The SIGWINCH-trapping
code is enabled if SIGWINCH is defined (i.e. in signal.h). If this code
should cause problems, you can disable it without disabling the NAWS
feature altogether, by defining NOSIGWINCH at compile time.
8.1.5. Enabling Incoming TCP/IP Connections
This feature lets you "set host * port" and wait for an incoming
connection on the given port. This feature is enabled automatically at
compile if TCPSOCKET is defined and SELECT is also defined. But watch
out, simply defining SELECT on the cc command line does not guarantee
successful compilation or linking (see Section 11).
If you want to disable incoming TCP/IP connections, then build C-Kermit
with:
-DNOLISTEN
8.1.6. Disabling SET TCP Options
The main reason for this is because of header file / prototype
conflicts at compile time regarding get- / setsockopt(). If you can't
fix them (without breaking other builds), add the following in CFLAGS:
-DNOTCPOPTS
8.2. X.25
X.25 support requires (a) a Sun, (b) the SunLink product (libraries and
header files), and (c) an X.25 connection into your Sun. Similarly (in
C-Kermit 7.0 or later) Stratus VOS and IBM AIX.
In UNIX, special makefile targets sunos4x25 and sunos41x25 (for SUNOS
4.0 and 4.1, respectively), or aix41x25, are provided to build in this
feature, but they only work if conditions (a)-(c) are met. To request
this feature, include -DSUNX25 (or -DIBMX25) in CFLAGS.
SUNX25 (or -DIBMX25) and TCPSOCKET can be freely mixed and matched, and
selected by the user at runtime with the SET NETWORK TYPE command or
SET HOST switches.
8.3. Other Networks
Support for other networking methods -- NETBIOS, LAT, Named Pipes, etc
-- is included in ck*net.h and ck*net.c for implementations (such as
Windows or OS/2) where these methods are supported.
Provision is made in the organization of the modules, header files,
commands, etc, for addition of new network types such as DECnet, X.25
for other systems (HP-UX, VMS, etc), and so on. Send email to
[email protected] if you are willing and able to work on such a
project.
9. EXCEPTION HANDLING
The C language setjmp/longjmp mechanism is used for handling
exceptions. The jump buffer is of type jmp_buf, which almost everywhere
is typedef'd as an array, in which case you should have no trouble
compiling the exception-handling code. However, if you are building
C-Kermit in/for an environment where jmp_buf is something other than an
array (e.g. a struct), then you'll have to define the following symbol:
JBNOTARRAY
10. SECURITY FEATURES
Security, in the sense of secure authentication and strong encryption,
can be built into versionf of C-Kermit for which the appropriate
libraries and header files are available (Kerberos IV, Kerberos V,
OpenSSL, SRP), as explained in great detail in the Kermit Security
Reference
. The following symbols govern C-Kermit's security features at build
time:
NO_AUTHENTICATION
Means do not configure any TELNET AUTHENTICATION support. It
implies NO_ENCRYPTION and undefines any of the auth and encrypt
types. It does not undefine CK_SSL even though builds with
CK_SSL cannot succeed without CK_AUTHENTICATION. (This will be
supported in a future release. It will be needed to allow
C-Kermit to be built only as an FTP client.)
NO_KERBEROS
Means do not compile in any KERBEROS support when
CK_AUTHENTICATION has been defined.
NO_SRP
Do not compile in any SRP support when CK_AUTHENTICATION has
been defined.
NO_SSL
Do not compile in any SSL/TLS support
NO_ENCRYPTION
Do not compile in any Telnet encryption support. It does not
affect the use of SSL/TLS
NOSSH
Do not compile in any SSH support whether internal or external
CK_AUTHENTICATION
Telnet AUTHENTICATION support. (Also, required if SSL/TLS
support is desired.) On most platforms this does not autodefine
any authentication mechanisms such as Kerberos V, Kerberos IV,
SRP, ... Those need to be defined separately.
CK_KERBEROS
Defined automatically when KRB4, KRB5, or KRB524 are defined.
Implies that some version of Kerberos is in use.
KRB4
Should be defined when Kerberos IV support is desired.
KRB5
Should be defined when Kerberos V support is desired.
KRB524
Should be defined if both Kerberos V and Kerberos IV are used
and the Kerberos IV support is provided by the MIT Kerberos IV
compatibility library in the current Kerberos 5 distribution.
KRB5_U2U
Should be defined if KRB5 is defined and Kerberos 5 User to User
mode is desired.
HEIMDAL
Should be defined if Kerberos V support is provided by HEIMDAL.
Support for this option is not complete in C-Kermit 8.0. Anyone
interested in working on this should contact kermit-support.
CK_SRP
Should be defined if SRP support is desired.
CK_ENCRYPTION
Should be defined if TELNET ENCRYPTION option support is
desired. This option does not define any particular encryption
types. That should be done by defining CK_DES or CK_CAST.
CK_DES
Should be defined if either DES or 3DES Telnet Encryption option
support is desired.
LIBDES
If CK_DES is defined and DES support is being provided by either
Eric Young's libdes.a or OpenSSL 0.9.6x or earlier, this option
must be defined. If it is not defined, it will be assumed that
DES support is provided by the MIT Kerberos IV libraries.
CK_CAST
Should be defined if CAST Telnet Encryption option support is
desired
CK_SSL
Should be defined if SSL/TLS support (OpenSSL) is desired.
SSL_KRB5
If KRB5 is defined, and OpenSSL is built to support the Kerberos
5 ciphers, then you should define SSL_KRB5
NOSSLKRB5
If you are using OpenSSL 0.9.7 or higher and do not wish to
build with support for Kerberos 5 TLS ciphers, this option must
be defined.
ZLIB
If you are using OpenSSL 0.9.6 or higher and it has been
compiled with support for ZLIB compression, this option should
be defined to enable Kermit to properly enable the use of
compression.
SSHCMD
Defined for C-Kermit to enable the use of external SSH clients
from the Kermit command language
SSHBUILTIN
Defined for Kermit implementations that have integrated SSH
support. Currently only Windows.
ANYSSH
Defined if either SSHCMD or SSHBUILTIN are defined.
CK_SNDLOC
Telnet Send Location support.
NOSNDLOC
Do not include Telnet Send Location support.
CK_XDISPLOC
Telnet X-Display Location support. Determines if the X-Display
location information is sent to the Telnet server either via
Telnet XDISPLOC or NEW-ENV options.
NOXDISPLOC
Do not include Telnet X-Display Location support.
CK_FORWARD_X
Telnet Forward X Windows Session Data option. Used to protect
the privacy and integrity of X Windows Sessions when secure
telnet sessions are in use.
NOFORWARDX
Do not include Telnet Forward X Windows Session Data option.
Besides the strong forms of security listed above, C-Kermit also
embodies various internal security features, including:
NOPUSH
Compiling with the NOPUSH symbol defined removes all the "shell
escape" features from the program, including the PUSH, RUN, and
SPAWN commands, the "!" and "@" command prefixes, OPEN !READ,
OPEN !WRITE, job control (including the SUSPEND command), the
REDIRECT command, shell/DCL escape from CONNECT mode, as well as
the server's execution of REMOTE HOST commands (and, of course,
the ENABLE HOST command). Add NODISPO to also prevent acceptance
of incoming MAIL or REMOTE PRINT files. For UNIX, also be sure
to read Section 11 of the Unix C-Kermit Installation
Instructions. about set[ug]id configuration. Additional
restrictions can be enforced when in server mode; read about the
DISABLE command in the user manual.
NOCCTRAP
Compiling with NOCCTRAP prevents the trapping of SIGINT by
Kermit. Thus if the user generates a SIGINT signal (e.g. by
typing the system's interrupt character), Kermit will exit
immediately, rather than returning to its prompt.
NOPUSH and NOCCTRAP together allow Kermit to be run from restricted
shells, preventing access to system functions.
11. ENABLING SELECT()
Kermit works best if it can do nonblocking reads, nondestructive input
buffer checking, and millisecond sleeps. All of these functions can be
accomplished by the select() function, which, unfortunately, is not
universally available. Furthermore, select() is required if incoming
TCP/IP connections are to be supported.
select() was introduced with Berkeley UNIX, rejected by AT&T for System
V, but is gradually creeping in to all UNIX versions (and other
operating systems too) by virtue of its presence in the sockets
library, which is needed for TCP/IP. AT&T SVID for System V R4 includes
select(), but that does not mean that all SVR4 implementations have it.
Furthermore, even when select() is available, it might work only on
socket file descriptors, but not on others like serial ports, pipes,
etc. For example, in AOS/VS and BeOS, it works only with file
descriptors that were created by socket() and opened by connect() or
accept().