summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake.1.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Document `cmake --build` as a separate command mode (#16093)Brad King2016-05-101-18/+34
| | | | | | | The `--build` mode was confusingly documented among other options, falsely implying that it can be used anywhere on the command line. Move the documentation to a dedicated section and clarify its usage as s separate command line mode.
* Help: Document `cmake --find-package` as a separate command modeBrad King2016-05-101-6/+19
|
* Help: Improve 'cmake -E md5sum' documentationBartosz Kosiorek2016-05-021-1/+4
|
* Help: Add missing space in cmake(1) manualBartosz Kosiorek2016-05-021-1/+1
|
* Merge topic 'doc-cmake-E-details'Brad King2016-02-241-4/+8
|\ | | | | | | | | b3475030 Help: Clarify `cmake -E` command behavior with respect to file existence
| * Help: Clarify `cmake -E` command behavior with respect to file existenceBartosz Kosiorek2016-02-191-4/+8
| |
* | cmake: Teach --build to reject multiple --target optionsSebastian Schuberth2016-02-051-0/+1
| | | | | | | | | | | | | | | | | | | | Previously we did not clearly document that `--target` is only supported to be specified once. Even worse, specifying it multiple times would silently ignore any previously specified targets and only build the last target. Update the documentation to specify this. Update the implementation to reject multiple `--target` options to prevent user errors.
* | Help: Fix reference to `cmake --build` in cmake(1) manualBrad King2016-02-051-1/+1
|/
* cmake: Teach -E make_directory to support multiple input directoriesBartosz Kosiorek2015-12-101-4/+6
|
* cmake: Teach -E copy_directory to support multiple input directoriesBartosz Kosiorek2015-12-071-2/+3
|
* cmake: Refine -E copy[_if_different] documentationBartosz Kosiorek2015-12-071-2/+7
|
* cmake: Teach -E copy[_if_different] to support multiple files (#15703)Bartosz Kosiorek2015-12-041-4/+4
| | | | | | If multiple input files are provided then the destination must be a directory. If only one input file is provided then destination may be either a file or directory.
* cmake: Improve '-E' help message formattingBartosz Kosiorek2015-12-041-2/+2
|
* Help: Improve formatting of variable documentationJames Johnston2015-08-211-0/+2
| | | | | | | | Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
* cmake: add --trace-expand optionBen Boeckel2015-07-231-3/+7
| | | | | | | | The --trace option is helpful, but sometimes, what you're looking for is deep under many layers of function calls and figuring out what instance of the function call you're looking at is tedious to determine (usually involving patching and message()). Instead, add a --trace-expand option to trace while expanding commands into what CMake actually sees.
* Help: Spell '-D' option consistently across documentation (#15575)Brad King2015-05-201-1/+1
| | | | | | Always show the option with its argument separate in summary text. State in the main documentation that the option and its argument can be given together too.
* cmake: Teach "-E tar" command a "--format=" optionNils Gladitz2015-04-101-0/+4
| | | | | | | Allows specifying a libarchive defined archive format currently restricted to 7zip, gnutar, pax, paxr and zip. The default is "paxr" (pax restricted).
* Help: Document 'cmake -E <command>' modes in cmake.1 manualBrad King2015-01-261-12/+108
| | | | | Add a dedicated manual section, move the -E command documentation there, and elaborate.
* cmake: Add '-E env' command-line toolBrad King2014-06-231-1/+1
| | | | | | | | | | | | | Extend the cmake command-line interface to support cmake -E env [--unset=NAME]... [NAME=VALUE]... COMMAND [ARG]... This will be useful to run processes with modified environments without using a shell or a full "cmake -P" script to wrap it. Extend the RunCMake.CommandLine test to cover success and failure cases. Inspired-by: Jonathan Bohren <jbo@jhu.edu>
* cmake: Add '-E sleep' commandBrad King2014-01-211-1/+1
| | | | Add a cmake command-line interface to provide a cross-platform 'sleep'.
* Help: Format manual/*.1.rst options as definition listsKitware Robot2013-11-141-74/+89
| | | | | Convert the command-line option documentation formatting from bullet lists to definition lists.
* Merge topic 'remove-cmake-i-wizard'Brad King2013-11-051-2/+1
|\ | | | | | | | | 0fa9aea Help: Drop mention of cmake -i wizard mode
| * Help: Drop mention of cmake -i wizard modeBrad King2013-11-041-2/+1
| | | | | | | | | | The parent commit removed support for this mode, so do not mention it in the documentation.
* | Help: Refine manual/*.1.rst usage summariesBrad King2013-11-041-3/+9
| | | | | | | | | | Use a parsed-literal block to list possible command-line signatures. Add an "Options" section header before the list of options.
* | Help: Glob manual/*.rst in Sphinx configurationBrad King2013-10-301-0/+2
| | | | | | | | | | | | | | Add the man page description line as explicit markup at the top of each Help/manual/*.rst file and scan it from conf.py to automatically generate the man_pages Sphinx configuration value. This reduces the number of places that need to be changed when a new manual is added.
* | Merge topic 'cmake--build-pipes'Brad King2013-10-221-4/+1
|\ \ | | | | | | | | | | | | bcd5de7 cmake: Always pass through stdout/stderr in --build mode
| * | cmake: Always pass through stdout/stderr in --build modeBrad King2013-10-181-4/+1
| | | | | | | | | | | | | | | | | | Enable the --use-stderr behavior by default and ignore the old option. Passing through the pipes allows color terminal output and other things to work as if one ran the native build command directly.
* | | Merge topic 'remove-cmake-i-wizard'Brad King2013-10-221-6/+0
|\ \ \ | | |/ | |/| | | | | | | a8226e9 cmake: Drop support for "-i" wizard mode
| * | cmake: Drop support for "-i" wizard modeBrad King2013-10-181-6/+0
| |/ | | | | | | | | Tell users to pass cache values with the -D option on the command line or use cmake-gui or ccmake.
* | cmake: Drop "cmake -E comspec" Win9x helperBrad King2013-10-191-1/+1
|/ | | | Since we dropped Win9x support there is no need for this helper.
* Make --help-* options available from all command-line toolsBrad King2013-10-161-154/+1
| | | | | | | | | | | Make the standard --help-* options available from all command-line tools. Drop options that are no longer supported: --copyright, --help-full, --help-html, --help-man, --help-compatcommands, --help-custom-modules De-duplicate Help/manual/*.1.rst help options by using an OPTIONS_HELP.txt file included from each manual.
* Help: De-duplicate manual/(cmake|ccmake).1.rst build optionsBrad King2013-10-161-57/+1
| | | | | Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
* Help: Organize manual/*.1.rst sectionsBrad King2013-10-161-24/+8
| | | | | | | Add "Synopsis", "Description", and "See Also" manual page section headers. These are typical of .1 man section pages. Also de-duplicate the See Also section links using a separate LINKS.txt file included from each manual.
* Help: Drop leftover conversion content from manual/*.1.rstBrad King2013-10-161-68/+0
| | | | | Some text in these manuals is left from the old full help transition text generated by the automatic conversion process. Drop it.
* Help: Fix reStructuredText syntax in auto-generated documentsBrad King2013-10-151-0/+1
|
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+441
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
generated by cgit v0.12 at 2025-01-01 12:25:59 (GMT)