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