1[comment {-*- tcl -*- doctools manpage}]
2[manpage_begin soundex n 1.0]
3[keywords knuth]
4[keywords soundex]
5[keywords {text comparison}]
6[keywords {text likeness}]
7[copyright {????, Algorithm: Donald E. Knuth}]
8[copyright {2003, Documentation: Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
9[copyright {1998, Tcl port: Evan Rempel <erempel@uvic.ca>}]
10[moddesc   {Soundex}]
11[titledesc {Soundex}]
12[category  {Hashes, checksums, and encryption}]
13[require Tcl 8.2]
14[require soundex [opt 1.0]]
15[description]
16[para]
17
18This package provides soundex algorithms which allow the
19comparison of words based on their phonetic likeness.
20
21[para]
22
23Currently only an algorithm by Knuth is provided, which
24is tuned to english names and words.
25
26[list_begin definitions]
27
28[call [cmd ::soundex::knuth] [arg string]]
29
30Computes the soundex code of the input [arg string] using
31Knuth's algorithm and returns it as the result of the
32command.
33
34[list_end]
35
36[section EXAMPLES]
37
38[example {
39    % ::soundex::knuth Knuth
40    K530
41}]
42
43[vset CATEGORY soundex]
44[include ../common-text/feedback.inc]
45[manpage_end]
46