<!-- $XConsortium: srdbrec.sgm /main/6 1996/09/08 19:56:28 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE; [<refentry id="CDE.SEARCH.dtsrdbrec">]]>
<refmeta><refentrytitle>dtsrdbrec</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtsrdbrec</command></refname><refpurpose>
Produce DtSearch database configuration and status report
</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtsrdbrec</command>
<arg choice="plain"><replaceable>dbname</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>dtsrdbrec</command> produces a configuration and status report on
the specified DtSearch database.
</para>
<para>DtSearch databases can be customized with a number of configuration
options that are specified at creation time. The
<command>dtsrcreate</command> program loads into the database a
configuration and status record identifying the configuration options
for that particular database instance. In addition, compression
algorithm, document counts, and related data are maintained in the
status record by <command>dtsrload</command> and
<command>dtsrindex</command>.
</para>
<para><command>dtsrdbrec</command> prints to stdout a small report of the
current contents of the configuration and status record. It is identical
to the report printed by <command>dtsrcreate</command> when the database
is created, but can be produced at any time without disturbing the
database itself.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>None.
</para>
</refsect1>
<refsect1>
<title>OPERAND</title>
<para>The <Symbol Role="Variable">dbname</Symbol> argument specifies the name
of the database for which the report is to be produced. A path prefix is
optional. The database name is the 1 to 8 ASCII character string used at
creation time
</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RETURN VALUES</title>
<para>None.
</para>
</refsect1>
<refsect1>
<title>FILES</title>
<para><command>dtsrdbrec</command> opens all core database files for
<Symbol Role="Variable">dbname</Symbol>.
</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>Print a status report for a database named <filename>mydb</filename> in
the current working directory.
</para>
<programlisting>
dtsrdbrec mydb
</programlisting>
<para>Print a status report for a database named <filename>mydb</filename> in
the directory <filename>/u/dtsearch</filename>.
</para>
<programlisting>
dtsrdbrec /u/dtsearch/mydb
</programlisting>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtsrcreate;,
&cdeman.dtsrdbfiles;,
&cdeman.DtSearch;
</para>
</refsect1>
</refentry>
