home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / fchk294s.zip / ftnchek-2.9.4 / INSTALL < prev    next >
Text File  |  1996-09-29  |  7KB  |  177 lines
  1.               INSTALLING FTNCHEK
  2.  
  3. To install ftnchek, follow the instructions below for your operating
  4. system.  If you wish, you may refer to the README file, in the section
  5. ``CUSTOMIZING'' for options that allow compiling with bigger table
  6. sizes or accepting/rejecting certain syntax extensions.  However, the
  7. default compilation options are generally satisfactory.
  8.  
  9.  
  10. (1) UNIX and UNIX-like systems
  11.  
  12. Configure a Makefile for your system with the command:
  13.  
  14.         $ ./configure
  15.  
  16. This uses the file Makefile.in as a template.  If you want to change
  17. some options, edit the file Makefile.in, not Makefile, and re-run
  18. configure.
  19.  
  20. Next, build ftnchek with the command:
  21.  
  22.     $ make
  23.  
  24. To verify correct operation of the newly created ftnchek, you can
  25. now issue the command
  26.  
  27.     $ make check
  28.  
  29. This will run ftnchek on the suite of test programs in the
  30. subdirectory ``test'' and report on any discrepancies.
  31.  
  32. Once ftnchek is working properly, issue the command (requiring
  33. super-user authority):
  34.  
  35.     $ make install
  36.  
  37. This will install the executable in /usr/local/bin and the manpage in
  38. /usr/local/man by default.  (On SGI the manpage gets specialized
  39. treatment--see the makefile.)  If you do not wish to install the
  40. manpage but only the executable, use instead
  41.  
  42.     $ make install-exe
  43.  
  44.  
  45.  
  46. (2a) VMS on DEC VAX
  47.  
  48.    Give the command
  49.  
  50.         $ @BUILD
  51.  
  52.    After the program has been compiled, you must turn it into a
  53.    so-called "DCL foreign command" so that it can be invoked by
  54.    giving its name on a command line, instead of using the RUN
  55.    command.  Do this with the command
  56.  
  57.         $ FTNCHEK :== $disk:[directory]FTNCHEK
  58.  
  59.    where you substitute the disk and directory names where the file
  60.    FTNCHEK.EXE resides.  This command must be executed once per
  61.    login.  It is suggested you put this command into your LOGIN.COM
  62.    file.
  63.  
  64.    The BUILD procedure also creates a VMS help library named
  65.    FTNCHEK.HLB.  To access it from the VMS HELP command, you must
  66.    give the command
  67.  
  68.         $ DEFINE HLP$LIBRARY disk:[directory]FTNCHEK.HLB"
  69.  
  70.    Again, this command must be executed once per login to have effect.
  71.  
  72.    Note that BUILD.COM uses the files CC.COM and LINK.COM which are
  73.    conditional compilation and link scripts that allow re-making
  74.    ftnchek by compiling only what has changed.
  75.  
  76. (2b) VMS on DEC ALPHA
  77.  
  78.    Same as (2a) except use BUILD-ALPHA.COM instead.
  79.  
  80.  
  81. (3) MS-DOS with Borland C
  82.  
  83.    Rename the file "makefile.bc" to "makefile" and then give the
  84.    command:
  85.  
  86.         C> MAKE
  87.  
  88.    Note: This makefile has not been updated lately and may not work
  89.    with recent releases of Borland C.  I only have an old version of
  90.    this compiler.  Also, ftnchek version 2.9 has a large appetite for
  91.    dynamically allocated memory.  This means that 16-bit 80x86 code,
  92.    which is limited to 64KB data segments, will soon run out of memory
  93.    when analyzing moderate-sized programs.  Therefore it is best to
  94.    compile ftnchek to 32-bit code.  I hear that Borland C now supports
  95.    32-bit code, but I have not been able to update the makefile to
  96.    take advantage of it.  I would welcome the contribution of an
  97.    updated version of makefile.bc.
  98.  
  99.  
  100. (4) Macintosh Programmer's Workshop (MPW)
  101.  
  102.    Rename the file "makefile.mpw" to "makefile".  Edit the file,
  103.    changing character '+' to CHAR(182), option-d on the Macintosh
  104.    keyboard; and the character '/' to CHAR(196), option-f.  Then
  105.    use the "make" command to create Ftnchek.
  106.  
  107.  
  108. (5) OS/2 with gcc
  109.  
  110.    Rename the file "makefile.os2" to "makefile" and then run make.
  111.  
  112.    If you have installed the GNU utility "sed", you can customize the
  113.    makefile for your system.  Give the command:
  114.  
  115.          configure_os2
  116.  
  117.    This will create a new version of makefile.os2 with appropriate
  118.    values for your system.  You should rename it "makefile" and then
  119.    run make.  Configure_os2 also builds an OS/2 version of the dcl2inc
  120.    script that is configured for your system.  Many thanks to Jan
  121.    Ftacnik, Stefan A. Deutscher and Christian Bartels for producing
  122.    and improving this configuration script.
  123.  
  124. (6a) Other systems having "make" utility
  125.  
  126.    Rename the file "makefile.generic" to "makefile", edit it
  127.    appropriately for your system, and run make.
  128.  
  129.  
  130. (6b) Other systems not having "make" utility
  131.  
  132.    It should suffice simply to compile all the ".c" files (omitting
  133.    shell_mung.c -- it is only for VMS) and link them.  The only
  134.    differences among the versions for different operating systems have
  135.    to do with:
  136.          -- the use of "/" vs. "-" as a command-line option prefix.
  137.             Define the macro name OPTION_PREFIX_SLASH if "/" is to be
  138.             accepted as an alternate to "-".  (No particular value
  139.             need be assigned to this macro, just define it.)  The "-"
  140.             prefix is always accepted.  NOTE: do not define this macro
  141.             if your system uses the "/" character as a delimiter in
  142.             path names.  Doing so will introduce ambiguities in the
  143.             command-line arguments.
  144.          -- the default filename extension ".for" vs. ".f".  Define
  145.             the macro name DEF_SRC_EXTENSION to the string value
  146.             corresponding to Fortran source files on your system.
  147.          -- the default home directory in which to search for
  148.             .ftnchekrc or ftnchek.ini.  Define SPECIAL_HOMEDIR to the
  149.             string value appropriate for your system.
  150.          -- the default systemwide directory in which to search for
  151.             include-files.  Define the macro DEFAULT_INCLUDE_DIR to
  152.             the string value of this directory.
  153.    These macros are all defined automatically to appropriate values
  154.    for Unix, VMS, and MSDOS systems.  You only need to define them by
  155.    hand if compiling ftnchek on other systems.
  156.  
  157.    If your compiler does not accept modern C syntax for function
  158.    prototypes, define the macro NO_PROTOTYPES.
  159.  
  160.  
  161. Once ftnchek is working, you can test it by giving the command:
  162.  
  163.         $ ftnchek -list -sym average
  164.  
  165. Then compare the output against the file ``average.out''.  A more
  166. thorough checkout is possible on Unix systems by giving the ``make
  167. check'' command described above.
  168.  
  169.  
  170. It has been reported that ftnchek gives parse errors on file average.f
  171. on a Cray Y-MP running UNICOS 8.0 3.0 and SCC 4.0.1. This can be
  172. worked around by creating a new version of fortran.c from fortran.y
  173. using yacc (not bison) on another platform (e.g. IBM/RS6000; the Cray
  174. yacc gave up).  The command to do this is ``rm fortran.c; make
  175. fortran.c''.  Use this version of fortran.c to build ftnchek on the
  176. Cray.
  177.