# *********************************************************************
# soundex.txt: help text
# Copyright (c) 2001,2006 Carlo Strozzi
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 dated June, 1991.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#
# *********************************************************************
# $Id: soundex.txt,v 1.4 2006/03/10 11:26:13 carlo Exp $

                      NoSQL operator: soundex

Computes Knuth's soundex codes for the specified columns.

Usage:
    soundex [options] [column ...]

Options:
    --input (-i) 'file'
      Read input from 'file' instead of STDIN.

    --output (-o) 'file'
      Write output to 'file' instead of STDOUT.

    --help (-h)
      Display this help text.

    --no-header (-N)
      Remove header from output.

    --last (-l)
      If the input table contains duplicated column names
      pick the last occurrence of each. The default is to
      pick the first one. This is sometimes useful after
      the 'jointable' operator.

    --soundex-column (-s) 'name'
      Use 'name' as opposed to the default ``soundex'' as
      the resulting Soundex column name.

    --soundex=n (-Sn)
      Use 'n' as the Soundex code length, as opposed to the default
      length of 4 characters, where 'n' must be between 4 and 10.
      The soundex algorithm used is that of "normal" census type.
      For more info see:
      http://www.creativyst.com/Doc/Articles/SoundEx1/SoundEx1.htm#Algorithm

Notes:

If no columns are listed on the command line, the soundex code is
computed against the leftmost column in the input table.

Soundex codes as computed by this program are based on English
pronunciation. Non-English names may not be soundexed correctly.

