# *********************************************************************
# Original code: subtotal,v 2.7 1994/11/08 09:01:53 hobbs
#
# Adapted to NoSQL by Carlo Strozzi <carlos@linux.it>.
#
# subtotal.txt: help text
# Copyright (C) 2001-2002 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.
#
# *********************************************************************
# $Id: subtotal.txt,v 1.2 2003/03/17 10:10:45 carlo Exp $

                      NoSQL operator: subtotal

Compute subtotals on selected table columns.

Usage:  subtotal [options] B_column ... -s column ...

Options:
    --help (-h)
      Print this help info.

    --total (-t)
      Include totals.

    --total-only (-T)
      Total Only Option. Just do totals on specified columns. In this
      case the '-s' flag is not necessary.

Notes:

Lists subtotals of specified subtotal column(s) (those following the '-s'
flag) whenever the value of break columns(s) (B_column) changes.

If no break column(s) are given the first column is used; if no sub-total
columns are given then all columns of type numeric are sub-totaled.

This operator reads a NoSQL table via STDIN and writes a NoSQL table
via STDOUT. Options may be abbreviated.

