Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
dtsrcreate(user	cmd)					  dtsrcreate(user cmd)

NAME
       dtsrcreate -- Create and	initialize a DtSearch database

SYNOPSIS
       dtsrcreate [-q]	[-o]  [-fd]  [-fa]  [-aabstr]  [-ddir]	[-wnmin]  [-wx
       max]  [-llang] dbname

DESCRIPTION
       The dtsrcreate command creates and initializes an  instance  of	a  Dt-
       Search  database.  A  DtSearch  database	 consists  of a	set of related
       files. If the specified database	already	exists,	 after	prompting  for
       confirmation,  dtsrcreate  will	erase and reinitialize the preexisting
       database.

   Database Name
       The dbname argument is the database name. It is a 1 to 8	ascii  charac-
       ter  string used	at creation time as a base file	name, and as a general
       database	identifier thereafter. All created database files are named by
       assembling  the	base  name, plus a period and a	1 to 3 ASCII character
       suffix. The database names dtsearch and austext are  reserved  and  may
       not be specified.

   Target Directory
       The  dbname  argument  can include an optional path prefix. If it does,
       the database files will be created and  initialized  in	the  specified
       target  directory. If no	path prefix is specified, the target directory
       is the current working directory.

   Model File
       One of the created database  files  is  based  on  a  model  file,  dt-
       search.dbe,  provided with DtSearch. Database creation will fail	if the
       model file cannot be found. dtsrcreate looks for	the model  file	 first
       in  the	directory specified by a command line option, if any; secondly
       in the current working directory; and thirdly in	 the  optional	dbname
       target directory.

   Configuration Options
       DtSearch	databases can be customized with a number of configuration op-
       tions that are specified	only at	creation time. Initialization consists
       of  loading into	the database a configuration and status	record identi-
       fying the configuration options for the particular  database  instance.
       After  initialization,  dtsrcreate prints a small report	of the current
       contents	of the configuration record to stdout. (See also dtsrdbrec(1),
       which prints the	report without changing	the database).

   Database Types
       The customizable	features available at database creation	time fall into
       clusters	of related capabilities	that constitute	a set of  basic	 data-
       base  types.   When you select a	database type, you prespecify a	number
       of features that	are optimized for the basic type of database you want.

       In the DtSearch database	type, documents	are not	stored in a repository
       and  are	 not  available	from the search	engine after a search. The ab-
       stract returned from a search typically contains	a document  reference,
       usually	the  file  name, and the application is	itself responsible for
       accessing the document. Hilighting of search words is possible when the
       application passes the document cleartext back to the DtSearch API.

       In  an  AusText database	type, compressed documents are stored directly
       into a repository and the originals are thereafter  ignored.   The  ab-
       stracts	returned  from searches	are typically descriptive of the docu-
       ments they represent, and are displayed directly	 to  users.  Documents
       can be retrieved	from an	AusText	type database through the API, and the
       search words are	highlighted as desired.

OPTIONS
       The following options are available:

	      Note:

	      If an option takes a value, the value must be directly  appended
	      to the option name without white space.

       -q	 Suppresses printing of	configuration record report.

       -o	 Suppresses overwrite prompt; preauthorizes erasure and	reini-
		 tialization of	preexisting database.

       -ddir	 Specifies where to find the model dtsearch.dbe	 file,	rather
		 than in the current working directory or target directory.

       -fd	 Configure a DtSearch type database. This is the default.

       -fa	 Configure an AusText type database.

       -aabstr	 Set  the  maximum  abstract  size to abstr bytes. This	is the
		 maximum  permitted  length  in	 characters  for  an  abstract
		 string.  To optimize space considerations in the database the
		 choice	for abstract length may	be  adjusted  upward.  Default
		 size  depends	on  the	specified database type. (See dtsrfzk-
		 files(4) and DtSearch(5) for more information about  abstract
		 fields.)

       -wnmin	 Change	minimum	word size to min characters.  This is the min-
		 imum word size	in characters to be indexed in	the  database.
		 Document and query words shorter than the minimum are treated
		 as stop list words (see dtsrfzkfiles(4)). The minimum can  be
		 overridden  for  specific  individual words by	adding them to
		 the optional include list  file  (see	dtsrfzkfiles(4)).  For
		 most  natural languages the default minimum word size is usu-
		 ally correct; permitting very short words will	usually	 cause
		 a  significant	 increase  in the storage requirements for the
		 database. This	option is typically applicable to  single-byte
		 European  languages  and may be ignored by multibyte language
		 processors. (See DtSearch(5) for more information  about  Dt-
		 Search	word sizes).

       -wxmax	 Change	maximum	word size to max characters.  This is the max-
		 imum word size	in characters. Smaller	is  better  since  ex-
		 traordinarily	long  words in most documents do not represent
		 words at all, but nonsemantic	symbol	strings.  To  optimize
		 space	considerations in the database,	the choice for maximum
		 word size will	usually	be adjusted upward. For	 most  natural
		 languages  the	 default maximum word size is usually correct.
		 This option is	typically applicable to	 single-byte  European
		 languages  and	 may  be ignored by multibyte language proces-
		 sors. (See DtSearch(5)	for more  information  about  DtSearch
		 word sizes).

       -llang	 Change	the language number to lang.  The default is 0.

		 Supported languages include:

		 0	 DtSrLaENG	  English, ASCII character set
		 1	 DtSrLaENG2	  English, ISO Latin-1 character set
		 2	 DtSrLaESP	  Spanish, ISO Latin-1 character set
		 3	 DtSrLaFRA	  French, ISO Latin-1 character	set

		 4	 DtSrLaITA	  Italian, ISO Latin-1 character set
		 5	 DtSrLaDEU	  German, ISO Latin-1 character	set
		 6	 DtSrLaJPN	  Japanese,  packed  EUC  character  set; all
					  possible kanji substrings are	indexed
		 7	 DtSrLaJPN2	  Japanese, packed EUC	character  set;	 only
					  individual  kanjis  are  indexed, plus com-
					  pounds from a	knj language file

		 Specifying an unsupported language number  will  establish  a
		 DtSearch  custom  language for	the database. (See DtSearch(5)
		 for information about DtSearch	languages).

OPERAND
       The dbname operand specifies the	new DtSearch database. It consists  of
       an optional path	prefix,	a 1- to	8-character database name, an optional
       period, and an optional 1- to 3-character extension.  This is the  name
       that the	other build tools and the the search API will use to reference
       the database.

ENVIRONMENT VARIABLES
       None.

RESOURCES
       None.

ACTIONS/MESSAGES
       None.

RETURN VALUES
       The return values are as	follows:

       0	 dtsrcreate completed successfully.

       non-zero	 dtsrcreate encountered	an error.

FILES
       dtsrcreate reads	dtsearch.dbe.

       It creates or reinitializes the following database files:

		 dbname.d00

		 dbname.d01

		 dbname.d21

		 dbname.d22

		 dbname.d23

		 dbname.k00

		 dbname.k01

		 dbname.k21

		 dbname.k22

		 dbname.k23

       It deletes the file dbname.d99.

       Note that not all necessary database files are created  by  dtsrcreate.
       Some  additional	 files	are included in	the DtSearch distribution, are
       created by later	database build programs, or may	be provided by the de-
       veloper.

EXAMPLES
       Create  a  standard  DtSearch  type database named mydb that will index
       ASCII English words of standard length for that language.

       dtsrcreate mydb

       Create an AusText type database named jpndb.  It	 will  index  Japanese
       words  expressed	in packed EUC, with automatic compounding of all kanji
       substrings. When	the text contains embedded ASCII, words	that  are  be-
       tween 2 and 20 characters long will be indexed. At least	150 bytes will
       be available for	the abstract field.

       dtsrcreate -fa -a150 -wn2 -wx20 -l6 jpndb

SEE ALSO
       dtsrdbrec(1), DtSrAPI(3), dtsrdbfiles(4), DtSearch(5)

							  dtsrcreate(user cmd)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERAND | ENVIRONMENT VARIABLES | RESOURCES | ACTIONS/MESSAGES | RETURN VALUES | FILES | EXAMPLES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=dtsrcreate&sektion=1&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help