Merge from vendor branch CVS:
[dragonfly.git] / contrib / gperf / README
1 This is GNU gperf. It is a program that generates perfect hash
2 functions for sets of key words.  A perfect hash function is:
3
4           A hash function and a data structure that allows 
5           recognition of a key word in a set of words using 
6           exactly 1 probe into the data structure.
7
8 The doc/gperf.html file explains how the program works, the form of
9 the input, what options are available, and hints on choosing the best
10 options for particular key words set.
11
12 See the file NEWS for a list of major changes in the current release.
13
14 See the file INSTALL for compilation and installation instructions.
15
16 Output from the GPERF program is used to recognize reserved words in
17 the GNU C, GNU C++, and GNU Pascal compilers, as well as with the GNU
18 indent program.
19
20 For general documentation on the coding and usage standards
21 this distribution follows, see the GNU standards document
22 ftp://ftp.gnu.org/pub/gnu/standards.*, especially the 'Makefile
23 Conventions', 'Configuration', and 'User Interfaces' sections.
24
25 Mail suggestions and bug reports to both <bug-gnu-utils@gnu.org> and
26 <gperf-bugs@lists.sourceforge.net>.  When reporting bugs, please
27 include in the subject line the package name and version (output of
28 'gperf --version') for which you found a problem.
29