home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / c-kermit / cklins.txt < prev    next >
Text File  |  2020-01-01  |  14KB  |  351 lines
  1. C-KERMIT 7.0 INSTALLATION INSTRUCTIONS FOR STRATUS VOS
  2.  
  3. Applies to:  C-Kermit 7.0.197
  4. Last update: 8 February 2000
  5.  
  6. Author:   David Lane, Atlanta GA
  7.           Frank da Cruz, Columbia University
  8.           Kernie Brashier, Stratosphere, Ltd
  9.  
  10.   Copyright (C) 1985, 2000,
  11.     Trustees of Columbia University in the City of New York.
  12.     All rights reserved.  See the C-Kermit COPYING.TXT file or the
  13.     copyright text in the ckcmai.c module for disclaimer and permissions.
  14.  
  15. Report problems, suggestions, fixes, etc, to:
  16.  
  17.   The Kermit Project
  18.   Columbia University
  19.   612 West 115th Street
  20.   New York NY 10025-7799
  21.   USA
  22.   Email: kermit-support@columbia.edu
  23.   Web:   http://www.columbia.edu/kermit/
  24.   News:  comp.protocols.kermit.misc
  25.  
  26.  
  27. DOCUMENTATION
  28.  
  29. Frank da Cruz and Christine M. Gianone, "Using C-Kermit", Second Edition,
  30. 1997, Digital Press / Butterworth-Heinemann, Woburn, MA, ISBN 1-55558-164-1
  31. US single-copy price: $44.95; quantity discounts available.  Available in
  32. computer bookstores or directly from Columbia University:
  33.  
  34.   http://www.columbia.edu/kermit/manuals.html
  35.  
  36. Features added after version 6.0 was released are documented in the text file,
  37. ckermit2.txt (also available as a hypertext document, ckermit2.html).
  38.  
  39.  
  40. OVERVIEW
  41.  
  42. This file contains VOS-specific information.  For a description of general
  43. (system-independent) configuration options for C-Kermit, please read the file
  44. CKCCFG.TXT.  For information about known limitations or bugs, and possible
  45. workarounds, see the files CKCBWR.TXT and CKLBWR.TXT.
  46.  
  47. Once you have built C-Kermit according to the instructions in this file,
  48. you should install it in a directory that is in the users' library paths,
  49. but that is not likely to be overwritten when you install a new version of
  50. the operating system.  A good candidate would be >system>application_library.
  51.  
  52. It might also be a good idea to make a "Kermit library" directory for sample
  53. files and non-man-page-style documentation.  (master_disk)>kermit might be
  54. a good place for this.  Some of the files that could go there are:
  55.  
  56.   ckermit.ini
  57.     The standard initialization file.  Users should copy this to their home
  58.     directories.
  59.  
  60.   ckermod.ini
  61.     A sample customization file.  Users should copy this file to
  62.     their home directories, and make any desired modifications (user- or
  63.     site-specific customizations).
  64.  
  65.   ckermit.kdd
  66.     A sample dialing directory file.
  67.  
  68.   ckermit.knd
  69.     A sample network directory.
  70.  
  71.   ckermit.ksd
  72.     A sample services directory.
  73.  
  74.   ckermit.env
  75.     A sample "environment variable" file
  76.  
  77.   ckedemo.ksc
  78.     Macro definitions from "Using C-Kermit".
  79.  
  80.   ckevt.ksc
  81.     Command file to demonstrate special screen effects from "Using C-Kermit".
  82.  
  83.   ckepage.ksc
  84.     A sample script for sending alphanumeric pages.
  85.  
  86.   ckermit2.txt
  87.     A file listing the updates, changes, and corrections made to C-Kermit
  88.     since publication of the 2nd edition of "Using C-Kermit".
  89.  
  90.   ckcbwr.txt
  91.     The general C-Kermit "beware" file.
  92.  
  93.   cklbwr.txt
  94.     The VOS-specific C-Kermit beware file.
  95.  
  96.  
  97. READING A C-KERMIT DISTRIBUTION TAPE
  98.  
  99. If you have received C-Kermit on tape from Columbia University, it will
  100. most likely be written as ANSI labeled, and certainly is not VOS save
  101. format.  To read the files onto your system, do something like this,
  102. substituting your tape device name and supplying the density written on
  103. the tape.
  104.  
  105.      create_dir kermit_tape
  106.      change_current_dir kermit_tape
  107.      attach_port tape %s1#mt1.0
  108.      mount_tape tape -tape_format ansi -density 1600 -access_rights readonly
  109.      read_tape tape *
  110.      detach_port tape
  111.  
  112. You should at this point have all the files on the tape in your kermit_tape
  113. directory, and can procede to either build C-Kermit yourself, or use the
  114. pre-built version on the tape.
  115.  
  116.  
  117.  
  118. DECODING AND INSTALLING PREBUILT C-KERMIT BINARIES
  119.  
  120. VOS binaries (executable programs) are structured objects that are not
  121. suitable for FTP, placement on Unix or DOS disks, etc.  Therefore the VOS
  122. C-Kermit binaries are distributed in encoded form.  The first encoding is
  123. the VOS "bundle", for example:
  124.  
  125.   ckl196-all-vos1333.save.evf.gz
  126.  
  127. This is a VOS SAVE (backup) image (.save), converted for import/export
  128. with Encode VOS File (.evf), and then compressed with Gzip (.gz).  The
  129. ckl196-all-vos1333.save.evf.gz presently on the Kermit ftp site includes
  130. C-Kermit 7.0 binaries for VOS 13.3.3 on the three Stratus architectures.
  131. A MIME-encoded (Base-64) version of this archive is included on the
  132. C-Kermit 7.0 CDROM.
  133.  
  134. In case you don't have the tools to unpack the .save.evf.gz file, VOS
  135. binaries are also available separately in a special "hex" (printable ASCII)
  136. encoding, along with decoding tools.  Versions are provided for the 68k,
  137. i860, and continuum processors.  To bootstrap C-Kermit onto your system, you
  138. only need the command macro cklxtr.cm and the hex file for C-Kermit itself;
  139. the name of the C-Kermit hex file is in the following form:
  140.  
  141.   cklnnn-arch-vosvvvv.hex
  142.  
  143. where nnn is the C-Kermit edit number (such as 196) and arch is:
  144.  
  145.   7100 (Continuum, HP PA-RISC, Jetta)
  146.   i860 (Intel i860, RISC, XA/R, Atlantic, Ventnor)
  147.   m68k (Motorola mc680x0, CISC, XA2000, Fresco, Spitfire)
  148.  
  149. and vvvv is the VOS version (without periods), such as 1333 or 13.3.3.
  150.  
  151. Examples:
  152.  
  153.   ckl196-7100-vos1333.hex    C-Kermit 7.0.196 for Continuum with VOS 13.3.3
  154.   ckl196-7100-vos1401.hex    C-Kermit 7.0.196 for Continuum with VOS 14.0.1
  155.   ckl196-7100-vos1402g.hex   C-Kermit 7.0.196 for Continuum with VOS 14.0.2g
  156.   ckl196-7100-vos1410ac.hex  C-Kermit 7.0.196 for Continuum with VOS 14.1.0ac
  157.   ckl196-7100-vos1420aa.hex  C-Kermit 7.0.196 for Continuum with VOS 14.2.0aa
  158.   ckl196-i860-vos1333.hex    C-Kermit 7.0.196 for i860 with VOS 13.3.3
  159.   ckl196-m68k-vos1333.hex    C-Kermit 7.0.196 for mc68k with VOS 13.3.3
  160.  
  161. Each VOS binary is fully configured to include both TCP/IP and X.25 support.
  162. If your VOS system does not have TCP/IP or X.25, the Kermit program should
  163. nevertheless run normally, except without the ability to make TCP/IP or X.25
  164. connections.
  165.  
  166. If you have a different VOS version than those for which C-Kermit binaries
  167. are available, follow these guidelines:
  168.  
  169.  . If your VOS version is later, you can run the binary.  For example, if
  170.    you have VOS 14.2.0, you can run the ckl196-xxxx-vos1333 binary.
  171.  
  172.  . If your VOS version is one major release earlier than the Kermit binary, 
  173.    you should be able to run the binary.  For example, if you have VOS 13.3.3,
  174.    can run the VOS 14.2.0 binary.
  175.  
  176. Use the cklxtr.cm macro to convert the appropriate hex file into an executable
  177. binary for your VOS platform.
  178.  
  179. Also included are hex versions of a compiled extraction program, which runs
  180. much faster than the command macro version:
  181.  
  182.   cklxtr-7100.hex  - Extraction program for Continuum
  183.   cklxtr-i860.hex  - Extraction program for i860
  184.   cklxtr-m68k.hex  - Extraction program for m68k
  185.  
  186. Use the cklxtr.cm to convert the extraction program to .pm format, e.g.
  187. cklxtr-7100.pm, and then use the executable extraction program to extract
  188. the main C-Kermit program.
  189.  
  190. Both the command macro and the program take two positional parameters, the
  191. input file, and the output file.  The input file is the hex coded version of
  192. the program and the output file is resulting program module.  The C source for
  193. the hexifying program is included in the source-code archive.
  194.  
  195. After unloading all the necessary files into a directory, presumably using
  196. read_tape, convert the compiled conversion program, making certain to pick
  197. the appropriate architecture:
  198.  
  199.   cklxtr cklxtr-i860.hex extract.pm
  200.  
  201. Then extract C-Kermit:
  202.  
  203.   extract.pm ckl196-i860-vos1333.hex kermit.pm
  204.  
  205. The file formats used by the command macro and by the program are identical,
  206. so you can simply extract C-Kermit directly, but the two-step process can
  207. save a great deal of time.
  208.  
  209. The C-Kermit versions that are included in hex format are built without
  210. symbol tables, with optimization, and include support for X.25 and TCP/IP
  211. networking.
  212.  
  213.  
  214. BUILDING C-KERMIT FOR VOS
  215.  
  216. VOS C-Kermit is built with a command macro called cklmak.cm.  This macro
  217. recompiles and binds ALL the modules involved.  It allows you to build
  218. into a different directory than the one containing the sources, so you can
  219. build for different machines into different directories if you need to.
  220.  
  221. If you want to define a system-wide initialization file for C-Kermit, rather
  222. than making each user have her/his own copy, define the symbol CK_SYSINI to be
  223. the full pathname of the file, in the -kermit_options add:
  224.  
  225.   'CK_SYSINI %s1#m1_d01>kermit>ckermit.ini'
  226.  
  227. It is important that the string above get quoted properly, so if you are using
  228. a command line to do this it would come out something like:
  229.  
  230.   cklmak -kermit_options 'STRATUS DYNAMIC DCMDBUF CLSOPEN STRATUSX25 &+
  231.     ''CK_SYSINI %s1#m1_d01>kermit>ckermit.ini'''
  232.  
  233. Note: if you build Kermit to execute a system-wide initialization file, this
  234. file can (and probably should) (be modified to) "chain" to the user's own
  235. initialization file (if any) by ending (or starting, depending on the desired
  236. precedence) with a command like:
  237.  
  238.   if exist \v(home)ckermit.ini take \v(home)ckermit.ini
  239.  
  240. After you have built and tested the C-Kermit program successfully, you can
  241. discard the object (ck*.obj) files, which are no longer needed. Then you
  242. can copy the program modules to an application directory.
  243.  
  244. There are several utility programs that come with C-Kermit you may or may
  245. not want. Most of them have documentation files (*.txt) that come along that
  246. explain what they are for.  None of them is vital to using C-Kermit, though
  247. some are required to build it; these are built by cklmak.cm whether you ask
  248. for them or not. You can have cklmak delete the required files and not build
  249. the others by specifying -no_tools, but generally they are helpful programs
  250. to have.
  251.  
  252.  
  253. ADDITIONAL NOTES ON BUILDING FROM SOURCE
  254.  
  255. The latest working source code for VOS C-Kermit is at:
  256.  
  257.   ftp://kermit.columbia.edu/kermit/test/special/vos.zip
  258.  
  259. This is a DOS-format ZIP file.  The builder ftps it (in binary mode of
  260. course) to a Windows system, unzips it there, and then transfers the
  261. individual files (in text mode) to the VOS system for building.
  262.  
  263. Here are updated and hopefully up-to-date and accurate building instructions:
  264.  
  265. Create a directory under the source location of kermit called build_dir. This
  266. name is not specific; however the original macros run only if the source is
  267. built in a separate lib.  The cklmak.cm macro is the 'make' file for kermit
  268. and the default build directory name is build_lib.  Hence, if you change the
  269. name make sure you pass the full pathname to the cklmak macro.  Issue a start
  270. process command to start cklmak and you are on your way.  (This will throw an
  271. error if the build_dir is the same as the source_dir.)
  272.  
  273. These are the files that are VOS-specific:
  274.  
  275.   cklcon.c        C-Kermit code modules
  276.   cklcvt.cm       Conversion command macro, stream to fixed
  277.   ckldef.c        Utilty program used in build process
  278.   cklfio.c
  279.   cklins.doc      Installation document
  280.   cklker.bwr      Beware file
  281.   cklker.doc      VOS-specific documentation for C-Kermit
  282.   cklmak.cm       Build command macro, makes kermit.pm
  283.   cklnet.c
  284.   cklpro.c
  285.   ckltio.c
  286.   ckltxt.c        Hex-ify program
  287.   ckltxt.doc      Note about hex format used by ckltxt and cklxtr
  288.   cklvos.hlp      This file
  289.   cklxtr.c        Un-hex program
  290.   cklxtr.cm       Un-hex command macro
  291.  
  292. cklcvt.cm shouldn't be required anymore, now that there is a 
  293. cvt_stream_to_fixed.pm command...
  294.  
  295. Assuming that the ckl*.* files go on a tape with the rest of the C-Kermit
  296. sources, that's all you need.  The files that C-Kermit uses are all mentioned
  297. in cklmak.cm, other than the header files.  VOS C-Kermit uses the regular
  298. C-Kermit command processor (ckucmd, ckuu*, etc.), the script (ckuscr.c), DIAL
  299. (ckudia.c) and charset (ckuxla.c) packages, Wart (ckwart.c), and the Kermit
  300. protocol interpreter (ckcpro.w) and routines (ckcfn*.c).
  301.  
  302. The VOS-specific notes are scattered among the ckl*.txt files (all the files
  303. whose names start with "ckl" are VOS-specific).
  304.  
  305. If you get compilation or linking errors, just send the logs back to:
  306.  
  307.   kermit-support@columbia.edu
  308.  
  309. (The most common cause of errors is "drift" between ckcnet.c and cklnet.c.
  310. At some point in the past this module was split off into separate VOS and
  311. non-VOS versions.  Of course all development goes into the non-VOS file,
  312. so every new feature must also be copied & adapted to the VOS file.  It would
  313. be highly beneficial if somebody could merge the two back together.)
  314.  
  315. Once the binaries have been generated and hexified, we use the following
  316. naming convention for them:
  317.  
  318.   ckl<editnumber>-<arch>-vos<vosreleasenumber>.hex
  319.  
  320. You can also package up all four in their own save.evf.gz files using the
  321. tools on the "unsupported VOS tools FTP site" that Paul Green administers.
  322. Each package contained the .pm files that are made by cklmak.pm, and the
  323. .txt, .hlp, .ksc, and .ini files.
  324.  
  325. It is possible to build binaries for all three platforms on a single machine,
  326. but this requires the Stratus cross-compiler product, which must be purchased
  327. separately from the regular C compiler.
  328.  
  329. VOS differs from platforms like VMS and UNIX in that it is often possible to
  330. run binaries built on a newer system on older systems.  For example, a binary
  331. build on VOS 13.3 or 14.1 might well run on 12.4 on the same kind of hardware
  332. (RISC, CISC, etc).  According to Stratus, 12.4 is the oldest release they
  333. support, but only on platforms that are not supported by newer releases;
  334. 13.3.3 is the oldest release supported on Continuum.
  335.  
  336.  
  337. APPENDIX: VOS HEX FILE FORMAT
  338.  
  339. David Lane, 1994: "The format I came up with is almost only hexifying,
  340. except that if the line is all 0000...000, count it. as you count up and get
  341. to something that isn't nulls, output that as Znn where nn is the hex number
  342. of null lines.  Also, don't split an output record boundary within a Z
  343. record.  A line is 32 bytes, or 64 hex digits.  It works, but it takes
  344. several minutes to use the command macro un-hexifier on the cklxtr.vos file,
  345. but the cklxtr.pm will run it in just a second or two.  These really aren't
  346. "distributable quality" yet, but they do give us a basis for looking at file
  347. formats and converters.  The hex format only processes program modules
  348. correctly, not any of the other file types."
  349.  
  350. (End)
  351.