xref: /glogg/README.md (revision a3ee2aa109d3946096bc912ee5b9a2922b3f4fc0)
1
2glogg - the fast, smart log explorer
3=====================================
4
5glogg is a multi-platform GUI application that helps browse and search
6through long and complex log files.  It is designed with programmers and
7system administrators in mind and can be seen as a graphical, interactive
8combination of grep and less.
9
10## Main features
11
12* Runs on Unix-like systems, Windows and Mac thanks to Qt
13* Provides a second window showing the result of the current search
14* Reads UTF-8 and ISO-8859-1 files
15* Supports grep/egrep like regular expressions
16* Colorizes the log and search results
17* Displays a context view of where in the log the lines of interest are
18* Is fast and reads the file directly from disk, without loading it into memory
19* Is open source, released under the GPL
20
21## Requirements
22
23* GCC version 4.8.0 or later
24* Qt libraries (version 5.2.0 or later)
25* Boost "program-options" development libraries
26* Markdown HTML processor (optional, to generate HTML documentation)
27
28glogg version 0.9.X still support older versions of gcc and Qt if you need to
29build on an older platform.
30
31## Building
32
33The build system uses qmake. Building and installation is done this way:
34
35```
36tar xzf glogg-X.X.X.tar.gz
37cd glogg-X.X.X
38qmake
39make
40make install INSTALL_ROOT=/usr/local (as root if needed)
41```
42
43`qmake BOOST_PATH=/path/to/boost/` will statically compile the required parts of
44the Boost libraries whose source are found at the specified path.
45The path should be the directory where the tarball from www.boost.org is
46extracted.
47(use this method on Windows or if Boost is not available on the system)
48
49The documentation is built and installed automatically if 'markdown'
50is found.
51
52## Tests
53
54The tests are built using CMake, and require Qt5 and the Google Mocks source.
55
56```
57cd tests
58mkdir build
59cd build
60export QT_DIR=/path/to/qt/if/non/standard
61export GMOCK_HOME=/path/to/gmock
62cmake ..
63make
64./glogg_tests
65```
66
67## Contact
68
69Please visit glogg's website: http://glogg.bonnefon.org/
70
71The development mailing list is hosted at http://groups.google.co.uk/group/glogg-devel
72