# *********************************************************************
# Original code: indextbl,v 1.13 1994/06/20 10:46:33 hobbs
#
# Adapted to NoSQL by Carlo Strozzi.it>.
#
# indextable.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: indextable.txt,v 1.3 2006/03/10 11:26:13 carlo Exp $

                      NoSQL utility: indextable

Usage:  indextable  [options]  table column [column ...]
        indextable  [options]  --update [index_file  ...]
        indextable  [options]  --allup table    <<< NOT IMPLEMENTED YET

Options:
    --allup (-a)
      Not implemented yet.

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

    --extension (-X) 'string'
      When creating/updating index files do not overwrite the original
      ones but rather create new ones having 'string' appended to their
      names.

    --debug (-x)
      Debug option.

Notes:

The first form of usage of this utility generates an index file for the
column(s) given that refers to the specified table. An index file is
actually another (smaller) table containing only the column(s) given
plus a column for index information. An index file can be used by the
'searchtable' and 'keysearch' operators to quickly locate rows of data
in the referenced table.

Index files are named by appending an '_x' and the column name(s) (each
separated from what precedes by a dot) to the name of the table it refers
to. For example an index file for the table "area" on column "strip" would
be "area._x.strip". An index file that was also on column "depth" would be
"area._x.strip.depth".

The second form of usage of this utility updates the index file(s) given. If
no files are given all index files in the current directory are updated.  An
update of an index file is necessary when the table it refers to has been 
modified.

The third form of usage of this utility updates all index files in the current
directory that refer to the given table.

This operator writes or rewrites table with defined names in the current
directory.

