8
.B estcmd put [\-cl] db [file]
8
.B estcmd create [\-tr] [\-apn|\-acc] [\-xs|\-xl|\-xh|\-xh2|\-xh3] [\-sv|\-si|\-sa] [\-attr name type] db
10
.B estcmd put [\-tr] [\-cl] [\-ws] [\-apn|\-acc] [\-xs|\-xl|\-xh||\-xh2|\-xh3] [\-sv|\-si|\-sa] db [file]
10
12
.B estcmd out [\-cl] [\-pc enc] db expr
12
.B estcmd edit [\-cl] [\-pc enc] db expr name [value]
14
.B estcmd get [\-pc enc] db expr [attr]
16
.B estcmd list [\-lp] db
18
.B estcmd uriid [\-pc enc] db expr
14
.B estcmd edit [\-pc enc] db expr name [value]
16
.B estcmd get [\-nl|\-nb] [\-pidx path] [\-pc enc] db expr [attr]
18
.B estcmd list [\-nl|\-nb] [\-lp] db
20
.B estcmd uriid [\-nl|\-nb] [\-pidx path] [\-pc enc] db expr
20
22
.B estcmd meta db [name [value]]
24
.B estcmd inform [\-nl|\-nb] db
24
26
.B estcmd optimize [\-onp] [\-ond] db
26
.B estcmd search [\-ic enc] [\-vu|\-va|\-vf|\-vs|\-vh|\-vx|\-dd] [\-kn num] [\-ec] [\-gs|\-gf|\-ga] [\-cd] [\-ni] [\-sf] [\-hs] [\-attr expr] [\-ord expr] [\-max num] [\-sk num] [\-sim id] db [phrase]
28
.B estcmd gather [\-cl] [\-no] [\-fe|\-ft|\-fh|\-fm] [\-fx sufs cmd] [\-fz] [\-fo] [\-rm sufs] [\-ic enc] [\-il lang] [\-bc] [\-pc enc] [\-px name] [\-apn] [\-sd] [\-cm] [\-cs num] db [file|dir]
28
.B estcmd merge [\-cl] db target
30
.B estcmd repair [\-rst|\-rsh] db
32
.B estcmd search [\-nl|\-nb] [\-pidx path] [\-ic enc] [\-vu|\-va|\-vf|\-vs|\-vh|\-vx|\-dd] [\-sn wnum hnum anum] [\-kn num] [\-um] [\-ec rn] [\-gs|\-gf|\-ga] [\-cd] [\-ni] [\-sf|\-sfr|\-sfu|\-sfi] [\-hs] [\-attr expr] [\-ord expr] [\-max num] [\-sk num] [\-aux num] [\-dis name] [\-sim id] db [phrase]
34
.B estcmd gather [\-tr] [\-cl] [\-ws] [\-no] [\-fe|\-ft|\-fh|\-fm] [\-fx sufs cmd] [\-fz] [\-fo] [\-rm sufs] [\-ic enc] [\-il lang] [\-bc] [\-lt num] [\-lf num] [\-pc enc] [\-px name] [\-aa name value] [\-apn|\-acc] [\-xs|\-xl|\-xh|\-xh2|\-xh3] [\-sv|\-si|\-sa] [\-ss name] [\-sd] [\-cm] [\-cs num] [\-ncm] [\-kn num] [\-um] db [file|dir]
30
36
.B estcmd purge [\-cl] [\-no] [\-fc] [\-pc enc] [\-attr expr] db [prefix]
32
.B estcmd extkeys [\-no] [\-fc] [\-dfdb file] [\-ni] [\-kn num] [\-attr expr] db [prefix]
34
.B estcmd words [\-dfdb file] db
36
.B estcmd draft [\-ft|\-fh|\-fm] [\-ic enc] [\-il lang] [\-bc] [\-kn num] [file]
38
.B estcmd break [\-ic enc] [\-il lang] [\-apn] [\-wt] [file]
38
.B estcmd extkeys [\-no] [\-fc] [\-dfdb file] [\-ncm] [\-ni] [\-kn num] [\-um] [\-attr expr] db [prefix]
40
.B estcmd words [\-nl|\-nb] [\-dfdb file] [\-kw|\-kt] db
42
.B estcmd draft [\-ft|\-fh|\-fm] [\-ic enc] [\-il lang] [\-bc] [\-lt num] [\-kn num] [\-um] [file]
44
.B estcmd break [\-ic enc] [\-il lang] [\-apn|\-acc] [\-wt] [file]
40
46
.B estcmd iconv [\-ic enc] [\-il lang] [\-oc enc] [file]
48
.B estcmd regex [\-inv] [\-repl str] expr [file]
50
.B estcmd scandir [\-tf|\-td] [\-pa|\-pu] [dir]
52
.B estcmd multi [\-db db] [\-nl|\-nb] [\-ic enc] [\-gs|\-gf|\-ga] [\-cd] [\-ni] [\-sf|\-sfr|\-sfu|\-sfi] [\-hs] [\-hu] [\-attr expr] [\-ord expr] [\-max num] [\-sk num] [\-aux num] [\-dis name] [phrase]
42
54
.B estcmd randput [\-ren|\-rla|\-reu|\-ror|\-rjp|\-rch] [\-cs num] db dnum
44
56
.B estcmd wicked db dnum
46
58
.B estcmd regression db
52
estcmd is an aggregation of sub commands. The name of a sub command is specified by the first argument. Other arguments are parsed according to each sub command. The argument
65
is an aggregation of sub commands. The name of a sub command is specified by the first argument. Other arguments are parsed according to each sub command. The argument
54
67
specifies the path of an index.
56
.B estcmd put [\-cl] db [file]
69
.B estcmd create [\-tr] [\-apn|\-acc] [\-xs|\-xl|\-xh|\-xh2|\-xh3] [\-sv|\-si|\-sa] [\-attr name type] db
74
is specified, a new index is created regardless if one exists.
78
is specified, N\-gram analysis is performed against European text also.
82
is specified, character category analysis is performed instead of N-gram analysis.
86
is specified, the index is tuned to register less than 50000 documents.
90
is specified, the index is tuned to register more than 300000 documents.
94
is specified, the index is tuned to register more than 1000000 documents.
98
is specified, the index is tuned to register more than 5000000 documents.
102
is specified, the index is tuned to register more than 10000000 documents.
106
is specified, scores are stored as void.
110
is specified, scores are stored as 32-bit integer.
114
is specified, scores are stored as-is and marked not to be tuned when search.
117
specifies an attribute index and its data type. This option can be specified multiple times.
119
.B estcmd put [\-tr] [\-cl] [\-apn|\-acc] [\-xs|\-xl|\-xh|\-xh2|\-xh3] [\-sv|\-si|\-sa] db [file]
57
120
Register a document of document draft to an index.
59
123
specifies a target file. If it is omitted, the standard input is read.
127
is specified, a new index is created regardless if one exists.
62
131
is specified, regions of a overwritten document are cleaned up.
135
is specified, scores are weighted statically with score weighting attribute.
139
is specified, N\-gram analysis is performed against European text also.
143
is specified, character category analysis is performed instead of N-gram analysis.
147
is specified, the index is tuned to register less than 50000 documents.
151
is specified, the index is tuned to register more than 300000 documents.
155
is specified, the index is tuned to register more than 1000000 documents.
159
is specified, the index is tuned to register more than 5000000 documents.
163
is specified, the index is tuned to register more than 10000000 documents.
167
is specified, scores are stored as void.
171
is specified, scores are stored as 32-bit integer.
175
is specified, scores are stored as-is and marked not to be tuned when search.
64
177
.B estcmd out [\-pc enc] [\-cl] db expr
65
178
Remove information of a document from an index.
67
181
specifies the ID number, the URI, or the local path of a document.
70
185
is specified, regions of the document are cleaned up.
72
188
specifies the encoding of file paths. By default, it is ISO-8859-1.
74
190
.B estcmd edit [\-pc enc] db expr name [value]
75
191
Edit an attribute of a document in an index.
77
194
specifies the ID number, the URI, or the local path of a document.
79
197
specifies the name of an attribute.
81
200
specifies the value of the attribute. If it is omitted, the attribute is removed.
83
203
specifies the encoding of the file path and the attribute value. By default, it is ISO-8859-1.
85
.B estcmd get [\-pc enc] db expr [attr]
205
.B estcmd get [\-nl|\-nb] [\-pidx path] [\-pc enc] db expr [attr]
86
206
Output document draft of a document in an index.
88
209
specifies the ID number, the URI, or the local path of a document.
91
213
is specified, only the value of the attribute is output.
217
is specified, the index is opened without file locking.
221
is specified, file locking is performed without blocking.
224
specifies the path of a pseudo index. This option can be specified multiple times.
93
227
specifies the encoding of file paths. By default, it is ISO-8859-1.
95
.B estcmd list [\-lp] db
229
.B estcmd list [\-nl|\-nb] [\-lp] db
96
230
Output a list of all document in an index.
234
is specified, the index is opened without file locking.
238
is specified, file locking is performed without blocking.
99
242
is specified, local path equivalent to URL of "file://" is output.
101
.B estcmd uriid [\-pc enc] db expr
244
.B estcmd uriid [\-nl|\-nb] [\-pidx path] [\-pc enc] db expr
102
245
Output the ID number of a document specified by URI.
104
248
specifies the URI or the local path of a document.
252
is specified, the index is opened without file locking.
256
is specified, file locking is performed without blocking.
259
specifies the path of a pseudo index. This option can be specified multiple times.
106
262
specifies the encoding of file paths. By default, it is ISO-8859-1.
108
264
.B estcmd meta db [name [value]]
109
265
Handle meta data.
111
268
specifies the name of a piece of meta data. If it is omitted, a list of all names is output.
113
271
specifies the value of the meta data to be recorded. If it is omitted, the current value is output. If it is an empty string, the meta data is removed.
273
.B estcmd inform [\-nl|\-nb] db
116
274
Output the number of documents and the number of unique words in an index.
278
is specified, the index is opened without file locking.
282
is specified, file locking is performed without blocking.
118
284
.B estcmd optimize [\-onp] [\-ond] db
119
285
Optimize an index and clean up dispensable regions.
122
289
is specified, it is omitted to clean up dispensable regions.
125
293
is specified, it is omitted to optimize the database files.
127
.B estcmd search [\-ic enc] [\-vu|\-va|\-vf|\-vs|\-vh|\-vx|\-dd] [\-kn num] [\-ec] [\-gs|\-gf|\-ga] [\-cd] [\-ni] [\-sf] [\-hs] [\-attr expr] [\-ord expr] [\-max num] [\-sk num] [\-sim id] db [phrase]
295
.B estcmd merge [\-cl] db target
299
specifies the path of another index.
303
is specified, regions of overwritten documents are cleaned up.
305
.B estcmd repair [\-rst|\-rsh] db
306
Repair a broken index.
310
is specified, strict consistency check is performed.
314
is specified, consistency check is omitted.
316
.B estcmd search [\-nl|\-nb] [\-pidx path] [\-ic enc] [\-vu|\-va|\-vf|\-vs|\-vh|\-vx|\-dd] [\-sn wnum hnum anum] [\-kn num] [\-um] [\-ec rn] [\-gs|\-gf|\-ga] [\-cd] [\-ni] [\-sf|\-sfr|\-sfu|\-sfi] [\-hs] [\-attr expr] [\-ord expr] [\-max num] [\-sk num] [\-aux num] [\-dis name] [\-sim id] db [phrase]
128
317
Search an index for documents.
130
320
specifies the search phrase.
324
is specified, the index is opened without file locking.
328
is specified, file locking is performed without blocking.
331
specifies the path of a pseudo index. This option can be specified multiple times.
132
334
specifies the input encoding. By default, it is UTF\-8.
135
338
is specified, TSV of ID number and URI are output.
138
342
is specified, multipart format including attributes is output.
141
346
is specified, multipart format including document draft is output.
144
350
is specified, multipart format including attributes and snippets is output.
147
354
is specified, human readable format including attributes and snippets is output.
150
358
is specified, XML including including attributes and snippets is output.
153
362
is specified, document draft data are dumped and saved into separated files.
365
specifies the number of whole width of snippet and width of strings picked up from the beginning of the text and width of strings picked up around each highlighted word.
155
specifies the number of keywords to be extracted. By default, no keyword is extracted.
368
specifies the number of keywords to be extracted. By default, keyword extraction is not performed.
372
is specified, morphological analyzers are used for keyword extraction.
157
375
specifies lower limit of similarity eclipse.
160
379
is specified, every key of N\-gram is checked. By default, it is alternately.
163
383
is specified, keys of N\-gram are checked every three.
166
387
is specified, keys of N\-gram are checked every four.
169
391
is specified, whether documents match the search phrase definitely is checked.
172
395
is specified, TF\-IDF tuning is omitted.
175
399
is specified, the phrase is treated as a simplified form.
403
is specified, the phrase is treated as a rough form.
407
is specified, the phrase is treated as a union form.
411
is specified, the phrase is treated as an intersection form.
178
415
is specified, score information is output as an attribute.
180
418
specifies an attribute search condition. This option can be specified multiple times.
182
421
specifies the order expression. By default, it is descending by score.
184
424
specifies the maximum number of shown documents. Negative means unlimited. By default, it is 10.
186
427
specifies the number of documents to be skipped. By default, it is 0.
430
specifies permission to adopt result of the auxiliary index. If it is not more than 0, the auxiliary index is not used. By default, it is 32.
433
specifies the name of the distinct attribute.
188
436
specifies the ID number of the seed document for similarity search.
190
.B estcmd gather [\-cl] [\-no] [\-fe|\-ft|\-fh|\-fm] [\-fx sufs cmd] [\-fz] [\-fo] [\-rm sufs] [\-ic enc] [\-il lang] [\-bc] [\-pc enc] [\-px name] [\-apn] [\-sd] [\-cm] [\-cs num] db [file|dir]
438
.B estcmd gather [\-tr] [\-cl] [\-ws] [\-no] [\-fe|\-ft|\-fh|\-fm] [\-fx sufs cmd] [\-fz] [\-fo] [\-rm sufs] [\-ic enc] [\-il lang] [\-bc] [\-lt num] [\-lf num] [\-pc enc] [\-px name] [\-aa name value] [\-apn|\-acc] [\-xs|\-xl|\-xh|\-xh2|\-xh3] [\-sv|\-si|\-sa] [\-ss name] [\-sd] [\-cm] [\-cs num] [\-ncm] [\-kn num] [\-um] db [file|dir]
191
439
Scan the local file system and register documents into an index.
192
441
If the third argument is the name of a file, a list of paths of target documents are read from it. If it is "\-", the standard input is specified.
193
443
If the third argument is the name of a directory. All files under the directory are treated as target documents.
447
is specified, a new index is created regardless if one exists.
196
451
is specified, regions of overwritten documents are cleaned up.
455
is specified, scores are weighted statically with score weighting attribute.
199
459
is specified, operations are printed but not executed actually.
202
463
is specified, target files are treated as document draft. By default, the format is detected by the suffix of each document.
205
467
is specified, target files are treated as plain text.
208
471
is specified, target files are treated as HTML.
211
475
is specified, target files are treated as MIME.
214
is specified, target files with the specified suffixes are processed by the specified outer command. If the command is leaded by "T@", the output of the command is treated as plain text. If the command is leaded by "H@", the output of the command is treated as HTML. If the command is leaded by "M@", the output of the command is treated as MIME. Else, the output is treated as document draft. This option can be specified multiple times.
479
is specified, target files with the specified suffixes are processed by the specified outer command. "*" matches any file. If the command is leaded by "T@", the output of the command is treated as plain text. If the command is leaded by "H@", the output of the command is treated as HTML. If the command is leaded by "M@", the output of the command is treated as MIME. Else, the output is treated as document draft. This option can be specified multiple times.
217
is specified, documents which do not corresponding to the condition of \-fx are ignored.
483
is specified, documents which do not corresponding to the condition of
220
489
is specified, target files are not read. It is useful for efficient process of the outer command.
223
493
is specified, target files with the specified suffixes are removed. "*" matches any file. This option can be specified multiple times.
225
496
specifies the input encoding. By default, it is detected automatically.
227
499
specifies the preferred input language. By default, English is preferred.
230
503
is specified, binary files are detected and ignored.
506
specifies the text size limitation by kilo bytes. By default, it is 128KB. If it is negative, the size is unlimited.
509
specifies the file size limitation by mega bytes. By default, it is 32MB. If it is negative, the size is unlimited.
232
512
specifies the encoding of file paths. By default, it is ISO\-8859\-1.
234
515
specifies the name of an attribute read from the list of paths. As the list of paths can be in TSV format, the first field is treated as the path of a target document, the second field and the followers are definitions of attribute values.
236
517
specifies the name of each values of the second field and the followers. This option can be specified multiple times.
520
specifies the name and the value of an additional attribute. This option can be specified multiple times.
239
524
is specified, N\-gram analysis is performed against European text also.
528
is specified, character category analysis is performed instead of N-gram analysis.
532
is specified, the index is tuned to register less than 50000 documents.
536
is specified, the index is tuned to register more than 300000 documents.
540
is specified, the index is tuned to register more than 1000000 documents.
544
is specified, the index is tuned to register more than 5000000 documents.
548
is specified, the index is tuned to register more than 10000000 documents.
552
is specified, scores are stored as void.
556
is specified, scores are stored as 32-bit integer.
560
is specified, scores are stored as-is and marked not to be tuned when search.
563
specifies the name of an attribute for substitute score.
242
567
is specified, the modification date of each file is recorded as an attribute.
245
571
is specified, documents whose modification date has not changed are ignored.
247
specifies the size of cache memory by mega bytes. By default, it is 64Mb.
574
specifies the size of cache memory by mega bytes. By default, it is 64MB.
578
is specified, checking availability of the virtual memory is omitted.
581
specifies the number of keywords to be extracted. By default, keyword extraction is not performed.
585
is specified, morphological analyzers are used for keyword extraction.
249
.B estcmd purge [\-cl] [\-no] [\-fc] [\-ec enc] [\-attr expr] db [prefix]
587
.B estcmd purge [\-cl] [\-no] [\-fc] [\-pc enc] [\-attr expr] db [prefix]
250
588
Purge information of documents which do not exist on the file system.
253
592
is specified, only documents whose URIs are begins with it. It can be specified by the local path of a directory.
256
596
is specified, regions of the deleted documents are cleaned up.
259
600
is specified, operations are printed but not executed actually.
262
604
is specified, information of all target documents are deleted.
264
607
specifies the encoding of file paths. By default, it is ISO-8859-1.
266
610
specifies an attribute search condition. This option can be specified multiple times.
268
.B estcmd extkeys [\-no] [\-fc] [\-dfdb file] [\-ni] [\-kn num] [\-attr expr] db [prefix]
612
.B estcmd extkeys [\-no] [\-fc] [\-dfdb file] [\-ncm] [\-ni] [\-kn num] [\-um] [\-attr expr] db [prefix]
269
613
Create a database of keywords extracted from documents.
272
617
is specified, only documents whose URIs are begins with it.
275
621
is specified, operations are printed but not executed actually.
278
625
is specified, all target documents are processed whichever they have existing records or not.
280
628
specifies an outher database of document frequency. By default, document frequency is calculated dynamically according to the index.
632
is specified, checking availability of the virtual memory is omitted.
283
636
is specified, TF\-IDF tuning is omitted.
285
specifies the number of keywords to be extracted.
639
specifies the number of keywords to be extracted. By default, it is 32.
643
is specified, morphological analyzers are used for keyword extraction.
287
646
specifies an attribute search condition. This option can be specified multiple times.
289
.B estcmd words [\-dfdb file] db
648
.B estcmd words [\-nl|\-nb] [\-dfdb file] [\-kw|\-kt] db
290
649
Output a list of all unique words and each record size which is treated as docuemnt frequency.
653
is specified, the index is opened without file locking.
657
is specified, file locking is performed without blocking.
292
660
specifies an outer database where the result is stored. By default, the result is output to the standard output as TSV. If the outer database already exists, the value of each record is incremented.
664
is specified, keywords and numbers of corresponding documents are output.
668
is specified, keywords and their related terms are output.
294
.B estcmd draft [\-ft|\-fh|\-fm] [\-ic enc] [\-il lang] [\-bc] [\-kn num] [file]
670
.B estcmd draft [\-ft|\-fh|\-fm] [\-ic enc] [\-il lang] [\-bc] [\-lt num] [\-kn num] [\-um] [file]
295
671
For test and debug.
297
.B estcmd break [\-ic enc] [\-il lang] [\-apn] [\-wt] [file]
673
.B estcmd break [\-ic enc] [\-il lang] [\-apn|\-acc] [\-wt] [file]
298
674
For test and debug.
300
676
.B estcmd iconv [\-ic enc] [\-il lang] [\-oc enc] [file]
301
677
For test and debug.
679
.B estcmd regex [\-inv] [\-repl str] expr [file]
682
.B estcmd scandir [\-tf|\-td] [\-pa|\-pu] [dir]
685
.B estcmd multi [\-db db] [\-nl|\-nb] [\-ic enc] [\-gs|\-gf|\-ga] [\-cd] [\-ni] [\-sf|\-sfr|\-sfu|\-sfi] [\-hs] [\-hu] [\-attr expr] [\-ord expr] [\-max num] [\-sk num] [\-aux num] [\-dis name] [phrase]
303
688
.B estcmd randput [\-ren|\-rla|\-reu|\-ror|\-rjp|\-rch] [\-cs num] db dnum
304
689
For test and debug.
added
removed
man/estcmd.1
