Warning, /system/kjournald/README.md is written in an unsupported language. File is not indexed.

0001 # KJournald
0002 
0003 This project aims to provide an abstraction of the systemd's journald API in terms of QAbstractItemModel classes. The main purpose is to ease the integration of journald into Qt based applications (both QML and QtWidget).
0004 
0005 Additional to the library, the project provides a reference implementation of the API, called `kjournaldbrowser`. Even though that application provides a powerful journal database reader, we aim to do a clear split between reuseable library and application logic.
0006 
0007 #### Screenshot
0008 
0009 ![](https://cdn.kde.org/screenshots/kjournald/kjournald.png)
0010 
0011 ## License
0012 All source files in the repository are supposed to be compatible with LGPL-2.1-or-later in order to easily move them between application and library part.
0013 
0014 - SPDX-License-Identifier: LGPL-2.1-or-later OR MIT
0015 - SPDX-FileCopyrightText: 2021 Andreas Cord-Landwehr <cordlandwehr@kde.org>
0016 
0017 ## Library Features
0018 - abstraction for unique query API, which can obtain unique values like list of all boot IDs, list of all units.
0019 - QAbstractItemModel for list of boots
0020 - QAbstractItemModel for full journald DB with filter options per boot and unit
0021 
0022 ### Library Usage
0023 
0024 In your CMakeLists.txt, add:
0025 
0026 ```
0027 find_package(KJournald 0.0.2)
0028 target_link_libraries(mycoolapp
0029     PUBLIC KJournald)
0030 ```
0031 
0032 ## kjournaldbrowser Features
0033 The browser provides a single window overview that can be configured to show a desired combination of systemd units and their prioritized messages.
0034 
0035 - the browser can read journald DB entries via the following ways:
0036     - direct access to a local journald DB folder
0037 - UI filters:
0038     - filter by systemd_unit (also via rainbow colors)
0039     - filter by boot
0040     - filter by priority (also via rainbow colors)
0041     - filter by kernel messages or not
0042 - additional log information:
0043     - time available as UTC
0044 - browsing
0045     - copy current view (CTRL+C)
0046     - key-based navigation
0047         - scroll forward: PAGE_DOWN
0048         - scroll backward: PAGE_UP
0049         - scroll to most recent entry: CTRL+PAGE_DOWN
0050         - scroll to oldest entry: CTRL+PAGE_UP
0051     - highlight search strings
0052 - use "kjournaldbrowser -D <path>" to directly open specific database folder
0053 
0054 ## Library Dependencies
0055 - Qt::Core, Qt::Quick
0056 - systemd