diff -r 5593e91823f7 -r 198d4a3e4b73 components/cmake/files/man1/ccmake.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/components/cmake/files/man1/ccmake.1 Wed Nov 11 12:06:59 2015 -0800 @@ -0,0 +1,329 @@ +.\" Man page generated from reStructuredText. +. +.TH "CCMAKE" "1" "October 14, 2015" "3.3.2" "CMake" +.SH NAME +ccmake \- CMake Curses Dialog Command-Line Reference +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ccmake [] ( | ) +.ft P +.fi +.UNINDENT +.UNINDENT +.SH DESCRIPTION +.sp +The "ccmake" executable is the CMake curses interface. Project +configuration settings may be specified interactively through this +GUI. Brief instructions are provided at the bottom of the terminal +when the program is running. +.sp +CMake is a cross\-platform build system generator. Projects specify +their build process with platform\-independent CMake listfiles included +in each directory of a source tree with the name CMakeLists.txt. +Users build a project by using CMake to generate a build system for a +native tool on their platform. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-C \fP +Pre\-load a script to populate the cache. +.sp +When cmake is first run in an empty build tree, it creates a +CMakeCache.txt file and populates it with customizable settings for +the project. This option may be used to specify a file from which +to load cache entries before the first pass through the project\(aqs +cmake listfiles. The loaded entries take priority over the +project\(aqs default values. The given file should be a CMake script +containing SET commands that use the CACHE option, not a +cache\-format file. +.TP +.B \fB\-D :=, \-D =\fP +Create a cmake cache entry. +.sp +When cmake is first run in an empty build tree, it creates a +CMakeCache.txt file and populates it with customizable settings for +the project. This option may be used to specify a setting that +takes priority over the project\(aqs default value. The option may be +repeated for as many cache entries as desired. +.sp +If the \fB:\fP portion is given it must be one of the types +specified by the \fBset()\fP command documentation for its +\fBCACHE\fP signature. +If the \fB:\fP portion is omitted the entry will be created +with no type if it does not exist with a type already. If a +command in the project sets the type to \fBPATH\fP or \fBFILEPATH\fP +then the \fB\fP will be converted to an absolute path. +.sp +This option may also be given as a single argument: +\fB\-D:=\fP or \fB\-D=\fP\&. +.TP +.B \fB\-U \fP +Remove matching entries from CMake cache. +.sp +This option may be used to remove one or more variables from the +CMakeCache.txt file, globbing expressions using * and ? are +supported. The option may be repeated for as many cache entries as +desired. +.sp +Use with care, you can make your CMakeCache.txt non\-working. +.TP +.B \fB\-G \fP +Specify a build system generator. +.sp +CMake may support multiple native build systems on certain +platforms. A generator is responsible for generating a particular +build system. Possible generator names are specified in the +\fBcmake\-generators(7)\fP manual. +.TP +.B \fB\-T \fP +Specify toolset name if supported by generator. +.sp +Some CMake generators support a toolset name to be given to the +native build system to choose a compiler. This is supported only on +specific generators: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +Visual Studio >= 10 +Xcode >= 3.0 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +See native build system documentation for allowed toolset names. +.TP +.B \fB\-A \fP +Specify platform name if supported by generator. +.sp +Some CMake generators support a platform name to be given to the +native build system to choose a compiler or SDK. This is supported only on +specific generators: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +Visual Studio >= 8 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +See native build system documentation for allowed platform names. +.TP +.B \fB\-Wno\-dev\fP +Suppress developer warnings. +.sp +Suppress warnings that are meant for the author of the +CMakeLists.txt files. +.TP +.B \fB\-Wdev\fP +Enable developer warnings. +.sp +Enable warnings that are meant for the author of the CMakeLists.txt +files. +.UNINDENT +.INDENT 0.0 +.TP +.B \fB\-\-help,\-help,\-usage,\-h,\-H,/?\fP +Print usage information and exit. +.sp +Usage describes the basic command line interface and its options. +.TP +.B \fB\-\-version,\-version,/V []\fP +Show program name/version banner and exit. +.sp +If a file is specified, the version is written into it. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-full []\fP +Print all help manuals and exit. +.sp +All manuals are printed in a human\-readable text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-manual []\fP +Print one help manual and exit. +.sp +The specified manual is printed in a human\-readable text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-manual\-list []\fP +List help manuals available and exit. +.sp +The list contains all manuals for which help may be obtained by +using the \fB\-\-help\-manual\fP option followed by a manual name. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-command []\fP +Print help for one command and exit. +.sp +The \fBcmake\-commands(7)\fP manual entry for \fB\fP is +printed in a human\-readable text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-command\-list []\fP +List commands with help available and exit. +.sp +The list contains all commands for which help may be obtained by +using the \fB\-\-help\-command\fP option followed by a command name. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-commands []\fP +Print cmake\-commands manual and exit. +.sp +The \fBcmake\-commands(7)\fP manual is printed in a +human\-readable text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-module []\fP +Print help for one module and exit. +.sp +The \fBcmake\-modules(7)\fP manual entry for \fB\fP is printed +in a human\-readable text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-module\-list []\fP +List modules with help available and exit. +.sp +The list contains all modules for which help may be obtained by +using the \fB\-\-help\-module\fP option followed by a module name. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-modules []\fP +Print cmake\-modules manual and exit. +.sp +The \fBcmake\-modules(7)\fP manual is printed in a human\-readable +text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-policy []\fP +Print help for one policy and exit. +.sp +The \fBcmake\-policies(7)\fP manual entry for \fB\fP is +printed in a human\-readable text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-policy\-list []\fP +List policies with help available and exit. +.sp +The list contains all policies for which help may be obtained by +using the \fB\-\-help\-policy\fP option followed by a policy name. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-policies []\fP +Print cmake\-policies manual and exit. +.sp +The \fBcmake\-policies(7)\fP manual is printed in a +human\-readable text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-property []\fP +Print help for one property and exit. +.sp +The \fBcmake\-properties(7)\fP manual entries for \fB\fP are +printed in a human\-readable text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-property\-list []\fP +List properties with help available and exit. +.sp +The list contains all properties for which help may be obtained by +using the \fB\-\-help\-property\fP option followed by a property name. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-properties []\fP +Print cmake\-properties manual and exit. +.sp +The \fBcmake\-properties(7)\fP manual is printed in a +human\-readable text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-variable []\fP +Print help for one variable and exit. +.sp +The \fBcmake\-variables(7)\fP manual entry for \fB\fP is +printed in a human\-readable text format. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-variable\-list []\fP +List variables with help available and exit. +.sp +The list contains all variables for which help may be obtained by +using the \fB\-\-help\-variable\fP option followed by a variable name. +The help is printed to a named ile if given. +.TP +.B \fB\-\-help\-variables []\fP +Print cmake\-variables manual and exit. +.sp +The \fBcmake\-variables(7)\fP manual is printed in a +human\-readable text format. +The help is printed to a named ile if given. +.UNINDENT +.SH SEE ALSO +.sp +The following resources are available to get help using CMake: +.INDENT 0.0 +.TP +.B Home Page +\fI\%http://www.cmake.org\fP +.sp +The primary starting point for learning about CMake. +.TP +.B Frequently Asked Questions +\fI\%http://www.cmake.org/Wiki/CMake_FAQ\fP +.sp +A Wiki is provided containing answers to frequently asked questions. +.TP +.B Online Documentation +\fI\%http://www.cmake.org/documentation\fP +.sp +Links to available documentation may be found on this web page. +.TP +.B Mailing List +\fI\%http://www.cmake.org/mailing\-lists\fP +.sp +For help and discussion about using cmake, a mailing list is +provided at \fI\%cmake@cmake.org\fP\&. The list is member\-post\-only but one +may sign up on the CMake web page. Please first read the full +documentation at \fI\%http://www.cmake.org\fP before posting questions to +the list. +.UNINDENT +.SH COPYRIGHT +2000-2015 Kitware, Inc. +.\" Generated by docutils manpage writer. +.