xref: /glogg/README.md (revision f869e41d2c129cd0f2f3eccb5e9d0d80a5998201)
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## Download
24
25Installers, binaries and source tarballs are available at https://glogg.bonnefon.org/download.html.
26
27## Requirements
28
29* GCC version 4.8.0 or later
30* Qt libraries (version 5.2.0 or later)
31* Boost "program-options" development libraries
32* Markdown HTML processor (optional, to generate HTML documentation)
33
34glogg version 0.9.X still support older versions of gcc and Qt if you need to
35build on an older platform.
36
37## Building
38
39The build system uses qmake. Building and installation is done this way:
40
41```
42tar xzf glogg-X.X.X.tar.gz
43cd glogg-X.X.X
44qmake
45make
46make install INSTALL_ROOT=/usr/local (as root if needed)
47```
48
49`qmake BOOST_PATH=/path/to/boost/` will statically compile the required parts of
50the Boost libraries whose source are found at the specified path.
51The path should be the directory where the tarball from www.boost.org is
52extracted.
53(use this method on Windows or if Boost is not available on the system)
54
55The documentation is built and installed automatically if 'markdown'
56is found.
57
58## Tests
59
60The tests are built using CMake, and require Qt5 and the Google Mocks source.
61
62```
63cd tests
64mkdir build
65cd build
66export QT_DIR=/path/to/qt/if/non/standard
67export GMOCK_HOME=/path/to/gmock
68cmake ..
69make
70./glogg_tests
71```
72
73## Contact
74
75Please visit glogg's website: http://glogg.bonnefon.org/
76
77The development mailing list is hosted at http://groups.google.co.uk/group/glogg-devel
78