home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / FTNCHEKA.ZIP / README < prev    next >
Text File  |  1993-02-01  |  6KB  |  170 lines
  1.    README file for Ftnchek Version 2.6.1
  2.  
  3. Author: Robert Moniot
  4.     Fordham University
  5.     New York, NY  10023  USA
  6.     Telephone: (212) 636-6331
  7.     Bitnet:    MONIOT@FORDMULC
  8.     Internet:  moniot@mary.fordham.edu
  9.  
  10. Date:    January 1993
  11.  
  12. Ftnchek is written in a portable style of C.  You must have a C
  13. compiler for the machine on which you wish to run the program.
  14.  
  15. If the file you received is in the form of a "sh archive" or "shar"
  16. file, and you received it by electronic mail, you should first
  17. concatenate all parts in order (if it was sent in pieces), removing
  18. any mail headers.  If you received it by ftp, this step should not be
  19. necessary.  Next, if you have a UNIX system, simply feed it as input
  20. to the program "sh" to unpack it automatically.  If you do not have a
  21. UNIX system, you will have to use your text editor to clip out each
  22. file manually.  You will observe that each line of every file has been
  23. prefixed with the letter X, and all tabs have been converted to the
  24. grave accent (ASCII code 60 hexadecimal).  This was done to prevent
  25. clobbering during shipment across network gateways.  You should use
  26. your editor to remove all initial X's and to change all grave accents
  27. to tabs.
  28.  
  29. If the file you received is a Unix compressed tar file, you should
  30. first unzip it using the Unix "uncompress" command, and then give it
  31. as input to "tar" to unpack the files.  For example, assuming the file
  32. has been placed in the desired directory, and is named ftnchek.tar.Z, you
  33. would give the two Unix commands
  34.     uncompress ftnchek.tar.Z
  35.     tar -xf ftnchek.tar
  36.  
  37. After accomplishing this step, you should find that you have received
  38. the following set of source files:
  39.  
  40.         ftnchek.c       intrins.h       symtab.h
  41.         ftnchek.h       iokeywds.h      symtab2.c
  42.         forlex.c        prsymtab.c      tokdefs.h
  43.         fortran.c       symtab.c
  44.  
  45. You should also have received the following auxiliary files:
  46.  
  47.         average.f     build.com     makefile       makefile.mpw
  48.         average.out   fortran.y     makefile.tc
  49.  
  50. Documentation is in the files:
  51.  
  52.         ftnchek.doc   ftnchek.hlp   ftnchek.man   ftnchek.ps
  53.  
  54. The first is a flat text file.  Ftnchek.hlp is for making a help
  55. library for VMS systems.  Ftnchek.man and ftnchek.ps are provided for
  56. the convenience of those with access to nroff/troff or PostScript,
  57. respectively.
  58.  
  59.  
  60. VAX/VMS users should rename "AVERAGE.F" to "AVERAGE.FOR".
  61. Once Ftnchek is working, you can test it by giving the command:
  62.  
  63.         $ ftnchek -list -sym average
  64.  
  65. Then compare the output against the file "average.out".  (Tabs and
  66. trailing blanks have been removed from average.out due to shipping the
  67. Ftnchek package across network gateways.)
  68.  
  69. To install Ftnchek, follow the instructions below for your operating
  70. system.
  71.  
  72.  
  73. (1) Unix
  74.  
  75.    Give the command:
  76.  
  77.         $ make
  78.  
  79. Note: System-specific compilation options are provided for some
  80. systems.  Users installing Ftnchek on one of these systems should
  81. say "make system_name" where system_name is one of the following
  82. words:
  83.  
  84.         IBM-RS6000        SUNOS4.0
  85.         GENERIC           SUNOS4.1
  86.         STARDENT          ULTRIX-MIPS
  87.  
  88. Also, see the makefile for options that allow compiling with bigger
  89. table sizes or accepting/rejecting certain syntax extensions.
  90.  
  91.  
  92. (2) VAX/VMS
  93.  
  94.    Give the command
  95.  
  96.         $ @BUILD
  97.  
  98.    After the program has been compiled, you must turn it into a
  99.    so-called "DCL foreign command" so that it can be invoked by
  100.    giving its name on a command line, instead of using the RUN
  101.    command.  Do this with the command
  102.  
  103.         $ FTNCHEK :== $disk:[directory]FTNCHEK
  104.  
  105.    where you substitute the disk and directory names where the file
  106.    FTNCHEK.EXE resides.  This command must be executed once per
  107.    login.  It is suggested you put this command into your LOGIN.COM
  108.    file.
  109.  
  110.    The BUILD procedure also creates a VMS help library named
  111.    FTNCHEK.HLB.  To access it from the VMS HELP command, you must
  112.    give the command
  113.  
  114.         $ DEFINE HLP$LIBRARY disk:[directory]FTNCHEK.HLB"
  115.  
  116.    Again, this command must be executed once per login to have effect.
  117.  
  118.  
  119. (3) MS-DOS with Turbo C
  120.  
  121.    Rename the file "makefile.tc" to "makefile" and then give the
  122.    command:
  123.  
  124.         C> MAKE
  125.  
  126.  
  127. (4) Macintosh Programmer's Workshop (MPW)
  128.  
  129.    Rename the file "makefile.mpw" to "makefile".  Edit the file,
  130.    changing character '+' to CHAR(182), option-d on the Macintosh
  131.    keyboard; and the character '/' to CHAR(196), option-f.  Then
  132.    use the "make" command to create Ftnchek.
  133.  
  134. (5) Other systems
  135.  
  136.    It should suffice simply to compile all the ".c" files and link
  137.    them.  The only differences among the versions for different
  138.    operating systems have to do with the use of "/" vs. "-" as an
  139.    option prefix, and the default filename extension ".FOR" vs. ".f".
  140.    Selection among these options is done by defining a macro name for
  141.    each system.  The VAX/VMS compiler pre-defines the macro name
  142.    "VMS", while the Turbo C compiler pre-defines "__TURBOC__".
  143.    Compilation without defining either of these macro names is the
  144.    same as compiling with "UNIX" defined.
  145.  
  146.    To allow "/" as an option prefix, you can define the macro name
  147.    "VMS", either as a commandline option to the compiler, or by
  148.    altering the file ftnchek.h: just remove the commenting-out of
  149.    the appropriate #define command found there.  In any case, "-" is
  150.    always allowed as an option prefix.
  151.  
  152.    The default extension ".FOR" is assumed for VMS or Turbo C, ".f"
  153.    for all others, unless you define the macro name
  154.    "DEF_SRC_EXTENSION" otherwise on the compiler commandline or in
  155.    ftnchek.h.  Other default values of Ftnchek's built-in parameters
  156.    can be similarly modified on the compiler commandline.  See
  157.    ftnchek.h for details.
  158.  
  159.    If your Fortran compiler supports many of the common I/O extensions
  160.    found in VAX Fortran, you can compile the source using the compiler
  161.    flag -DVMS_IO to cause Ftnchek to accept these extensions without
  162.    assuming all other the VAX Fortran extensions and conventions.  The
  163.    VAX I/O extensions include, for instance several additional control
  164.    keywords for the OPEN statement, such as CARRIAGECONTROL, READONLY,
  165.    etc.
  166.  
  167.  
  168.  
  169.  
  170.