1 /*============================================================================
2 CMake - Cross Platform Makefile Generator
3 Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
5 Distributed under the OSI-approved BSD License (the "License");
6 see accompanying file Copyright.txt for details.
8 This software is distributed WITHOUT ANY WARRANTY; without even the
9 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10 See the License for more information.
11 ============================================================================*/
12 #ifndef cmInstallTargetsCommand_h
13 #define cmInstallTargetsCommand_h
15 #include "cmCommand.h"
17 /** \class cmInstallTargetsCommand
18 * \brief Specifies where to install some targets
20 * cmInstallTargetsCommand specifies the relative path where a list of
21 * targets should be installed. The targets can be executables or
24 class cmInstallTargetsCommand : public cmCommand
28 * This is a virtual constructor for the command.
30 virtual cmCommand* Clone()
32 return new cmInstallTargetsCommand;
36 * This is called when the command is first encountered in
37 * the CMakeLists.txt file.
39 virtual bool InitialPass(std::vector<std::string> const& args,
40 cmExecutionStatus &status);
43 * The name of the command as specified in CMakeList.txt.
45 virtual const char* GetName() const { return "install_targets";}
48 * Succinct documentation.
50 virtual const char* GetTerseDocumentation() const
52 return "Deprecated. Use the install(TARGETS ) command instead.";
58 virtual const char* GetFullDocumentation() const
61 "This command has been superceded by the install command. It "
62 "is provided for compatibility with older CMake code.\n"
63 " install_targets(<dir> [RUNTIME_DIRECTORY dir] target target)\n"
64 "Create rules to install the listed targets into the given directory. "
65 "The directory <dir> is relative to the installation prefix, which "
66 "is stored in the variable CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY "
67 "is specified, then on systems with special runtime files "
68 "(Windows DLL), the files will be copied to that directory.";
71 /** This command is kept for compatibility with older CMake versions. */
72 virtual bool IsDiscouraged() const
77 cmTypeMacro(cmInstallTargetsCommand, cmCommand);