summaryrefslogtreecommitdiffstats
path: root/Help/manual/ccmake.1.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: cmake (1): put modern configure signature firstscivision2023-02-191-0/+1
| | | | | | | | | | recommend compact, most robust signature first. So many people are still using the multi-step pre-3.13 way of initializing a build. Rather than simply cmake -Bbuild which is one step instead of 3 just to configure a new project.
* Help: Use role `:program:`Alex Turbov2022-11-061-1/+1
| | | | | When mention execitable names use Sphinx semantic role `:program` instead of ``executable`` or **executable**.
* Help: `{<…> | <…>}` → `<…|…>`Alex Turbov2022-08-141-1/+1
| | | | | The form of alternative names for "placeholders" has been used already (e.g., `<file|dir>` in the `cmake(1)` manual).
* Help: Use `option` directive for the executables manual pagesAlex Turbov2022-08-041-0/+2
| | | | | | | It'll allow to refer to a particular option of any executable. There are two "fake" programs added for the CMake script mode (`cmake_P`) and CMake CLI Tool mode (`cmake_E`).
* Help: Improve formatting of Help documentationBartosz Kosiorek2019-04-081-1/+1
|
* Help: Emphasize tool names in their manualsJoachim Wuttke (l)2018-11-261-1/+1
| | | | | | Print the name of the **cmake** executable in boldface, so that it does not appear less prominent than other shell commands (which are underlaid with links). Similarly the other tool manuals.
* Help: Fix command-line synopsis markup syntaxBrad King2018-04-181-1/+1
| | | | | | Use `{}` to surround required parts instead of `()`. Fixes: #17917
* Help: Refine manual/*.1.rst usage summariesBrad King2013-11-041-3/+5
| | | | | 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.
* Make --help-* options available from all command-line toolsBrad King2013-10-161-28/+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-58/+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-23/+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-42/+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/+173
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-24 05:33:34 (GMT)