Debian Codegraph @

src/htdocs/download.shtml

raw
1 <!--#include virtual="_header.html" -->
2 <div class="whitepost">
3 <h1 class="title">What version to get?</h1>
4 <div class="entry">
5 <p>For most new projects we recommend using the code in our <a href="#2_3_2">git master HEAD</a>. This version conforms with Java Lucene 2.3.2, and is considerably faster than any previous version of CLucene. It also uses cmake as it's build system, and continuesly evolves to be stronger and faster.</p>
6 <p>There is also the <a href="#0_9_21b">0.9.21b version</a> we release quite a while ago. It is proven to be stable, but we provide almost no support for it nowadays. Use it only if you have a compelling reason not to use the one in the git master HEAD.</p>
7 <p>For more info on this, please read <a href="https://sourceforge.net/mailarchive/message.php?msg_name=608922AE614C481DBAC401E0072937DA%40hp6690ej01">this</a> thread. You are welcome to ask any follow-up questions in our <a href="https://sourceforge.net/projects/clucene/support">mailing list</a>. Also, don't forget to check on how you can <a href="contribute.shtml">contribute</a>.</p>
8 </div>
9 </div>
10
11 <a name="2_3_2"></a>
12 <div class="post">
13 <div class="post-bgtop">
14 <div class="post-bgbtm">
15 <h1 class="title"><a href="http://clucene.git.sourceforge.net/git/gitweb.cgi?p=clucene/clucene;a=summary">The 2_3_2 branch from the git master HEAD</a></h1>
16 <p class="meta">Being continuesly updated</p>
17 <div class="entry">
18 <p>The recommended branch to use. Easier to build and maintain.</p>
19 <p>Use a git client to keep in sync with our working copy:<pre>git clone git://clucene.git.sourceforge.net/gitroot/clucene/clucene</pre>
20 <p>Alternatively, you can download a tarball through <a href="http://clucene.git.sourceforge.net/git/gitweb.cgi?p=clucene/clucene;a=tree">our WebGUI</a> (click "snapshot").</p>
21 <p><strong>Build instructions</strong> (more info in the INSTALLATION and README files):</p>
22 <pre>
23 Building from source:
24 --------------------
25
26 Dependencies:
27 * CMake version 2.4.2 or later (2.6 or later recommended due to an improved FindBoost module)
28 * Boost libs (http://www.boost.org/), latest version recommended
29 * A functioning and fairly new C++ compiler. We test mostly on GCC and Visual Studio 6+.
30 Anything other than that may not work.
31 * Something to unzip/untar the source code.
32
33 Build instructions:
34 1.) Download the latest sourcecode of the HEAD of the master branch in our git repository
35 2.) Unpack the tarball/zip/bzip/whatever if downloaded as such
36 3.) Open a command prompt, terminal window, or cygwin session.
37 4.) Change directory into the root of the sourcecode (from now on referred to as <clucene>)
38 # cd <clucene>
39 5.) Create and change directory into an 'out-of-source' directory for your build.
40 [This is by far the easiest way to build, it has the benefit of being able to
41 create different types of builds in the same source-tree.]
42 # mkdir <clucene>/build-name
43 # cd <clucene>/build-name
44 5*.) Windows users: make sure Boost environment variables are defined at least for the current
45 command prompt session. You can check this by typing "set" (no quotes). If you have any doubts,
46 just type the following 3 commands to set those variables, as follows (boost_1_40_0 being the
47 current Boost version):
48 set BOOST_BUILD_PATH=C:\{parent directory for boost}\boost_1_40_0\tools\build\v2
49 set BOOST_PATH=C:\{parent directory for boost}
50 set BOOST_ROOT=C:\{parent directory for boost}\boost_1_40_0
51 6.) Configure using cmake. This can be done many different ways, but the basic syntax is
52 # cmake [-G "Script name"] ..
53 [Where "Script name" is the name of the scripts to build (e.g. Visual Studio 8 2005).
54 A list of supported build scripts can be found by]
55 # cmake --help
56 7.) You can configure several options such as the build type, debugging information,
57 mmap support, etc, by using the CMake GUI or by calling
58 # ccmake ..
59 Make sure you call configure again if you make any changes.
60 8.) Start the build. This depends on which build script you specified, but it would be something like
61 # make
62 or
63 # nmake
64 Or open the solution files with your IDE.
65
66 [You can also specify to just build a certain target (such as cl_test, cl_demo,
67 clucene-core (shared library), clucene-core-static (static library).]
68 9.) The binary files will be available in <clucene>build-name/bin
69 10.)Test the code. (After building the tests - this is done by default, or by calling make cl_test)
70 # ctest -V
71 11.)At this point you can install the library:
72 # make install
73 [There are options to do this from the IDE, but I find it easier to create a
74 distribution (see instructions below) and install that instead.]
75 or
76 # make cl_demo
77 [This creates the demo application, which demonstrates a simple text indexing and searching].
78 or
79 Adjust build values using ccmake or the Cmake GUI and rebuild.
80
81 12.)Now you can develop your own code. This is beyond the scope of this document.
82 Read the README for information about documentation or to get help on the mailinglist.
83
84 </pre>
85 </div>
86 </div>
87 </div>
88 </div>
89
90 <a name="0_9_21b"></a>
91 <div class="post">
92 <div class="post-bgtop">
93 <div class="post-bgbtm">
94 <h1 class="title"><a href="http://sourceforge.net/projects/clucene/files/">Release 0.9.21b</a></h1>
95 <p class="meta">October 23rd, 2008</p>
96 <div class="entry">
97 <p>This is the latest stable official release.</p>
98 <p><strong>Installation notes</strong></p>
99 <pre>
100 Rebuilding the autobuild scripts
101 --------------------------------
102 If you made changes to the configure.ac or any of the Makefile.am
103 files you will also need to run through this process.
104
105 Requirements:
106 GNU autotools is required. I have the following versions installed:
107 Autoconf 2.57
108 Automake 1.72
109 Libtool 1.5a
110
111 If you use significantly older versions, I can almost guarantee
112 issues. This is because each of the autotools is constantly changing
113 with little regard to backward compatability or even compatiability
114 with the other autotools.
115
116 Run the autogen.sh file in the root directory of clucene to run the necessary commands.
117
118
119 Building
120 --------
121 The following will get you building assuming that you have suffciently
122 recent buld tools installed.
123 1.) unpack tarball
124 2.) cd into clucene
125 3.) if you downloaded a tar version skip to 5
126 4.) run ./autogen.sh
127 5.) run ./configure
128 6.) run make
129 7.) things will churn for a very long time, the clucene library will
130 be built as well as the examples.
131 8.) check the src/demo, test and src directory
132
133 In src/demo you should see:
134 cl_demo
135
136 In test you should see
137 cl_test
138
139 In src you should see:
140 libclucene.so.0.0.0 libclucene.la libclucene.a
141 and symbolic links to these files.
142
143 9.) If you want to run make install to copy the clucene files into the system
144 include and lib directories
145 10.) You may have to run
146 export LD_LIBRARY_PATH=/path/to/clucene/lib
147
148 11.) run ./cl_test in the test directory and check that the tests all run
149
150 Alternative (faster) way of building:
151 -------------------------------------
152 This method does not create library files, so depending on your needs you may not
153 find this method useful.
154
155 * Do steps 1-5 of the previous build process.
156 * Change directory into src/
157 * run make monolithic
158 * Change directory into test/ (cd ../test/)
159 * run make monolithic
160 * You should see cl_test_monolithic in this directory
161 * run ./cl_test_monolithic and check that the tests all run
162 </pre>
163
164 </div>
165 </div>
166 </div>
167 </div>
168 <!--#include virtual="_footer.html" -->