10 .TH unihash-mkstatic 1 "14 December 2003" "Straylight/Edgeware" "mLib utilities library"
12 unihash-mkstatic \- construct tables for universal hashing
31 program constructs tables for efficient universal hashing (see
33 It will produce the table as either an array defined in a C source file
34 or as an initializer macro defined in a C header file.
36 The program accepts no non-option arguments. The options are as
40 Print a help message to standard output and exit successfully.
43 Print the program's version number to standard output and exit
47 Print a one-line usage summary to standard output and exit successfully.
49 .B "\-c, \-\-c-source"
50 Produce a C source file which exports a symbol naming the array, instead
53 .BI "\-s, \-\-symbol=" symbol
56 This is the name of the macro defined by a header file, or the array
57 exported by a C source. The default macro name is
59 the default array name is
62 .BI "\-i, \-\-include=" header
63 Request that generated C source include the named
69 .BI " #include """ header """"
72 at the top of the generated C source. The default is not to include
73 .BR <mLib/unihash.h> ,
74 which is necessary to declare the
76 type. This option does nothing without the
80 .BI "\-g, \-\-guard=" macro
83 as a guard against multiple inclusion of the generated header file.
84 Inserts a pair of lines of the form
91 at the top of the generated header, and a line
97 at the end. The default guard macro name is built from the output file
100 by uppercasing all alphabetic characters in the name and replacing
101 nonalphanumeric characters by underscores
103 This option does nothing with the
107 .BI "\-k, \-\-key=" key
108 Specifies the hashing key as an integer. Note that if you want to
109 specify the key in hexadecimal, you must prefix it with
113 which is, as far as the author knows, as good as any other fixed value.
119 Mark Wooding, <mdw@distorted.org.uk>