81 lines
2.3 KiB
C
81 lines
2.3 KiB
C
|
/*=========================================================================
|
||
|
|
||
|
Program: CMake - Cross-Platform Makefile Generator
|
||
|
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.
|
||
|
|
||
|
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.
|
||
|
|
||
|
=========================================================================*/
|
||
|
#ifndef cmInstallCommand_h
|
||
|
#define cmInstallCommand_h
|
||
|
|
||
|
#include "cmCommand.h"
|
||
|
|
||
|
/** \class cmInstallCommand
|
||
|
* \brief Specifies where to install some files
|
||
|
*
|
||
|
* cmInstallCommand is a general-purpose interface command for
|
||
|
* specifying install rules.
|
||
|
*/
|
||
|
class cmInstallCommand : public cmCommand
|
||
|
{
|
||
|
public:
|
||
|
/**
|
||
|
* This is a virtual constructor for the command.
|
||
|
*/
|
||
|
virtual cmCommand* Clone()
|
||
|
{
|
||
|
return new cmInstallCommand;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* This is called when the command is first encountered in
|
||
|
* the CMakeLists.txt file.
|
||
|
*/
|
||
|
virtual bool InitialPass(std::vector<std::string> const& args);
|
||
|
|
||
|
/**
|
||
|
* The name of the command as specified in CMakeList.txt.
|
||
|
*/
|
||
|
virtual const char* GetName() { return "INSTALL";}
|
||
|
|
||
|
/**
|
||
|
* Succinct documentation.
|
||
|
*/
|
||
|
virtual const char* GetTerseDocumentation()
|
||
|
{
|
||
|
return "Install rule specification interface command.";
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* More documentation.
|
||
|
*/
|
||
|
virtual const char* GetFullDocumentation()
|
||
|
{
|
||
|
return
|
||
|
" INSTALL(SCRIPT <script1> [SCRIPT <script2> [...]])\n"
|
||
|
"Specify rules to run at install time. If SCRIPT is given the "
|
||
|
"file named after it will be included in the install scripts. "
|
||
|
"Multiple SCRIPTs may be given within a single source directory "
|
||
|
"and the scripts will be run in the order given. "
|
||
|
"The processing order of these scripts relative to install rules "
|
||
|
"generated by INSTALL_TARGETS, INSTALL_FILES, and INSTALL_PROGRAMS "
|
||
|
"commands is not specified.\n"
|
||
|
"This command is a placeholder for a future larger interface."
|
||
|
;
|
||
|
}
|
||
|
|
||
|
cmTypeMacro(cmInstallCommand, cmCommand);
|
||
|
};
|
||
|
|
||
|
|
||
|
#endif
|