kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Help/manual/ccmake.1.rst

38 lines
883 B
ReStructuredText
Raw Normal View History

Help: Glob manual/*.rst in Sphinx configuration 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.
2013-10-30 17:58:25 +04:00
.. cmake-manual-description: CMake Curses Dialog Command-Line Reference
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
ccmake(1)
*********
Help: Organize manual/*.1.rst sections 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.
2013-10-16 18:25:43 +04:00
Synopsis
========
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Refine manual/*.1.rst usage summaries Use a parsed-literal block to list possible command-line signatures. Add an "Options" section header before the list of options.
2013-11-04 20:03:33 +04:00
.. parsed-literal::
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Refine manual/*.1.rst usage summaries Use a parsed-literal block to list possible command-line signatures. Add an "Options" section header before the list of options.
2013-11-04 20:03:33 +04:00
ccmake [<options>] (<path-to-source> | <path-to-existing-build>)
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Organize manual/*.1.rst sections 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.
2013-10-16 18:25:43 +04:00
Description
===========
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
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.
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.
Help: Refine manual/*.1.rst usage summaries Use a parsed-literal block to list possible command-line signatures. Add an "Options" section header before the list of options.
2013-11-04 20:03:33 +04:00
Options
=======
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
.. include:: OPTIONS_BUILD.txt
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Make --help-* options available from all command-line tools 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.
2013-10-16 20:54:52 +04:00
.. include:: OPTIONS_HELP.txt
Help: Fix reStructuredText syntax in auto-generated documents
2013-09-12 19:41:36 +04:00
Help: Organize manual/*.1.rst sections 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.
2013-10-16 18:25:43 +04:00
See Also
========
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Organize manual/*.1.rst sections 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.
2013-10-16 18:25:43 +04:00
.. include:: LINKS.txt