summaryrefslogtreecommitdiffstats
path: root/Source/cmInstallCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmInstallCommand.h')
-rw-r--r--Source/cmInstallCommand.h49
1 files changed, 38 insertions, 11 deletions
diff --git a/Source/cmInstallCommand.h b/Source/cmInstallCommand.h
index 586209e..296bc3f 100644
--- a/Source/cmInstallCommand.h
+++ b/Source/cmInstallCommand.h
@@ -64,10 +64,19 @@ public:
"This command generates installation rules for a project. "
"Rules specified by calls to this command within a source directory "
"are executed in order during installation. "
- "The order across directories is not defined.\n"
- "There are multiple signatures for this command:\n"
+ "The order across directories is not defined."
+ "\n"
+ "There are multiple signatures for this command. Some of them define "
+ "installation properties for files and targets. Properties common to "
+ "multiple signatures are covered here. DESTINATION arguments specify "
+ "the directory on disk to which a file will be installed. "
+ "If a full path (with a leading slash or drive letter) is given it "
+ "is used directly. If a relative path is given it is interpreted "
+ "relative to the value of CMAKE_INSTALL_PREFIX."
+ "\n"
+ "The TARGETS signature:\n"
" INSTALL(TARGETS [targets...] [[LIBRARY|RUNTIME]\n"
- " [DESTINATION <destination>]\n"
+ " [DESTINATION <dir>]\n"
" ] [...])\n"
"The TARGETS form specifies rules for installing targets from a "
"project. There are two kinds of target files that may be "
@@ -82,12 +91,8 @@ public:
"apply. If neither is given the installation properties apply to "
"both target types. If only one is given then only targets of that "
"type will be installed (which can be used to install just a DLL or "
- "just an import library).\n"
- "DESTINATION arguments specify the directory on disk to which the "
- "target file will be installed. "
- "If a full path (with a leading slash or drive letter) is given it "
- "is used directly. If a relative path is given it is interpreted "
- "relative to the value of CMAKE_INSTALL_PREFIX.\n"
+ "just an import library)."
+ "\n"
"One or more groups of properties may be specified in a single call "
"to the TARGETS form of this command. A target may be installed more "
"than once to different locations. Consider hypothetical "
@@ -102,12 +107,33 @@ public:
"installed to <prefix>/bin and /some/full/path and its import library "
"will be installed to <prefix>/lib and /some/full/path. On non-DLL "
"platforms mySharedLib will be installed to <prefix>/lib and "
- "/some/full/path.\n"
+ "/some/full/path."
+ "\n"
+ "The FILES signature:\n"
+ " INSTALL(FILES [files...] DESTINATION <dir>)\n"
+ "The FILES form specifies rules for installing files for a "
+ "project. File names given as relative paths are interpreted with "
+ "respect to the current source directory. Files installed by this "
+ "form are given the same permissions as the original file by default."
+ "\n"
+ "The PROGRAMS signature:\n"
+ " INSTALL(PROGRAMS [files...] DESTINATION <dir>)\n"
+ "The PROGRAMS form is identical to the FILES form except that the "
+ "default permissions for the installed file mark it as executable. "
+ "This form is intended to install programs that are not targets, "
+ "such as shell scripts. Use the TARGETS form to install targets "
+ "built within the project."
+ "\n"
+ "The SCRIPT signature:\n"
" INSTALL(SCRIPT <file1> [SCRIPT <file2> [...]])\n"
"The SCRIPT form will invoke the given CMake script files during "
- "installation.\n"
+ "installation. If the script file name is a relative path "
+ "it will be interpreted with respect to the current source directory."
+ "\n"
"NOTE: This command supercedes the INSTALL_TARGETS command and the "
"target properties PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT. "
+ "It also replaces the FILES forms of the INSTALL_FILES and "
+ "INSTALL_PROGRAMS commands. "
"The processing order of these install rules relative to those "
"generated by INSTALL_TARGETS, INSTALL_FILES, and INSTALL_PROGRAMS "
"commands is not defined.\n"
@@ -119,6 +145,7 @@ public:
private:
bool HandleScriptMode(std::vector<std::string> const& args);
bool HandleTargetsMode(std::vector<std::string> const& args);
+ bool HandleFilesMode(std::vector<std::string> const& args);
void ComputeDestination(const char* destination, std::string& dest);
};