honggoff / klogg Goto Github PK

Latest continuous integration builds can be downloaded from releases: windows | linux | mac

klogg is the fork of glogg - the fast, smart log explorer.

From original glogg description:

glogg is a multi-platform GUI application that helps browse and search through long and complex log files. It is designed with programmers and system administrators in mind and can be seen as a graphical, interactive combination of grep and less.

• Runs on Unix-like systems, Windows and Mac thanks to Qt5
• Search results are displayed separately from original file
• Supports Perl-compatible regular expressions
• Colorizes the log and search results
• Displays a context view of where in the log the lines of interest are
• Is fast and reads the file directly from disk, without loading it into memory
• Watches for file changes on disk and reloads it (kind of like tail)
• Is open source, released under the GPL

• Multithreading support for file indexing and regular expression matching
• Log encoding detection using uchardet library (support utf8, utf16, cp1251 and more)
• Limiting search to a part of open file
• In-memory cache of search results per search pattern

klogg is using cmake to generate build files.

• cmake 3.12 or later
• C++ compiler with C++14 support (gcc 5, clang 3.4, msvc 2015)
• Qt libraries (version 5.9 or later: QtCore, QtGui, QtWidgets, QtConcurrent and QtNetwork). QtTest is needed to build and run tests.
• pandoc to build documentation

All other build dependencies are provided in 3rdparty directory.

cd <path_to_project_root>
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_VERSION=X.X.X -DCMAKE_INSTALL_PREFIX=/usr/local ../
cmake --build .
make install (as root if needed)

Binaries are placed into build/output.

Deb or rpm packages can be built with cpack. Run cpack in build directory:

cpack -G DEB
cpack -G RPM

Packages will be placed into build/packages.

See .travis.yml for more information on build process.

Assuming QT5 environment variable contains full path to Qt installation root folder and Visual Studio 2017 Community Edition is used for C++ compiler (vsdevcmd batch file location depends on Visual Studio version):

%QT5%\bin\qtenv2.bat
call "%ProgramFiles(x86)%\Microsoft Visual Studio\2017\Community\Common7\Tools\vsdevcmd" -arch=x64
cd <path_to_project_root>
md build
cd build
cmake -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release -DBUILD_VERSION=X.X.X ../
cmake --build . --config Release

Change cmake generator to "Visual Studio 14 2015" (or "Visual Studio 15 2017" with recent cmake) to get solution files and build from IDE.

Installer can be built with NSIS (requires documentation to be built).

cd <path_to_project_root>
md release
xcopy build\output\klogg.exe release\ /y
xcopy build\output\klogg_tbbmalloc.dll release\ /y
xcopy build\output\klogg_tbbmalloc_proxy.dll release\ /y

xcopy build\output\readme.html release\ /y
xcopy COPYING  release\ /y
xcopy NOTICE   release\ /y

xcopy "%VCToolsRedistDir%x64\Microsoft.VC141.CRT\msvcp140.dll" release\ /y
xcopy "%VCToolsRedistDir%x64\Microsoft.VC141.CRT\vcruntime140.dll" release\ /y

xcopy %QT5%\bin\Qt5Core.dll release\ /y
xcopy %QT5%\bin\Qt5Gui.dll release\ /y
xcopy %QT5%\bin\Qt5Network.dll release\ /y
xcopy %QT5%\bin\Qt5Widgets.dll release\ /y
xcopy %QT5%\bin\Qt5Concurrent.dll release\ /y

md release\platforms
xcopy %QT5%\plugins\platforms\qwindows.dll release\platforms\ /y

makensis -DVERSION=X.X.X -DPLATFORM=x64 packaging\windows\klogg.nsi

See appveyor.yml for more information on build process.

Tests are built by default. To turn them off pass -DBUILD_TESTS:BOOL=OFF to cmake. Tests use catch2 (bundled with klogg sources) and require Qt5Test module. Tests can be run using ctest inside cmake build folder

ctest --build-config Release --verbose

You can reach out to me on github.

Please visit glogg's website: http://glogg.bonnefon.org/

The glogg development mailing list is hosted at http://groups.google.co.uk/group/glogg-devel