~ubuntu-branches/ubuntu/trusty/hyperestraier/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/intro-en.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2006-11-14 05:28:32 UTC
  • mfrom: (2.1.4 feisty)
  • Revision ID: james.westby@ubuntu.com-20061114052832-0lzqzcefn8mt4yqe
Tags: 1.4.9-1.1
* Non-maintainer upload.
* High-urgency upload for RC bugfix.
* Set HOME=$(CURDIR)/junkhome when building, otherwise the package build
  will incorrectly look for headers there -- and fail when the directory
  exists and is unreadable, as happens sometimes on sudo-using
  autobuilders!

Show diffs side-by-side

added added

removed removed

Lines of Context:
9
9
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
10
10
<meta http-equiv="Content-Style-Type" content="text/css" />
11
11
<meta name="author" content="Mikio Hirabayashi" />
12
 
<meta name="keywords" content="Hyper Estraier, Estraier, full-text search, API" />
 
12
<meta name="keywords" content="Hyper Estraier, Estraier, full-text search, introduction" />
13
13
<meta name="description" content="Introduction of Hyper Estraier" />
14
14
<link rel="contents" href="./" />
15
15
<link rel="alternate" href="intro-en.html" hreflang="en" title="the English version" />
23
23
 
24
24
<h1>Introduction</h1>
25
25
 
26
 
<div class="note">Copyright (C) 2004-2005 Mikio Hirabayashi</div>
27
 
<div class="note">Last Update: Tue, 01 Nov 2005 04:27:26 +0900</div>
28
 
<div class="navi">[<a href="intro-ja.html" hreflang="ja">Japanese</a>] [<a href="index.html">HOME</a>]</div>
 
26
<div class="note">Copyright (C) 2004-2006 Mikio Hirabayashi</div>
 
27
<div class="note">Last Update: Mon, 11 Sep 2006 21:41:45 +0900</div>
 
28
<div class="navi">[<span class="void">English</span>/<a href="intro-ja.html" hreflang="ja">Japanese</a>] [<a href="index.html">HOME</a>]</div>
29
29
 
30
30
<hr />
31
31
 
50
50
<li>High performance of search</li>
51
51
<li>High scalability of target documents</li>
52
52
<li>Perfect recall ratio by N-gram method</li>
 
53
<li>High precision by hybrid mechanism of N-gram and morphological analyzer</li>
53
54
<li>Phrase search, regular expressions, attribute search, and similarity search</li>
54
55
<li>Multilingualism with Unicode</li>
55
56
<li>Independent of file format and repository</li>
 
57
<li>Intelligent web crawler</li>
56
58
<li>Simple and powerful API</li>
57
59
<li>Supporting P2P architecture</li>
58
60
</ul>
81
83
<li>Solaris 8 and later (IA32/SPARC)</li>
82
84
<li>Mac OS X 10.2 and later (PowerPC)</li>
83
85
<li>HP-UX 11.11 and later (IA64/PA-RISC)</li>
84
 
<li>Windows 2000 and later (IA32)</li>
 
86
<li>Windows 2000 and later (IA32/IA64/AMD64)</li>
85
87
</ul>
86
88
 
87
89
<p><code>gcc</code> 2.95 or later and <code>make</code> are required to install Hyper Estraier with the source package.  They are installed by default on Linux, FreeBSD and so on.</p>
89
91
<p>As Hyper Estraier depends on the following libraries, install them beforehand.</p>
90
92
 
91
93
<ul>
92
 
<li><a href="http://www.gnu.org/software/libiconv/">libiconv</a> : for conversion of character encodings.  1.9.1 or later is suggested.</li>
 
94
<li><a href="http://www.gnu.org/software/libiconv/">libiconv</a> : for conversion of character encodings.  1.9.1 or later is suggested (glibc includes it).</li>
93
95
<li><a href="http://www.gzip.org/zlib/">zlib</a> : for loss-less data compression.  1.2.1 or later is suggested.</li>
94
 
<li><a href="http://qdbm.sourceforge.net">QDBM</a> : for embedded database.  1.8.33 or later is required.</li>
 
96
<li><a href="http://qdbm.sourceforge.net">QDBM</a> : for embedded database.  1.8.68 or later is required.</li>
95
97
</ul>
96
98
 
97
 
<p>As well, it is suggested to build QDBM with enabling zlib (<code>./configure --enable-zlib</code>) so that the index of Hyper Estraier becomes smaller.  Note that QDBM 1.8.32 or earlier is not supported.</p>
 
99
<p>As well, it is suggested to build QDBM with enabling zlib (<code>./configure --enable-zlib</code>) so that the index of Hyper Estraier becomes smaller.  Note that QDBM 1.8.67 or earlier is not supported.</p>
98
100
 
99
101
<h3>Installation</h3>
100
102
 
127
129
<pre>/usr/local/include/estraier.h
128
130
/usr/local/include/estmtdb.h
129
131
/usr/local/lib/libestraier.a
130
 
/usr/local/lib/libestraier.so.7.0.0
131
 
/usr/local/lib/libestraier.so.7
 
132
/usr/local/lib/libestraier.so.8.34.0
 
133
/usr/local/lib/libestraier.so.8
132
134
/usr/local/lib/libestraier.so
133
135
/usr/local/lib/pkgconfig/hyperestraier.pc
134
136
/usr/local/bin/estcmd
135
137
/usr/local/bin/estmttest
136
138
/usr/local/bin/estmaster
 
139
/usr/local/bin/estmastersearch
137
140
/usr/local/bin/estcall
138
141
/usr/local/bin/estwaver
139
142
/usr/local/bin/estload
140
143
/usr/local/bin/estconfig
141
144
/usr/local/bin/estwolefind
142
145
/usr/local/libexec/estseek.cgi
 
146
/usr/local/libexec/estfraud.cgi
143
147
/usr/local/share/hyperestraier/estseek.conf
144
148
/usr/local/share/hyperestraier/estseek.tmpl
145
149
/usr/local/share/hyperestraier/estseek.top
 
150
/usr/local/share/hyperestraier/estseek.help
 
151
/usr/local/share/hyperestraier/estfraud.conf
146
152
/usr/local/share/hyperestraier/estresult.dtd
147
153
/usr/local/share/hyperestraier/estraier.idl
148
154
/usr/local/share/hyperestraier/locale/...
159
165
 
160
166
<p>On HP-UX, perform `<code>make hpux</code>' instead of `<code>make</code>', and `<code>make check-hpux</code>' instead of `<code>make check</code>', and `<code>make install-hpux</code>' instead of `<code>make install</code>'.  As well, `<code>libqdbm.sl</code>' is created instead of `<code>libestraier.so</code>' and so on.</p>
161
167
 
162
 
<p>On Windows, the Cygwin environment is required for building.  Moreover, MinGW versions of zlib, libiconv, QDBM, and Pthreads are required.  On that basis, perform `<code>make win</code>'.  No installation command is provided for Windows.</p>
 
168
<p>On Windows, the Cygwin environment is required for building.  Moreover, MinGW versions of zlib, libiconv, regex, QDBM, and Pthreads are required.  On that basis, perform `<code>make win</code>'.  No installation command is provided for Windows.</p>
 
169
 
 
170
<h3>Options of configure</h3>
 
171
 
 
172
<p>The following options can be specified with `./configure'.</p>
 
173
 
 
174
<ul>
 
175
<li><kbd>--enable-debug</kbd> : build for debugging.  Enable debugging symbols, do not perform optimization, and perform static linking.</li>
 
176
<li><kbd>--enable-devel</kbd> : build for development.  Enable debugging symbols, perform optimization, and perform dynamic linking.</li>
 
177
<li><kbd>--enable-mecab</kbd> : enable MeCab for keyword extraction.</li>
 
178
<li><kbd>--disable-zlib</kbd> : disable ZLIB compression of the index.</li>
 
179
<li><kbd>--enable-lzo</kbd> : use LZO compression instead of ZLIB.</li>
 
180
<li><kbd>--enable-bzip</kbd> : use BZIP2 compression instead of ZLIB.</li>
 
181
<li><kbd>--enable-vista</kbd> : use Vista database instead of Villa.</li>
 
182
</ul>
163
183
 
164
184
<hr />
165
185
 
194
214
cp /usr/local/share/hyperestraier/estseek.* .
195
215
</pre>
196
216
 
197
 
<p>`<code>/usr/local/libexec/estseek.cgi</code>', `<code>estseek.(conf|tmpl|top)</code>' in `<code>/usr/local/share/hyperestraier/</code>' are copied into `<code>/home/www/cgi-bin/</code>'.  <code>estseek.cgi</code> is the CGI script.  <code>estseek.conf</code> is the configuration file.  <code>estseek.tmpl</code> is the template file.  <code>estseek.top</code> is for the message of the top page.</p>
 
217
<p>`<code>/usr/local/libexec/estseek.cgi</code>', `<code>estseek.(conf|tmpl|top|help)</code>' in `<code>/usr/local/share/hyperestraier/</code>' are copied into `<code>/home/www/cgi-bin/</code>'.  <code>estseek.cgi</code> is the CGI script.  <code>estseek.conf</code> is the configuration file.  <code>estseek.tmpl</code> is the template file.  <code>estseek.top</code> is for the message of the top page.  <code>estseek.help</code> is for the usage of search functions.</p>
198
218
 
199
219
<p>Open <code>estseek.conf</code> with a text editor and modify it.  Most items are not needed to be modified, except for `<code>indexname</code>' and `<code>replace</code>'.  Do as the following.</p>
200
220