# *********************************************************************
#  Written by and copyright Carlo Strozzi <carlos@linux.it>.
#
#  envtotable.txt: help text
#  Copyright (C) 2001 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.
#
# *********************************************************************

                      NoSQL operator: envtotable

Converts environment variables into a NoSQL table.

Usage: envtotable [options]

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

    --match (-m) 'pattern'
      Include only those variables whose *names* match the
      given regular expression. 'pattern' must be a valid
      mawk(1) pattern without surrounding slashes.

    --delete (-d) 'pattern'
      Delete anything that matches 'pattern' in variable *values*.
      'pattern' must be a valid mawk(1) pattern without surrounding
      slashes. If both '-d' and '-b' are specified, they can affect
      each other in that '-d' is done before '-b'.

    --blank (-b) 'pattern'
      Replace anything that matches 'pattern' in variable *values*
      with one single blank. 'pattern' must be a valid mawk(1)
      pattern without surrounding slashes. If both '-d' and
      '-b' are specified, they can affect each other in that '-d'
      is done before '-b'.

    --strip-names (-s) 'pattern'
      Strip anything that matches 'pattern' from variable *names*.
      This can be useful, for instance, to remove the leading
      'WWW_' from CGI varibles set by the 'uncgi' program.

    --prefix (-p) 'string'
      Prefix each default output column name with 'string'.

    --header (-H) 'file'
      Save the output table header to 'file'.
      Warning: if 'file' already exists it is overwritten.

    --trim (-t)
      Strip surrounding blanks from variable values.

    --key (-K) 'name'
      The environment variable with 'name', if any, will
      be the first (leftmost) in the output table. The
      requested name is searched for before any other
      options are applied.

    --debug (-x)
      Print all the regular expressions given with command line
      arguments to STDERR.

Notes:

Environment variable names that do not match the regular expression
/^[A-Za-z][A-Za-z0-9_]+$/ are skipped, and a warning message is
printed to STDERR.

$Id$
