xref: /glogg/README.md (revision a3ee2aa109d3946096bc912ee5b9a2922b3f4fc0)
1*a3ee2aa1SNicolas Bonnefon
247845dbeSAndre Soaresglogg - the fast, smart log explorer
347845dbeSAndre Soares=====================================
447845dbeSAndre Soares
547845dbeSAndre Soaresglogg is a multi-platform GUI application that helps browse and search
647845dbeSAndre Soaresthrough long and complex log files.  It is designed with programmers and
747845dbeSAndre Soaressystem administrators in mind and can be seen as a graphical, interactive
847845dbeSAndre Soarescombination of grep and less.
947845dbeSAndre Soares
1047845dbeSAndre Soares## Main features
1147845dbeSAndre Soares
1247845dbeSAndre Soares* Runs on Unix-like systems, Windows and Mac thanks to Qt
1347845dbeSAndre Soares* Provides a second window showing the result of the current search
1447845dbeSAndre Soares* Reads UTF-8 and ISO-8859-1 files
1547845dbeSAndre Soares* Supports grep/egrep like regular expressions
1647845dbeSAndre Soares* Colorizes the log and search results
1747845dbeSAndre Soares* Displays a context view of where in the log the lines of interest are
1847845dbeSAndre Soares* Is fast and reads the file directly from disk, without loading it into memory
1947845dbeSAndre Soares* Is open source, released under the GPL
2047845dbeSAndre Soares
2147845dbeSAndre Soares## Requirements
2247845dbeSAndre Soares
2347845dbeSAndre Soares* GCC version 4.8.0 or later
2447845dbeSAndre Soares* Qt libraries (version 5.2.0 or later)
2547845dbeSAndre Soares* Boost "program-options" development libraries
2647845dbeSAndre Soares* Markdown HTML processor (optional, to generate HTML documentation)
2747845dbeSAndre Soares
2847845dbeSAndre Soaresglogg version 0.9.X still support older versions of gcc and Qt if you need to
2947845dbeSAndre Soaresbuild on an older platform.
3047845dbeSAndre Soares
3147845dbeSAndre Soares## Building
3247845dbeSAndre Soares
3347845dbeSAndre SoaresThe build system uses qmake. Building and installation is done this way:
3447845dbeSAndre Soares
35*a3ee2aa1SNicolas Bonnefon```
3647845dbeSAndre Soarestar xzf glogg-X.X.X.tar.gz
3747845dbeSAndre Soarescd glogg-X.X.X
3847845dbeSAndre Soaresqmake
3947845dbeSAndre Soaresmake
4047845dbeSAndre Soaresmake install INSTALL_ROOT=/usr/local (as root if needed)
41*a3ee2aa1SNicolas Bonnefon```
4247845dbeSAndre Soares
43*a3ee2aa1SNicolas Bonnefon`qmake BOOST_PATH=/path/to/boost/` will statically compile the required parts of
4447845dbeSAndre Soaresthe Boost libraries whose source are found at the specified path.
4547845dbeSAndre SoaresThe path should be the directory where the tarball from www.boost.org is
4647845dbeSAndre Soaresextracted.
4747845dbeSAndre Soares(use this method on Windows or if Boost is not available on the system)
4847845dbeSAndre Soares
4947845dbeSAndre SoaresThe documentation is built and installed automatically if 'markdown'
5047845dbeSAndre Soaresis found.
5147845dbeSAndre Soares
5247845dbeSAndre Soares## Tests
5347845dbeSAndre Soares
5447845dbeSAndre SoaresThe tests are built using CMake, and require Qt5 and the Google Mocks source.
5547845dbeSAndre Soares
56*a3ee2aa1SNicolas Bonnefon```
5747845dbeSAndre Soarescd tests
5847845dbeSAndre Soaresmkdir build
5947845dbeSAndre Soarescd build
6047845dbeSAndre Soaresexport QT_DIR=/path/to/qt/if/non/standard
6147845dbeSAndre Soaresexport GMOCK_HOME=/path/to/gmock
6247845dbeSAndre Soarescmake ..
6347845dbeSAndre Soaresmake
6447845dbeSAndre Soares./glogg_tests
65*a3ee2aa1SNicolas Bonnefon```
6647845dbeSAndre Soares
6747845dbeSAndre Soares## Contact
6847845dbeSAndre Soares
6947845dbeSAndre SoaresPlease visit glogg's website: http://glogg.bonnefon.org/
7047845dbeSAndre Soares
7147845dbeSAndre SoaresThe development mailing list is hosted at http://groups.google.co.uk/group/glogg-devel
72