# *********************************************************************
# keysearch.txt: help text
# Copyright (c) 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: keysearch.txt,v 1.1 2003/04/19 20:35:35 carlo Exp $

                      NoSQL operator: keysearch

Display table records which leftmost field begins with a given string.

Usage:  keysearch [options] string table

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

    --fold (-f)
      Ignore the case of alphabetic characters.

    --partial (-p)
      Partial (initial) match.

    --no-header (-N)
      Strip table header from output.


Notes:

This operator does a fast binary search on a NoSQL table file, looking
for records which first column begins with the specified 'string'. The
table being searched must be sorted alphabetically on the leftmost
column. This program is a header-aware front-end to the look(1) utility.
Refer to the man page of the latter for more info. Since return code '1'
is used by look(1) to signal the no-match condition, 'keysearch' will
exit with return code '2' in case of any other errors. Apart from option
'-f', which is passed to look(1), no other look(1) options are recognized.
The maximum acceptable length of the 'string' argument is 255 characters.

