Okular can view and annotate documents of various formats, including PDF, Postscript, Comic Book, and various image formats. It supports native PDF annotations.
For download and installation instructions, visit this link.
The user manual for Okular can be found here.
To view the buglist for Okular, visit this link.
Please report bugs on Bugzilla, and not on our GitLab instance.
To subscribe to Okular-devel, visit this link.
The source code for Okular can be found at this link.
The Okular repository contains source code for:
- The
okulardesktop application (the “shell”), - The
okularpartKParts plugin, - The
okularkirigamimobile application, - Several
okularGenerator_xyzplugins, which provide backends for different document types.
You can visit this link for API documentation.
Okular uses the merge request workflow. Merge requests are required to run pre-commit CI jobs; please don’t push to the master branch directly. See Infrastructure/GitLab for an introduction.
Okular can be built like many other applications developed by KDE. See Get_Involved/development for an introduction.
If your build environment is set up correctly, you can also build Okular using CMake:
git clone https://invent.kde.org/graphics/okular.git
cd okular
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/path/to/your/install/dir ..
make
make installOkular also builds tests in the build tree. To run them, you have to run make install first.
If you install Okular in a different path than your system install directory, it is possible that you need to run
source prefix.shso that the correct Okular instance and libraries are picked up.
Afterwards one can run Okular inside the shell instance.
The source command is also required to run the tests manually.
As stated above, Okular has various build targets and two of them are executables. You can choose which executable to build by passing a flag to CMake:
cmake -DCMAKE_INSTALL_PREFIX=/path/to/your/install/dir -DOKULAR_UI=desktop ..Available options for the flag are desktop, mobile, and both.
The Okular project uses clang-format to enforce source code formatting. See README.clang_format for more information.