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