root/main/trunk/search4j/README @ 32285

Revision 19992, 2.9 KB (checked in by oranfry, 10 years ago)

a quick stab at a README

Line 
1COMPILING - Linux, MacOS, and other brands of Unix
2--------------------------------------------------
3To compile the search4j executable and install it to /usr/local/search4j/bin, run
4
5 ./configure
6 make
7 make install
8
9Use --bindir option to ./configure to control where the executable gets placed at `make install'
10
11COMPILING - Windows
12-------------------
13To compile the search4j.exe executable and install it to C:\Program Files\search4j\bin, run
14
15 nmake /f win32.mak
16 nmake /f win32.mak install
17
18Append BINDIR="SomeOtherPath" to the above commands to control where the executable gets placed at install.
19
20USING SEARCH4J
21--------------
22search4j has three modes: find(default), compare, and launch.
23
24In 'find' mode, search4j searches for a java installation of the requested type and prints some information about it to stdout. By default, it prints the filesystem location of the java installation (i.e., it prints JAVA_HOME or JRE_HOME). The '-e' flag tells search4j to print the full path to the java executable (java or java.exe). The '-v' flag tells search4j to print the version number of the found java installation (E.g., 1.5.0_02). The '-t' flag tells search4j to print the type of the found java installation - whether JRE or JDK. Example command: "search4j -v".
25
26In 'compare' mode, search4j takes a java version number as an argument. As in 'find' mode, search4j searches for a java installation of the requested type, and then compares the version number of the found java to the version number given as an argument, and reports whether the given version represents a newer, older, or equal version of java. Example command: "search4j -c 1.4.0_03".
27
28In 'launch' mode, search4j takes the path of an executable jar file as an argument. It searches for a java installation of the requested type and then launches the given jar file with that installation of java. Example command: "search4j -l myjar.jar".
29
30search4j has several options to control what kind of java installation it looks for:
31The '-m VERSION_STRING' option tells search4j to only search for java installations equal to or newer than the given version.
32The '-d' flag tells search4j to only search for JDK java installations.
33The '-r' flag tells search4j to only search for JRE java installations.
34
35search4j also takes hints about where java might be:
36The '-p LOCATION' (priority hint) option gives search4j a location to look for java first, before executing the default logic for finding java.
37The '-h LOCATION' option gives search4j a location to look for java as a last resort if the default logic for finding java fails.
38
39In windows, you can use the '-w' flag to tell search4j to use the 'javaw.exe' java executable instead of the usual 'java.exe' exectable, which spawns a DOS console. This only affects launch mode and find mode with the '-e' flag.
40
41The '--verbose' gives detailed information about what search4j is doing.
42The '--help' option gives you the quick usage reference.
43
Note: See TracBrowser for help on using the browser.