mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-05 21:31:08 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Emphasize tool names in their manuals

Browse Source 
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.
This commit is contained in:
Joachim Wuttke (l)
2018-11-15 10:49:42 +01:00
committed by Brad King
parent 3804122ab2
commit f9c3f7b164
5 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Help/manual/ccmake.1.rst
View File

@@ -13,7 +13,7 @@ Synopsis
Description Description
=========== ===========
The "ccmake" executable is the CMake curses interface. Project The **ccmake** executable is the CMake curses interface. Project
configuration settings may be specified interactively through this configuration settings may be specified interactively through this
GUI. Brief instructions are provided at the bottom of the terminal GUI. Brief instructions are provided at the bottom of the terminal
when the program is running. when the program is running.

2
Help/manual/cmake-gui.1.rst
View File

@@ -14,7 +14,7 @@ Synopsis
Description Description
=========== ===========
The "cmake-gui" executable is the CMake GUI. Project configuration The **cmake-gui** executable is the CMake GUI. Project configuration
settings may be specified interactively. Brief instructions are settings may be specified interactively. Brief instructions are
provided at the bottom of the window when the program is running. provided at the bottom of the window when the program is running.

2
Help/manual/cmake.1.rst
View File

@@ -19,7 +19,7 @@ Synopsis
Description Description
=========== ===========
The "cmake" executable is the CMake command-line interface. It may be The **cmake** executable is the CMake command-line interface. It may be
used to configure projects in scripts. Project configuration settings used to configure projects in scripts. Project configuration settings
may be specified on the command line with the -D option. may be specified on the command line with the -D option.

6
Help/manual/cpack.1.rst
View File

@@ -13,10 +13,10 @@ Synopsis
Description Description
=========== ===========
The ``cpack`` executable is the CMake packaging program. It generates The **cpack** executable is the CMake packaging program. It generates
installers and source packages in a variety of formats. installers and source packages in a variety of formats.
For each installer or package format, ``cpack`` has a specific backend, For each installer or package format, **cpack** has a specific backend,
called "generator". A generator is responsible for generating the required called "generator". A generator is responsible for generating the required
inputs and invoking the specific package creation tools. These installer inputs and invoking the specific package creation tools. These installer
or package generators are not to be confused with the makefile generators or package generators are not to be confused with the makefile generators
@@ -28,7 +28,7 @@ list of generators supported for the target platform. Which of them are
to be used can be selected through the :variable:`CPACK_GENERATOR` variable to be used can be selected through the :variable:`CPACK_GENERATOR` variable
or through the command-line option ``-G``. or through the command-line option ``-G``.
The ``cpack`` program is steered by a configuration file written in the The **cpack** program is steered by a configuration file written in the
:manual:`CMake language <cmake-language(7)>`. Unless chosen differently :manual:`CMake language <cmake-language(7)>`. Unless chosen differently
through the command-line option ``--config``, the file ``CPackConfig.cmake`` through the command-line option ``--config``, the file ``CPackConfig.cmake``
in the current directory is used. in the current directory is used.

4
Help/manual/ctest.1.rst
View File

@@ -19,7 +19,7 @@ Synopsis
Description Description
=========== ===========
The "ctest" executable is the CMake test driver program. The **ctest** executable is the CMake test driver program.
CMake-generated build trees created for projects that use the CMake-generated build trees created for projects that use the
ENABLE_TESTING and ADD_TEST commands have testing support. This ENABLE_TESTING and ADD_TEST commands have testing support. This
program will run the tests and report results. program will run the tests and report results.
@@ -38,7 +38,7 @@ Options
``--progress`` ``--progress``
Enable short progress output from tests. Enable short progress output from tests.
When the output of ``ctest`` is being sent directly to a terminal, the When the output of **ctest** is being sent directly to a terminal, the
progress through the set of tests is reported by updating the same line progress through the set of tests is reported by updating the same line
rather than printing start and end messages for each test on new lines. rather than printing start and end messages for each test on new lines.
This can significantly reduce the verbosity of the test output. This can significantly reduce the verbosity of the test output.