XPAT database search engine (man page)
Index

NAME

xpat - XPAT database search engine

SYNOPSIS

xpat, xpatu [ -v ][ -m memory k | K | m | M ] [ -h historysize ] [ -q ] [ -e ] [ -label label_name ] [ -I index_name] data_dictionary

DESCRIPTION

xpat reads database queries from the standard input and produces results on the standard output. The query expressions must be in the form of XPat Command Language commands (refer to the XPat Reference Manual and Tutorial for a description of this language). xpat searches for word prefixes, words, phrases or ranges of any of these. xpat supports many different operations for combining the results of searches. In addition, xpat supports structural operations which allow queries to be restricted to specific user-defined regions in the database. These `region' operations also support inclusion operations on query results.

xpat uses several indices to perform the queries on the text database. Refer to the Database Administration Guide for more details on these indices and the methods to build them.

The central component of a text database is the Data Dictionary file, which specifies the text and index files that make up the database. Users search a particular database by passing that database's Data Dictionary as the data_dictionary argument to xpat.

The Unicode enabled version of xpat is xpatu. The same command line options are supported. xpatu uses the main index produced by xpatbldu to perform queries on Unicode UTF-8 encoded data. xpatu can query data from the Basic Multilingual Plane (Plane 0), i.e., UCS code point values up to #FFFF.

OPTIONS

-v
Specify verbose mode. This option tells xpat to produce some additional messages concerning the execution.
-m memory [ k | K | m | M ]
Specify the memory. This option tells xpat to use memory kilobytes or megabytes for index and text caching.
-h historysize
Specify the history size. This option sets the history list size. xpat defaults to having a maximum history of 300 queries. This means that xpat will only remember the latest 300 queries entered. Use this option to increase the number of queries in the history list.
-q
Specify quiet mode. This option tells xpat to output results in a tagged ASCII, machine readable format that other programs can process more easily. See the Database Administration Guide and the XPat Reference Manual and Tutorial for further details.
-e
Specify echo mode. This option tells xpat to echo the input to standard output. This option is useful to echo the output to a log file when reading input from a script file.
-label label_name
Specify the label. This option assigns label_name to the database for the current session of xpat.
-I index_name
Specify the index name. This option tells xpat to use the index with the name index_name in the data_dictionary for string searches. By default, xpat uses the first index in the data_dictionary.

EXAMPLE

        Digital Library eXtension Service, XPAT, Release 5.3
        COPYRIGHT (c) 2003 The Regents of the University of Michigan
        All Rights Reserved>> love
  1: 462 matches>> hate
  2: 263 matches>> love near hate
  3: 47 matches>> pr sample
       .
       .
       .
>> love fby hate
  4: 36 matches>> quit

SEE ALSO

(1), xpatrgn(1), multirgn(1), sgmlrgn(1), regions(5), data_dictionary(5), xpat_export(5)

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
EXAMPLE
SEE ALSO