]]>
dtsrhanuser
cmd
dtsrhanCreate
a DtSearch fzk file
dtsrhan −m −oo −oa −wscreensz hanfile textfile fzkfile
DESCRIPTION
dtsrhan is a filter utility that creates a correctly
formatted fzk file from a file of unformatted input text documents using
a user-written profile called a han file. The han file identifies
specific data fields in the input text from which the fzk fields can be
generated.
dtsrhan makes a single
forward pass through the text file. Its profiling ability is limited to
line number, column number, and simple string pattern matching. It is
usable only for ASCII text input files and ASCII fzk output files;
nonASCII languages are not supported.
dtsrhan is a convenience utility only; its use is
optional. Canonical fzk files for input to dtsrload
and dtsrindex may be generated in any other
desirable way.
OPTIONS
The following options are available:
If an
option takes a value, the value must be directly appended to the option
name without white space.
−m
Switches off all messages except error messages.
−oo
Overwrite preexisting fzk file. If this option and the
−oa option are omitted and the output fzk file
already exists, dtsrhan prompts for which option to
use.
−oa
Append new output to preexisting fzk file. If this option and the
−oo option are omitted and the output fzk file
already exists, dtsrhan prompts for which option to
use.
−wscreensz
Sets the
target screen width to screensz
characters. dtsrhan wraps long text lines at the
nearest whitespace to ensure that no text line in the fzk file is longer
than screensz characters. This option
is typically used to ensure that output lines are not wider than the
anticipated end user screen width. The default value is 79.
OPERANDS
dtsrhan takes the
following operands:
hanfile
Specifies the
name of the profile han file. If the base file name does not include an
extension, dtsrhan assumes an extension of
.han. The argument may include a fully qualified path
prefix or a prefix relative to the current working directory. See
&cdeman.dtsrhanfile; for the format of a han file.
textfile
Specifies the
name of the input text file. dtsrhan does not assume
any extension.
The input file may contain text that will
be mapped to a single database object or document, or it may contain
multiple documents separated by the end-of-record markers specified in
the han file. No assumptions are made concerning the format of the input
file other than the fact that it consists of ASCII text with line feeds
at reasonable lengths.
fzkfile
Specifies the name of the output fzk file. If this
option is omitted, dtsrhan constructs the fzk file
name from the name of the input file, including the path prefix if any,
with an .fzk suffix appended. See
&cdeman.dtsrfzkfiles; for the format of a fzk file.
ENVIRONMENT VARIABLES
None.
RESOURCES
None.
ACTIONS/MESSAGES
None.
RETURN VALUES
The return
values are as follows:
0
dtsrhan completed successfully.
non-zero
dtsrhan encountered an error.
FILES
dtsrhan reads the specified text file and the
specified han file, and writes to the specified fzk file.
EXAMPLES
Convert the documents in the ASCII text file
docs.txt to an fzk file named
docs.fzk using the profile
myprofile.han, all in the current working
directory.
dtsrhan myprofile docs.txt
Convert the documents in the ASCII text file myin in the
current working directory, to an fzk file named myout.fzk
in the fzkdir subdirectory of the current working directory,
using the han file located at /u/dtsearch/mypro.han3.
If myout.fzk already exists, the fzk records for the document(s)
in myin will be appended to it.
If any lines in myin have more than 132 characters, they will
be wrapped at the nearest whitespace less than 132 characters.
dtsrhan -oa -w132 /u/dtsearch/mypro.han3 myin fzkdir/myout
SEE ALSO
&cdeman.dtsrload;,
&cdeman.dtsrindex;,
&cdeman.dtsrfzkfiles;,
&cdeman.dtsrhanfile;,
&cdeman.DtSearch;