summaryrefslogtreecommitdiff
path: root/Help/envvar
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2018-04-20 08:38:00 -0400
committerKyle Edwards <kyle.edwards@kitware.com>2018-04-20 08:39:02 -0400
commitfcf64866dad8ce239382df5d6fde01f90ccc7e63 (patch)
treee85e0dac6164ca0b4c4703947039956cbe5b7485 /Help/envvar
parentfe0082875aeecead23b2351629abca4990dfba43 (diff)
downloadcmake-fcf64866dad8ce239382df5d6fde01f90ccc7e63.tar.gz
Help: move DESTDIR into a separate page
Diffstat (limited to 'Help/envvar')
-rw-r--r--Help/envvar/DESTDIR.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/Help/envvar/DESTDIR.rst b/Help/envvar/DESTDIR.rst
new file mode 100644
index 0000000000..87f1115c45
--- /dev/null
+++ b/Help/envvar/DESTDIR.rst
@@ -0,0 +1,19 @@
+DESTDIR
+-------
+
+On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the
+whole installation. ``DESTDIR`` means DESTination DIRectory. It is
+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
+prefix, e.g. ``/usr/local`` prepended with the ``DESTDIR`` value which
+finally gives ``/home/john/usr/local``.
+
+WARNING: ``DESTDIR`` may not be used on Windows because installation
+prefix usually contains a drive letter like in ``C:/Program Files``
+which cannot be prepended with some other prefix.