# *********************************************************************
# istable.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: istable.txt,v 1.6 2006/03/10 11:26:13 carlo Exp $

                      NoSQL operator: istable

Checks that a file is a valid NoSQL table.

Usage: istable [options]

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

    --verbose (-v)
      Set verbose reporting.

    --skip-header (-n)
      Do not include the table header in the failing row number.
      Only useful together with '-v'.

    --edit (-E)
      Used by the 'edit*' operators.

    --echo (-e)
      Print the input table to STDOUT.

    --no-header (-N)
      Suppress header from output. Only useful together with '-e'.

    --allow-duplicates (-a)
      Allow duplicated column names.

    --relaxed (-r)
      Allow column names beginning with an underscore '_'.
      Implies '-a'.

    --really-relaxed (-R)
      Allow records that are shorter/longer than the header, which
      are to be considered badly broken for most other NoSQL operators
      except a few very forgiving ones, like 'listtotable' and
      'updtable'. Implies '-a' and '-r'.

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

Notes:

This NoSQL operator reads a file from STDIN and returns an exit
code equal 0 if the file is a valid table and 255 otherwise.
If option '-n' is specified (together with option 'v'), then the
failing row number(s) will not include the header, i.e. it will be the
failing row number - 2.

