Variables
DirectoriesSettings.cmake File Reference

CMake variables of project directories. More...

Go to the source code of this file.

Variables

cmake _BASIS_INSTALL_SITE_PACKAGES
 
cmake _BUNDLE
 
cmake _MODULE
 
cmake _P
 
cmake _PACKAGE
 
cmake _RESET
 
cmake _VENDOR
 
cmake BASIS_INSTALL_SCHEME
 
cmake BINARY_ARCHIVE_DIR
 
cmake BINARY_INCLUDE_DIR
 
cmake BINARY_LIBCONF_DIR
 
cmake BINARY_LIBEXEC_DIR
 
cmake BINARY_LIBRARY_DIR
 
cmake BINARY_RUNTIME_DIR
 
cmake CMAKE_ARCHIVE_OUTPUT_DIRECTORY
 
cmake CMAKE_INSTALL_PREFIX
 
cmake CMAKE_LIBRARY_OUTPUT_DIRECTORY
 
cmake CMAKE_RUNTIME_OUTPUT_DIRECTORY
 
cmake INSTALL_ARCHIVE_DIR
 
cmake INSTALL_CONFIG_DIR
 
cmake INSTALL_DATA_DIR
 
cmake INSTALL_DOC_DIR
 
cmake INSTALL_EXAMPLE_DIR
 
cmake INSTALL_INCLUDE_DIR
 
cmake INSTALL_JYTHON_SITE_DIR
 
cmake INSTALL_LIBEXEC_DIR
 
cmake INSTALL_LIBRARY_DIR
 
cmake INSTALL_MAN_DIR
 
cmake INSTALL_PERL_SITE_DIR
 
cmake INSTALL_PYTHON_SITE_DIR
 
cmake INSTALL_RUNTIME_DIR
 
cmake INSTALL_SHARE_DIR
 
cmake INSTALL_TEXINFO_DIR
 
cmake TESTING_ARCHIVE_DIR
 
cmake TESTING_LIBEXEC_DIR
 
cmake TESTING_LIBRARY_DIR
 
cmake TESTING_OUTPUT_DIR
 
cmake TESTING_RUNTIME_DIR
 
cmake TOPLEVEL_PROJECT_BINARY_DIR
 
cmake TOPLEVEL_PROJECT_SOURCE_DIR
 

Detailed Description

CMake variables of project directories.

This file configures the project directory structure as defined by the Filesystem Hierarchy Standard for BASIS packages.

See also
https://cmake-basis.github.io/standard/fhs/

The project must follow the directory structure as defined by the PROJECT_<*>_DIR variables.

Ideally, when changing the name of one of these directories, only the directory structure of the template needs to be updated. The BASIS CMake functions should not be required to change as they are supposed to use these variables instead of the actual names. Any change of the project directory structure has to be made with care, however, and backwards compatibility to previous releases of BASIS shall be maintained. Consider the use of the TEMPLATE_VERSION if required.

Note
The documentation of the variables can be found in Directories.cmake.in.

Definition in file DirectoriesSettings.cmake.

Variable Documentation

§ _BASIS_INSTALL_SITE_PACKAGES

cmake _BASIS_INSTALL_SITE_PACKAGES

Definition at line 455 of file DirectoriesSettings.cmake.

§ _BUNDLE

cmake _BUNDLE

Definition at line 48 of file DirectoriesSettings.cmake.

§ _MODULE

cmake _MODULE

Definition at line 59 of file DirectoriesSettings.cmake.

§ _P

cmake _P

Definition at line 379 of file DirectoriesSettings.cmake.

§ _PACKAGE

cmake _PACKAGE

Definition at line 57 of file DirectoriesSettings.cmake.

§ _RESET

cmake _RESET

Definition at line 439 of file DirectoriesSettings.cmake.

§ _VENDOR

cmake _VENDOR

Definition at line 53 of file DirectoriesSettings.cmake.

§ BASIS_INSTALL_SCHEME

cmake BASIS_INSTALL_SCHEME

Definition at line 191 of file DirectoriesSettings.cmake.

§ BINARY_ARCHIVE_DIR

cmake BINARY_ARCHIVE_DIR

Definition at line 138 of file DirectoriesSettings.cmake.

§ BINARY_INCLUDE_DIR

cmake BINARY_INCLUDE_DIR

Definition at line 134 of file DirectoriesSettings.cmake.

§ BINARY_LIBCONF_DIR

cmake BINARY_LIBCONF_DIR

Definition at line 141 of file DirectoriesSettings.cmake.

§ BINARY_LIBEXEC_DIR

cmake BINARY_LIBEXEC_DIR

Definition at line 136 of file DirectoriesSettings.cmake.

§ BINARY_LIBRARY_DIR

cmake BINARY_LIBRARY_DIR

Definition at line 137 of file DirectoriesSettings.cmake.

§ BINARY_RUNTIME_DIR

cmake BINARY_RUNTIME_DIR

Definition at line 135 of file DirectoriesSettings.cmake.

§ CMAKE_ARCHIVE_OUTPUT_DIRECTORY

cmake CMAKE_ARCHIVE_OUTPUT_DIRECTORY

Definition at line 154 of file DirectoriesSettings.cmake.

§ CMAKE_INSTALL_PREFIX

cmake CMAKE_INSTALL_PREFIX

Definition at line 173 of file DirectoriesSettings.cmake.

§ CMAKE_LIBRARY_OUTPUT_DIRECTORY

cmake CMAKE_LIBRARY_OUTPUT_DIRECTORY

Definition at line 153 of file DirectoriesSettings.cmake.

§ CMAKE_RUNTIME_OUTPUT_DIRECTORY

cmake CMAKE_RUNTIME_OUTPUT_DIRECTORY

Definition at line 152 of file DirectoriesSettings.cmake.

§ INSTALL_ARCHIVE_DIR

cmake INSTALL_ARCHIVE_DIR

Definition at line 234 of file DirectoriesSettings.cmake.

§ INSTALL_CONFIG_DIR

cmake INSTALL_CONFIG_DIR

Definition at line 227 of file DirectoriesSettings.cmake.

§ INSTALL_DATA_DIR

cmake INSTALL_DATA_DIR

Definition at line 237 of file DirectoriesSettings.cmake.

§ INSTALL_DOC_DIR

cmake INSTALL_DOC_DIR

Definition at line 240 of file DirectoriesSettings.cmake.

§ INSTALL_EXAMPLE_DIR

cmake INSTALL_EXAMPLE_DIR

Definition at line 238 of file DirectoriesSettings.cmake.

§ INSTALL_INCLUDE_DIR

cmake INSTALL_INCLUDE_DIR

Definition at line 232 of file DirectoriesSettings.cmake.

§ INSTALL_JYTHON_SITE_DIR

cmake INSTALL_JYTHON_SITE_DIR

Definition at line 465 of file DirectoriesSettings.cmake.

§ INSTALL_LIBEXEC_DIR

cmake INSTALL_LIBEXEC_DIR

Definition at line 230 of file DirectoriesSettings.cmake.

§ INSTALL_LIBRARY_DIR

cmake INSTALL_LIBRARY_DIR

Definition at line 233 of file DirectoriesSettings.cmake.

§ INSTALL_MAN_DIR

cmake INSTALL_MAN_DIR

Definition at line 285 of file DirectoriesSettings.cmake.

§ INSTALL_PERL_SITE_DIR

cmake INSTALL_PERL_SITE_DIR

Definition at line 469 of file DirectoriesSettings.cmake.

§ INSTALL_PYTHON_SITE_DIR

cmake INSTALL_PYTHON_SITE_DIR

Definition at line 461 of file DirectoriesSettings.cmake.

§ INSTALL_RUNTIME_DIR

cmake INSTALL_RUNTIME_DIR

Definition at line 229 of file DirectoriesSettings.cmake.

§ INSTALL_SHARE_DIR

cmake INSTALL_SHARE_DIR

Definition at line 236 of file DirectoriesSettings.cmake.

§ INSTALL_TEXINFO_DIR

cmake INSTALL_TEXINFO_DIR

Definition at line 286 of file DirectoriesSettings.cmake.

§ TESTING_ARCHIVE_DIR

cmake TESTING_ARCHIVE_DIR

Definition at line 117 of file DirectoriesSettings.cmake.

§ TESTING_LIBEXEC_DIR

cmake TESTING_LIBEXEC_DIR

Definition at line 115 of file DirectoriesSettings.cmake.

§ TESTING_LIBRARY_DIR

cmake TESTING_LIBRARY_DIR

Definition at line 116 of file DirectoriesSettings.cmake.

§ TESTING_OUTPUT_DIR

cmake TESTING_OUTPUT_DIR

Definition at line 113 of file DirectoriesSettings.cmake.

§ TESTING_RUNTIME_DIR

cmake TESTING_RUNTIME_DIR

Definition at line 114 of file DirectoriesSettings.cmake.

§ TOPLEVEL_PROJECT_BINARY_DIR

cmake TOPLEVEL_PROJECT_BINARY_DIR

Definition at line 40 of file DirectoriesSettings.cmake.

§ TOPLEVEL_PROJECT_SOURCE_DIR

cmake TOPLEVEL_PROJECT_SOURCE_DIR

Definition at line 34 of file DirectoriesSettings.cmake.