xentara-utils v2.1
The Xentara Utility Library
Loading...
Searching...
No Matches
CMake Integration

The Xentara utility library comes with a CMake module named XentaraUtils. To link a target against the Xentara utility library, include the following lines in your CMakeLists.txt file:

find_package(XentaraUtils REQUIRED)
target_link_libraries(myTarget PRIVATE Xentara::xentara-utils)

Replace myTarget with the name of your target.

Targets

Xentara::xentara-utils
  The Xentara utility library
 

Variables

Note
The standard variables set by the find_package() command, like XentaraUtils_FOUND, XentaraUtils_DIR, and XentaraUtils_VERSION, are not described in this documentation. Please refer to the documentation of find_package() for information on the variables that that command sets.
XentaraUtils_DOXYGEN_TAG_FILE
  The location of the Doxygen tag file for the Xentara utility library documentation More...
 
Xentara_PRODUCT_VERSION
  The version of the Xentara product More...
 
Xentara_DEBIAN_PRODUCT_VERSION
  The Debian package version of the Xentara product More...
 
Xentara_RPM_PRODUCT_VERSION
  The RPM package version of the Xentara product More...
 

Variable Documentation

◆ XentaraUtils_DOXYGEN_TAG_FILE

XentaraUtils_DOXYGEN_TAG_FILE

The location of the Doxygen tag file for the Xentara utility library documentation.

This variable contains the path to a Doxygen tag file that can be used to link other Doxygen documentation to the Xentara utility library documentation. See Linking to external documentation in the Doxygen documentation for details.

◆ Xentara_PRODUCT_VERSION

Xentara_PRODUCT_VERSION

The version of the Xentara product.

This variable contains the version of the Xentara product that the included *XentaraUtils* module belongs to. It can be used to generate file names and version numbers for CPack packages, for example.

◆ Xentara_DEBIAN_PRODUCT_VERSION

Xentara_DEBIAN_PRODUCT_VERSION

The Debian package version of the Xentara product.

This variable contains the Debian package version of the Xentara product that the included XentaraUtils modules belong to. It can be used in the CMake variable CPACK_DEBIAN_PACKAGE_DEPENDS or CPACK_DEBIAN_<COMPONENT>_PACKAGE_DEPENDS to add a dependency on the xentara-dev package. You can add a dependency on xentara-dev to the “dev” component, for example, by including the following to your CMakeLists.txt file:

set(CPACK_DEBIAN_DEV_PACKAGE_DEPENDS "xentara-dev (>= ${Xentara_DEBIAN_PRODUCT_VERSION})")

This variable can also be used to add a dependency to the xentara runtime package. It is generally preferrable to enable CPACK_DEBIAN_PACKAGE_SHLIBDEPS to add a dependency to the xentara, package however.

Note
This variable is only available under Linux when targeting a Linux distribution that uses the Debian package manager, like Debian or Ubuntu.

◆ Xentara_RPM_PRODUCT_VERSION

Xentara_RPM_PRODUCT_VERSION

The RPM package version of the Xentara product.

This variable contains the RPM package version of the Xentara product that the included XentaraUtils module belongs to. It can be used in the CMake variable CPACK_RPM_PACKAGE_REQUIRES or CPACK_RPM_<component>_PACKAGE_REQUIRES to add a dependency on the xentara-dev package. You can add a dependency on xentara-devel to the “devel” component, for example, by including the following to your CMakeLists.txt file:

set(CPACK_RPM_DEVEL_PACKAGE_REQUIRES "xentara-devel >= ${Xentara_RPM_PRODUCT_VERSION}"

This variable can also be used to add a dependency to the xentara runtime package. It is generally preferrable to enable CPACK_RPM_PACKAGE_AUTOREQ to add a dependency to the xentara, package however.

Note
This variable is only available under Linux when targeting a Linux distribution that uses the RPM package manager, like Fedora Linux.