home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / forut062.zip / ForUtil-0.62 / man / doc / ffscan.txt < prev    next >
Text File  |  1996-08-28  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4. FFSCAN(1)             ForUtil Fortran Tools             FFSCAN(1)
  5.  
  6.  
  7. NAME
  8.        ffscan - checks argument count for fortran f77 files
  9.  
  10. SYNOPSIS
  11.        ffscan [-fhnqv] -Eext -Idir -ofile -xname [files]
  12.  
  13.  
  14. DESCRIPTION
  15.        ffscan  scans a collection of fortran files and checks the
  16.        argument counts of every call made against its definition.
  17.        When a mismatch occurs, ffscan will tell you in which file
  18.        this particular call is made, and it will also  tell  what
  19.        the  correct  number of arguments should be, together with
  20.        the name of the file where the subroutine in question  can
  21.        be  found.   ffscan  does  not do any type checking on the
  22.        arguments, it simply counts them.
  23.  
  24. OPTIONS
  25.        -f     Include the full path of files in the  output.  The
  26.               default  is  to  print  the  name of the file only.
  27.               Using this option increases the memory ffscan  uses
  28.               to  store  its  data,  so it might be unwise to use
  29.               this option on msdos systems with their 640kb  mem-
  30.               ory limit.
  31.  
  32.  
  33.        -h, --help
  34.               print a short help describing the options.
  35.  
  36.  
  37.        -n, -n-
  38.               Using  this  option  will cause ffscan to tell what
  39.               subroutines are never invoked.
  40.  
  41.  
  42.        -q     be really quiet (usefull if called from a  script).
  43.               Only  error  messages and the final results will be
  44.               shown.
  45.  
  46.  
  47.        -v     Be verbose. Adding more -v to the command line will
  48.               increase the output ffscan will generate.
  49.  
  50.               Using  -v  will  show  some statistics of the files
  51.               being scanned such as the number of subroutines and
  52.               functions defined in a file and the number of calls
  53.               made.  If you use the -ofile option, these  statis-
  54.               tics will also be placed in file
  55.  
  56.               Using -vv will, in addition to the output mentioned
  57.               above, cause ffscan to report all  settings  it  is
  58.               using to determine what files it has to scan.
  59.  
  60.               When  you  use -vvv ffscan will tell you what it is
  61.  
  62.  
  63.  
  64. Linux                      August 1996                          1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. FFSCAN(1)             ForUtil Fortran Tools             FFSCAN(1)
  71.  
  72.  
  73.               scanning from your files, this in addition  to  the
  74.               output mentioned above.  For each subroutine, func-
  75.               tion or call it encounters, ffscan  will  tell  you
  76.               what  the name of that routine is and the arguments
  77.               detected. It will also tell you how many  arguments
  78.               there  are.  A  number  called  brace count is also
  79.               shown. This number should  always  be  zero.  Using
  80.               this  option  can generate a considerable amount of
  81.               output, so you might wish to pipe it to a file.
  82.  
  83.               At the end of a run ffscan will also give  a  count
  84.               for  the  total number of subroutines and functions
  85.               found.
  86.  
  87.  
  88.        --version
  89.               Show the version number of ffscan
  90.  
  91.  
  92.        -Eext  Extensions ffscan must use to determine which files
  93.               it  has  to  scan. Up to eight -E are allowed.  The
  94.               default extension is .f
  95.  
  96.  
  97.        -Idir  Using this option tells ffscan which directories it
  98.               has  to  search for f77 files. Only the contents of
  99.               that  directory  are  scanned.  Subdirectories  are
  100.               ignored.  Up to 64 -I are allowed.
  101.  
  102.  
  103.        -ofile file in which to store the results of the scan. The
  104.               default is stdout.
  105.  
  106.  
  107.        -xname Tells ffscan to exclude the named file  when  scan-
  108.               ning the files found with the -I -E options.  Up to
  109.               64 -x are allowed.
  110.  
  111.  
  112. DIAGNOSTICS
  113.        The following warning messages can occur:
  114.  
  115.        WARNING: unbalanced right brace
  116.  
  117.        WARNING: unbalanced left brace
  118.               When one of these warnings occur, you have a  brace
  119.               to  many or a missing brace in the argument list of
  120.               a subroutine or function definition or in the argu-
  121.               ment list of a call.
  122.  
  123.        WARNING: more than 19 contination lines
  124.               ffscan has detected more than 19 successive contin-
  125.               uation lines in a argument declaration.
  126.  
  127.  
  128.  
  129.  
  130. Linux                      August 1996                          2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. FFSCAN(1)             ForUtil Fortran Tools             FFSCAN(1)
  137.  
  138.  
  139.        WARNING: no program entry point found
  140.               a call statement was encountered before  a  PROGRAM
  141.               statement  was  found.  ffscan will use the name of
  142.               the file where this warning  occurs  as  a  program
  143.               name and continue.
  144.  
  145.        ffscan  will always tell you in which file and around what
  146.        line these warnings occur.
  147.  
  148.  
  149. DISTRIBUTION POLICY
  150.        All utilities in  this  fortran  utility  suite  are  dis-
  151.        tributed under the GNU Public License.
  152.  
  153.  
  154. COMPATIBILITY
  155.        ffscan  has  run under HP-UX 9 and 10, SGI IRIX 5.2 & 5.3,
  156.        DEC OSF1, SunOs 4.1 and 4.3, Cray Unicos, IBM  AIX  3.2  &
  157.        4.1,  Linux  and MSDOS 6.2.  ffscan also runs in a dos box
  158.        under Windows 3.1, 3.11 and Win95.
  159.  
  160.  
  161. SHORTCOMINGS
  162.        Currently, ffscan only looks at CALL, so although FUNCTION
  163.        is found, these are not checked.
  164.  
  165.  
  166. BUGS
  167.        The  MS-DOS  versions  of  these  tools can cause problems
  168.        under MS-DOS if you feed them with a large  collection  of
  169.        files,  few  files with a lot of calls or a combination of
  170.        both. This is totally due to the 640kb memory limit MS-DOS
  171.        has.
  172.  
  173.        If  you  think you have found a bug, you can send email to
  174.        the author, describing what the bug is, how you  generated
  175.        it  and if you can reproduce it. Also specify the platform
  176.        where this bug occured.
  177.  
  178.  
  179. AUTHOR
  180.        Koen D'Hondt
  181.        ripley@xs4all.nl
  182.        (C)Copyright 1995-1996 by Ripley Software Development
  183.  
  184.  
  185. SEE ALSO
  186.        fflow(1),   ftags(1),   scan_commons(1),    get_common(1),
  187.        list_commons(1)
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. Linux                      August 1996                          3
  197.  
  198.  
  199.