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