summaryrefslogtreecommitdiffstats
path: root/Source/cmInstallCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmInstallCommand.h')
-rw-r--r--Source/cmInstallCommand.h21
1 files changed, 20 insertions, 1 deletions
diff --git a/Source/cmInstallCommand.h b/Source/cmInstallCommand.h
index e2d451e..4978059 100644
--- a/Source/cmInstallCommand.h
+++ b/Source/cmInstallCommand.h
@@ -105,7 +105,7 @@ public:
" [PERMISSIONS permissions...]\n"
" [CONFIGURATIONS [Debug|Release|...]]\n"
" [COMPONENT <component>]\n"
- " [OPTIONAL]\n"
+ " [OPTIONAL] [NAMELINK_ONLY|NAMELINK_SKIP]\n"
" ] [...])\n"
"The TARGETS form specifies rules for installing targets from a "
"project. There are five kinds of target files that may be "
@@ -140,6 +140,25 @@ public:
"See documentation of the PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE "
"target properties for details."
"\n"
+ "Either NAMELINK_ONLY or NAMELINK_SKIP may be specified as a LIBRARY "
+ "option. "
+ "On some platforms a versioned shared library has a symbolic link "
+ "such as\n"
+ " lib<name>.so -> lib<name>.so.1\n"
+ "where \"lib<name>.so.1\" is the soname of the library and "
+ "\"lib<name>.so\" is a \"namelink\" allowing linkers to find the "
+ "library when given \"-l<name>\". "
+ "The NAMELINK_ONLY option causes installation of only the namelink "
+ "when a library target is installed. "
+ "The NAMELINK_SKIP option causes installation of library files other "
+ "than the namelink when a library target is installed. "
+ "When neither option is given both portions are installed. "
+ "On platforms where versioned shared libraries do not have namelinks "
+ "or when a library is not versioned the NAMELINK_SKIP option installs "
+ "the library and the NAMELINK_ONLY option installs nothing. "
+ "See the VERSION and SOVERSION target properties for details on "
+ "creating versioned shared libraries."
+ "\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 "