# *********************************************************************
# total.txt: help text
#
# Copyright (c) 2001,2002,2003 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; 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: total.txt,v 1.3 2003/05/23 20:31:53 carlo Exp $

                      NoSQL operator: total

Sums up selected table columns.

Usage: total [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)
      Suppress table header from output.

    --total (-T) 'column'
      The table will be appended an extra column with the
      specified 'column' name, containing the grand-total
      of the columns that were summed.

    --report (-r)
      Print the whole table to STDOUT, along with totals,
      and insert special formatting fields to be interpreted
      by 'justify'.

    --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.

    --currency (-c)
      The specified columns are expected to contain currency
      values, so the output format is set to "%.2f".

Notes:

Adds the values in the selected columns and displays them.
If no columns are specified, then nothing is summed.

