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 cmUnsetCommand_h
13 #define cmUnsetCommand_h
15 #include "cmCommand.h"
17 /** \class cmUnsetCommand
18 * \brief Unset a CMAKE variable
20 * cmUnsetCommand unsets or removes a variable.
22 class cmUnsetCommand : public cmCommand
26 * This is a virtual constructor for the command.
28 virtual cmCommand* Clone()
30 return new cmUnsetCommand;
34 * This is called when the command is first encountered in
35 * the CMakeLists.txt file.
37 virtual bool InitialPass(std::vector<std::string> const& args,
38 cmExecutionStatus &status);
41 * This determines if the command is invoked when in script mode.
43 virtual bool IsScriptable() const { return true; }
46 * The name of the command as specified in CMakeList.txt.
48 virtual const char* GetName() const {return "unset";}
51 * Succinct documentation.
53 virtual const char* GetTerseDocumentation() const
55 return "Unset a variable, cache variable, or environment variable.";
61 virtual const char* GetFullDocumentation() const
64 " unset(<variable> [CACHE])\n"
65 "Removes the specified variable causing it to become undefined. "
66 "If CACHE is present then the variable is removed from the cache "
67 "instead of the current scope.\n"
68 "<variable> can be an environment variable such as:\n"
69 " unset(ENV{LD_LIBRARY_PATH})\n"
70 "in which case the variable will be removed from the current "
74 cmTypeMacro(cmUnsetCommand, cmCommand);