KLatexFormula Documentation

Portable KLatexFormula Application

In response to user feedback, it is now possible (since version 4.0.0) to use KLatexFormula as a portable application (e.g. from a USB drive).

Resources to be located at run-time

KLatexFormula needs to locate some resources at runtime. These are

  • paths to temporary directory, LaTeX executables etc.

  • home config directory (typically ~/.klatexformula/)

    Your personal library as well as your user preferences are saved here. This directory should be writable.

  • shared data directory (typically /usr/share/klatexformula on Linux)

    Keeps files common for all users, such as user scripts or other data files. This directory may be only read-only.

Overriding default paths

It is possible to override the default paths for the above resources.

Relative paths for the temporary directory and the program paths are interpreted as relative to the current working directory.

Paths for the home config dir and the shared data dir behave a little differently. Paths may start with ~/, which expands to the user’s home directory (on all platforms). Non-absolute paths are interpreted as relative to the application executable location, and not relative to the current working directory. At compile-time, the preprocessor defines KLF_SHARE_DIR and KLF_HOME_CONFIG_DIR may be used to override defaults. CMake already sets KLF_SHARE_DIR based on the installation paths. At run-time, the environment variables KLF_SHARE_DIR and KLF_HOME_CONFIG_DIR may be set to override any paths set at compile time or any other default paths.