CMake/Source/cmInstallTargetsCommand.h

78 lines
2.2 KiB
C
Raw Normal View History

2001-05-23 19:31:43 +04:00
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
2001-05-23 19:31:43 +04:00
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
2001-05-23 19:31:43 +04:00
2002-01-21 23:30:43 +03:00
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
2001-05-23 19:31:43 +04:00
=========================================================================*/
#ifndef cmInstallTargetsCommand_h
#define cmInstallTargetsCommand_h
#include "cmCommand.h"
/** \class cmInstallTargetsCommand
* \brief Specifies where to install some targets
*
* cmInstallTargetsCommand specifies the relative path where a list of
* targets should be installed. The targets can be executables or
* libraries.
*/
class cmInstallTargetsCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmInstallTargetsCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
2001-05-23 19:31:43 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "INSTALL_TARGETS";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Create install rules for targets.";
2001-05-23 19:31:43 +04:00
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" INSTALL_TARGETS(<dir> [RUNTIME_DIRECTORY dir] target target)\n"
"Create rules to install the listed targets into the given directory. "
"The directory <dir> is relative to the installation prefix, which "
"is stored in the variable CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY "
"specified, then on systems with special runtime files (Windows DLL), "
"the files will be copied to that directory.";
2001-05-23 19:31:43 +04:00
}
cmTypeMacro(cmInstallTargetsCommand, cmCommand);
};
#endif