Adwaith-Rajesh/gperf
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/gperf.git synced 2025-12-02 13:09:22 +00:00
Code Activity

* doc/gperf.texi (UPDATED): Correct to be today.

Browse Source 
* doc: Regenerated by doing make in a configured tree.
	Requires makeinfo, texi2dvi, texi2pdf, and texi2html.
This commit is contained in:
Brendan Kehoe
2006-01-13 15:37:02 +00:00
parent 2f5b580a54
commit a35e3ca3f1
15 changed files with 590 additions and 522 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
doc/gperf_6.html
View File

@@ -1,15 +1,16 @@
<HTML>
<HEAD>
<!-- Created by texi2html 1.56k from gperf.texi on 12 June 2003 -->
<!-- This HTML file has been created by texi2html 1.52
from gperf.texi on 13 January 2006 -->
<TITLE>Perfect Hash Function Generator - 4. Invoking gperf</TITLE>
<TITLE>Perfect Hash Function Generator - 4 Invoking gperf</TITLE>
</HEAD>
<BODY>
Go to the <A HREF="gperf_1.html">first</A>, <A HREF="gperf_5.html">previous</A>, <A HREF="gperf_7.html">next</A>, <A HREF="gperf_10.html">last</A> section, <A HREF="gperf_toc.html">table of contents</A>.
<P><HR><P>
<H1><A NAME="SEC18" HREF="gperf_toc.html#TOC18">4. Invoking <CODE>gperf</CODE></A></H1>
<H1><A NAME="SEC18" HREF="gperf_toc.html#TOC18">4 Invoking <CODE>gperf</CODE></A></H1>
<P>
There are <EM>many</EM> options to <CODE>gperf</CODE>. They were added to make
@@ -17,10 +18,11 @@ the program more convenient for use with real applications. "On-line"
help is readily available via the <SAMP>`--help'</SAMP> option. Here is the
complete list of options.
</P>
<H2><A NAME="SEC19" HREF="gperf_toc.html#TOC19">4.1 Specifying the Location of the Output File</A></H2>
<H2><A NAME="SEC19" HREF="gperf_toc.html#TOC19">4.1 Specifying the Location of the Output File</A></H2>
<DL COMPACT>
@@ -33,23 +35,23 @@ Allows you to specify the name of the file to which the output is written to.
The results are written to standard output if no output file is specified
or if it is <SAMP>`-'</SAMP>.
</P>
<H2><A NAME="SEC20" HREF="gperf_toc.html#TOC20">4.2 Options that affect Interpretation of the Input File</A></H2>
<H2><A NAME="SEC20" HREF="gperf_toc.html#TOC20">4.2 Options that affect Interpretation of the Input File</A></H2>
<P>
These options are also available as declarations in the input file
(see section <A HREF="gperf_5.html#SEC11">3.1.1.2 Gperf Declarations</A>).
(see section <A HREF="gperf_5.html#SEC11">3.1.1.2 Gperf Declarations</A>).
</P>
<DL COMPACT>
<DT><SAMP>`-e <VAR>keyword-delimiter-list</VAR>'</SAMP>
<DD>
<DT><SAMP>`--delimiters=<VAR>keyword-delimiter-list</VAR>'</SAMP>
<DD>
<A NAME="IDX38"></A>
<A NAME="IDX39"></A>
Allows you to provide a string containing delimiters used to
separate keywords from their attributes. The default is ",". This
option is essential if you want to use keywords that have embedded
@@ -82,13 +84,13 @@ the <CODE>gperf</CODE> generated function.
<H2><A NAME="SEC21" HREF="gperf_toc.html#TOC21">4.3 Options to specify the Language for the Output Code</A></H2>
<H2><A NAME="SEC21" HREF="gperf_toc.html#TOC21">4.3 Options to specify the Language for the Output Code</A></H2>
<P>
These options are also available as declarations in the input file
(see section <A HREF="gperf_5.html#SEC11">3.1.1.2 Gperf Declarations</A>).
(see section <A HREF="gperf_5.html#SEC11">3.1.1.2 Gperf Declarations</A>).
</P>
<DL COMPACT>
<DT><SAMP>`-L <VAR>generated-language-name</VAR>'</SAMP>
@@ -136,20 +138,20 @@ This option is supported for compatibility with previous releases of
<H2><A NAME="SEC22" HREF="gperf_toc.html#TOC22">4.4 Options for fine tuning Details in the Output Code</A></H2>
<H2><A NAME="SEC22" HREF="gperf_toc.html#TOC22">4.4 Options for fine tuning Details in the Output Code</A></H2>
<P>
Most of these options are also available as declarations in the input file
(see section <A HREF="gperf_5.html#SEC11">3.1.1.2 Gperf Declarations</A>).
(see section <A HREF="gperf_5.html#SEC11">3.1.1.2 Gperf Declarations</A>).
</P>
<DL COMPACT>
<DT><SAMP>`-K <VAR>slot-name</VAR>'</SAMP>
<DD>
<DT><SAMP>`--slot-name=<VAR>slot-name</VAR>'</SAMP>
<DD>
<A NAME="IDX39"></A>
<A NAME="IDX40"></A>
This option is only useful when option <SAMP>`-t'</SAMP> (or, equivalently, the
<SAMP>`%struct-type'</SAMP> declaration) has been given.
By default, the program assumes the structure component identifier for
@@ -161,7 +163,7 @@ field in your supplied <CODE>struct</CODE>.
<DD>
<DT><SAMP>`--initializer-suffix=<VAR>initializers</VAR>'</SAMP>
<DD>
<A NAME="IDX40"></A>
<A NAME="IDX41"></A>
This option is only useful when option <SAMP>`-t'</SAMP> (or, equivalently, the
<SAMP>`%struct-type'</SAMP> declaration) has been given.
It permits to specify initializers for the structure members following
@@ -189,7 +191,7 @@ generated hash functions to be used in the same application.
<DD>
<DT><SAMP>`--class-name=<VAR>class-name</VAR>'</SAMP>
<DD>
<A NAME="IDX41"></A>
<A NAME="IDX42"></A>
This option is only useful when option <SAMP>`-L C++'</SAMP> (or, equivalently,
the <SAMP>`%language=C++'</SAMP> declaration) has been given. It
allows you to specify the name of generated C++ class. Default name is
@@ -213,7 +215,7 @@ to support 8-bit and multibyte characters.
<DT><SAMP>`--compare-lengths'</SAMP>
<DD>
Compare keyword lengths before trying a string comparison. This option
is mandatory for binary comparisons (see section <A HREF="gperf_5.html#SEC17">3.3 Use of NUL bytes</A>). It also might
is mandatory for binary comparisons (see section <A HREF="gperf_5.html#SEC17">3.3 Use of NUL bytes</A>). It also might
cut down on the number of string comparisons made during the lookup, since
keywords with different lengths are never compared via <CODE>strcmp</CODE>.
However, using <SAMP>`-l'</SAMP> might greatly increase the size of the
@@ -295,17 +297,25 @@ of one more test-and-branch instruction at run time.
<DD>
<DT><SAMP>`--word-array-name=<VAR>hash-table-array-name</VAR>'</SAMP>
<DD>
<A NAME="IDX42"></A>
<A NAME="IDX43"></A>
Allows you to specify the name for the generated array containing the
hash table. Default name is <SAMP>`wordlist'</SAMP>. This option permits the
use of two hash tables in the same file, even when the option <SAMP>`-G'</SAMP>
(or, equivalently, the <SAMP>`%global-table'</SAMP> declaration) is given.
<DT><SAMP>`--length-table-name=<VAR>length-table-array-name</VAR>'</SAMP>
<DD>
<A NAME="IDX44"></A>
Allows you to specify the name for the generated array containing the
length table. Default name is <SAMP>`lengthtable'</SAMP>. This option permits the
use of two length tables in the same file, even when the option <SAMP>`-G'</SAMP>
(or, equivalently, the <SAMP>`%global-table'</SAMP> declaration) is given.
<DT><SAMP>`-S <VAR>total-switch-statements</VAR>'</SAMP>
<DD>
<DT><SAMP>`--switch=<VAR>total-switch-statements</VAR>'</SAMP>
<DD>
<A NAME="IDX43"></A>
<A NAME="IDX45"></A>
Causes the generated C code to use a <CODE>switch</CODE> statement scheme,
rather than an array lookup table. This can lead to a reduction in both
time and space requirements for some input files. The argument to this
@@ -331,7 +341,7 @@ This option is supported for compatibility with previous releases of
<H2><A NAME="SEC23" HREF="gperf_toc.html#TOC23">4.5 Options for changing the Algorithms employed by <CODE>gperf</CODE></A></H2>
<H2><A NAME="SEC23" HREF="gperf_toc.html#TOC23">4.5 Options for changing the Algorithms employed by <CODE>gperf</CODE></A></H2>
<DL COMPACT>
@@ -365,7 +375,7 @@ through a search that minimizes the number of byte positions.
<DD>
<DT><SAMP>`--duplicates'</SAMP>
<DD>
<A NAME="IDX44"></A>
<A NAME="IDX46"></A>
Handle keywords whose selected byte sets hash to duplicate values.
Duplicate hash values can occur if a set of keywords has the same names, but
possesses different attributes, or if the selected byte positions are not well
@@ -402,7 +412,7 @@ option is not particularly useful when <SAMP>`-S'</SAMP> (or, equivalently,
<DD>
<DT><SAMP>`--jump=<VAR>jump-value</VAR>'</SAMP>
<DD>
<A NAME="IDX45"></A>
<A NAME="IDX47"></A>
Affects the "jump value", i.e., how far to advance the associated
byte value upon collisions. <VAR>Jump-value</VAR> is rounded up to an
odd number, the default is 5. If the <VAR>jump-value</VAR> is 0 <CODE>gperf</CODE>
@@ -456,7 +466,7 @@ heuristic.
<H2><A NAME="SEC24" HREF="gperf_toc.html#TOC24">4.6 Informative Output</A></H2>
<H2><A NAME="SEC24" HREF="gperf_toc.html#TOC24">4.6 Informative Output</A></H2>
<DL COMPACT>