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