kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Help/variable/CMAKE_INSTALL_PREFIX.rst

38 lines
1.4 KiB
ReStructuredText
Raw Normal View History

Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
CMAKE_INSTALL_PREFIX
--------------------
Help: Improve formatting of variable documentation Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
2015-08-18 08:34:01 +03:00
Install directory used by :command:`install`.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Improve formatting of variable documentation Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
2015-08-18 08:34:01 +03:00
If ``make install`` is invoked or ``INSTALL`` is built, this directory is
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
prepended onto all install directories. This variable defaults to
Help: Fix CMAKE_INSTALL_PREFIX documented default on Windows Fixes #16211.
2016-08-01 22:28:14 +03:00
``/usr/local`` on UNIX and ``c:/Program Files/${PROJECT_NAME}`` on Windows.
Help: Document CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT variable This variable documentation was simply missing. Suggested-by: Craig Scott <craig.scott@crascit.com>
2016-11-21 19:49:33 +03:00
See :variable:`CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT` for how a
project might choose its own default.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Improve formatting of variable documentation Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
2015-08-18 08:34:01 +03:00
On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the
whole installation. ``DESTDIR`` means DESTination DIRectory. It is
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
commonly used by makefile users in order to install software at
non-default location. It is usually invoked like this:
::
make DESTDIR=/home/john install
which will install the concerned software using the installation
Help: Improve formatting of variable documentation Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
2015-08-18 08:34:01 +03:00
prefix, e.g. ``/usr/local`` prepended with the ``DESTDIR`` value which
finally gives ``/home/john/usr/local``.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Improve formatting of variable documentation Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
2015-08-18 08:34:01 +03:00
WARNING: ``DESTDIR`` may not be used on Windows because installation
prefix usually contains a drive letter like in ``C:/Program Files``
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
which cannot be prepended with some other prefix.
Help: Improve formatting of variable documentation Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
2015-08-18 08:34:01 +03:00
The installation prefix is also added to :variable:`CMAKE_SYSTEM_PREFIX_PATH`
so that :command:`find_package`, :command:`find_program`,
:command:`find_library`, :command:`find_path`, and :command:`find_file`
will search the prefix for other software.
Help: Link to GNUInstallDirs from CMAKE_INSTALL_PREFIX (#15246) Add a note to the CMAKE_INSTALL_PREFIX documentation that refers readers to the GNUInstallDirs module to make the latter easier to discover.
2014-11-12 16:32:01 +03:00
.. note::
Use the :module:`GNUInstallDirs` module to provide GNU-style
options for the layout of directories within the installation.