dev/documentation/debug-output.md

0001 <!--
0002 SPDX-License-Identifier: CC-BY-SA-4.0
0003 SPDX-FileCopyrightText: 2018-2023 Johannes Zarl-Zierl <johannes@zarl-zierl.at>
0004 -->
0005
0006 # Getting KPhotoAlbum to print debug output {#debug-output}
0007
0008 KPhotoAlbum uses categorized logging.  By default, only warning messages but no
0009 debug messages are emitted.  To enable addditional output, you can either
0010 enable all debug output (```kphotoalbum*.debug=true```) or have more
0011 fine-grained control by using one or more logging categories listed below.
0012
0013 ## Enable logging using a configuration file
0014
0015 Create or edit the file ```QtProject/qtlogging.ini``` in the generic config location (usually ```~/.config```) containing the following:
0016
0017 ````
0018     [Rules]
0019     kphotoalbum.*.debug=true
0020 ````
0021
0022 ## Enable logging using an environment variable
0023
0024 You can set the environment variable ```QT_LOGGING_RULES``` using the same
0025 syntax as in the configuration file.  Rules are divided by semicolons.
0026
0027 E.g. you can start KPhotoAlbum like this on the commandline:
0028 ````
0029     export QT_LOGGING_RULES='kphotoalbum.*.debug=true'
0030     kphotoalbum
0031 ````
0032
0033 ## Logging Categories in KPhotoAlbum
0034
0035  - ```kphotoalbum```
0036  - ```kphotoalbum.AnnotationDialog```
0037  - ```kphotoalbum.BackgroundJobs```
0038  - ```kphotoalbum.BackgroundTaskManager```
0039  - ```kphotoalbum.Browser```
0040  - ```kphotoalbum.CategoryListView```
0041  - ```kphotoalbum.DateBar```
0042  - ```kphotoalbum.DB```
0043  - ```kphotoalbum.DB.CategoryMatcher```
0044  - ```kphotoalbum.DB.FileOperations```
0045  - ```kphotoalbum.DB.ImageScout```
0046  - ```kphotoalbum.Exif```
0047  - ```kphotoalbum.FastDir```
0048  - ```kphotoalbum.HTMLGenerator```
0049  - ```kphotoalbum.ImageManager```
0050  - ```kphotoalbum.ImportExport```
0051  - ```kphotoalbum.MainWindow```
0052  - ```kphotoalbum.Map```
0053  - ```kphotoalbum.Plugins```
0054  - ```kphotoalbum.RemoteControl```
0055  - ```kphotoalbum.Settings```
0056  - ```kphotoalbum.ThumbnailView```
0057  - ```kphotoalbum.timingInformation```
0058  - ```kphotoalbum.Utilities```
0059  - ```kphotoalbum.Viewer```
0060
0061 ## Further reading
0062
0063  - https://doc.qt.io/qt-5/qloggingcategory.html#details