source: tags/icgrep-0.98/README-icgrep-0.98.txt @ 4400

Last change on this file since 4400 was 4397, checked in by cameron, 4 years ago

icgrep-0.98 notes

File size: 2.2 KB
Line 
1README-icgrep-0.98.txt
2
3This is the open-source version of icgrep 0.98, the alpha test
4version of icgrep 1.0.     
5
6icgrep is a very fast regular expression search program, particularly
7for complex regular expressions.  It is also a very capable engine,
8supporting most common regular expression syntax and many useful
9command line options.   
10
11icgrep 1.0 is designed to offer substantial Unicode support, meeting
12all the Unicode Level 1 requirements of UTS #18, the Unicode
13Technical Standard for regular expressions.
14
15Normal usage to find lines in a file f matching a regexp r is:
16icgrep r f
17
18To produce a count of matching lines only, use the command:
19icgrep -c r f
20
21To read the regexp to be matched from file rf use the command:
22
23icgrep -f rf f
24
25icgrep supports standard egrep syntax, except for Posix character
26classes.   icgrep supports searches using ASCII or UTF-8.
27Unicode property classes are supported, e.g. \p{Ll} matching
28lower case Unicode letters and \P{script=Arab} matching all characters
29that are not in the Arabic script.
30
31BUILD
32
33To build icgrep, you need an installed LLVM system providing the
34core libraries.  The distribution includes a suitable source
35code version of LLVM.   You will also need BOOST, in particular
36the boost system library.
37
38To build LLVM,
39(L1) open a terminal window and cd to the llvm-build directory
40(L2) enter the following command to build the makefiles
41cmake -DCMAKE_INSTALL_PREFIX=../libllvm -DLLVM_TARGETS_TO_BUILD=X86 -DLLVM_BUILD_TOOLS=OFF -DLLVM_BUILD_EXAMPLES=OFF -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER:FILEPATH=/usr/bin/clang++ -DCMAKE_C_COMPILER:FILEPATH=/usr/bin/clang ../llvm-3.5.0.src
42(L3) Still in the llvm-build directory, enter the commands "make" and then "make install"
43
44Using the installed LLVM, building icgrep uses the CMake build
45system generator.
46(IC1)  open a terminal window and cd to the icgrep-build directory
47(IC2)  enter the following command to build the makefiles
48cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER:FILEPATH=/usr/bin/clang++ -DCMAKE_C_COMPILER:FILEPATH=/usr/bin/clang ../icgrep
49(IC3) Enter the command "make"
50
51LLVM files are governed by the LLVM Release License in LLVM-LICENSE.txt.
52icgrep is governed by Open Software License 3.0 in OSL-3.0.txt.
53
Note: See TracBrowser for help on using the repository browser.