# *********************************************************************
# Written by and copyright Carlo Strozzi <carlos@linux.it>.
#
# soundex.txt: help text
# Copyright (C) 2001-2002 Carlo Strozzi <carlos@linux.it>
#
# 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; either version 2 of the License, or
# (at your option) any later version.
#
# 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.2 2003/03/17 10:10:45 carlo Exp $

                      NoSQL operator: soundex

Computes Knuth's soundex codes for the specified columns.

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.

Notes:

Part of this code has been freely adapted from examples provided in
the book "Unix Relational Database Management", so credits are due
to the original authors.

