fips/tools/README

   1 FIPS tools explained
   2 ====================
   3
   4 api_list.pl
   5     a script to produce an API description, saying what parameters are
   6     for input, output or both.
   7
   8     Most often, the direction of a parameter is determined automatically.
   9     However, quite a number of them are educated guesses.  Either way,
  10     the information is stored in the file declarations.dat in this
  11     directory, and can be manually corrected; simply go through
  12     declarations.dat, look for any value with the key 'direction'
  13     where the value contains a question mark.  Those should be changed
  14     to whatever is true, and the values should be one of the
  15     following:
  16
  17         <-      output
  18         ->      input
  19         <->     both
  20
  21 api_fns.pm
  22     a module that helps api_list.pl do its job.
  23
  24 declarations.dat
  25     a file of information about public fips symbols.  See api_list.pl
  26     above.