Warning, /graphics/okular/README.md is written in an unsupported language. File is not indexed.

0001 # Okular – Universal Document Viewer
0002 
0003 Okular can view and annotate documents of various formats, including PDF, Postscript, Comic Book, and various image formats.
0004 It supports native PDF annotations.
0005 
0006 ### Downloads
0007 
0008 For download and installation instructions, see https://okular.kde.org/download.php
0009 
0010 ### User manual
0011 
0012 https://docs.kde.org/?application=okular&branch=stable5
0013 
0014 ### Bugs
0015 
0016 https://bugs.kde.org/buglist.cgi?product=okular
0017 
0018 Please report bugs on Bugzilla (https://bugs.kde.org/enter_bug.cgi?product=okular), and not on our GitLab instance (https://invent.kde.org).
0019 
0020 ### Mailing list
0021 
0022 https://mail.kde.org/mailman/listinfo/okular-devel
0023 
0024 ### Source code
0025 
0026 https://invent.kde.org/graphics/okular.git
0027 
0028 The Okular repository contains the source code for:
0029  * the `okular` desktop application (the “shell”),
0030  * the `okularpart` KParts plugin,
0031  * the `okularkirigami` mobile application,
0032  * several `okularGenerator_xyz` plugins, which provide backends for different document types.
0033 
0034 ### Apidox
0035 
0036 https://api.kde.org/okular/html/index.html
0037 
0038 ## Contributing
0039 
0040 Okular uses the merge request workflow.
0041 Merge requests are required to run pre-commit CI jobs; please don’t push to the master branch directly.
0042 See https://community.kde.org/Infrastructure/GitLab for an introduction.
0043 
0044 ### Build instructions
0045 
0046 Okular can be built like many other applications developed by KDE.
0047 See https://community.kde.org/Get_Involved/development for an introduction.
0048 
0049 If your build environment is set up correctly, you can also build Okular using CMake:
0050 
0051 ```bash
0052 git clone https://invent.kde.org/graphics/okular.git
0053 cd okular
0054 mkdir build
0055 cd build
0056 cmake -DCMAKE_INSTALL_PREFIX=/path/to/your/install/dir ..
0057 make
0058 make install
0059 ```
0060 
0061 Okular also builds tests in the build tree. To run them, you have to run `make install` first.
0062 
0063 If you install Okular in a different path than your system install directory it is possible that you need to run
0064 
0065 ```bash
0066 source prefix.sh
0067 ```
0068 
0069 so that the correct Okular instance and libraries are picked up.
0070 Afterwards one can run `okular` inside the shell instance.
0071 The source command is also required to run the tests manually.
0072 
0073 As stated above, Okular has various build targets.
0074 Two of them are executables.
0075 You can choose which executable to build by passing a flag to CMake:
0076 
0077 ```bash
0078 cmake -DCMAKE_INSTALL_PREFIX=/path/to/your/install/dir -DOKULAR_UI=desktop ..
0079 ```
0080 Available options are `desktop`, `mobile`, and `both`.
0081 
0082 ### clang-format
0083 
0084 The Okular project uses clang-format to enforce source code formatting.
0085 See [README.clang_format](https://invent.kde.org/graphics/okular/-/blob/master/README.clang-format) for more information.