# *********************************************************************
# edittable.txt: help text
#
# Copyright (c) 2001,2007 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: edittable.txt 41 2007-09-24 08:12:42Z carlo $

                      NoSQL utility: edittable

NoSQL trivial table editor.

Usage: edittable [options] tablename

Options:
    --list (-l)
      Convert the table into 'list' format before editing.
      Useful with tables that contain rows wider than the
      available screen. The table is then automatically
      converted back to the usual format when editing is
      complete.

    --no-lock (-L)
      Do not lock the target file before editing. This should
      be used with caution, but it may be useful to call the
      'edittable' utility from within other programs that do
      their own locking.

    --add-record (-a)
      Append a new empty record to the table being edited. Unless
      '-l' is also specified, non-TABs in the new record will be
      replaced by '#' signs, to help the user entering the new data
      without overwriting the column delimiters.

    --no-sort (-n)
      By default the table is kept sorted on its leftmost column,
      this option prevents that.

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

Notes:

Invokes whatever editor is defined in the EDITOR environment variable,
defaulting to vi(1) if the variable is unset. The editor should either
be vi(1) or one of its many compatible clones, like elvis(1), vim(1),
nvi(1), and so on.

Make sure not to break the table structure while editing, like removing
the dashline, removing the '|' delimiters or adding extra ones, or
by not respecting the list specification when editing in list format.
Upon leaving the editor, this program will try and check for a broken
table structure and prompt for corrections, but those checks aren't
bullet-proof and your mileage may vary.

