mirror of
https://github.com/Kitware/CMake.git
synced 2025-12-31 19:00:54 -06:00
Help: Emphasize tool names in their manuals
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:
committed by
Brad King
parent
3804122ab2
commit
f9c3f7b164
@@ -13,7 +13,7 @@ Synopsis
|
||||
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
|
||||
GUI. Brief instructions are provided at the bottom of the terminal
|
||||
when the program is running.
|
||||
|
||||
@@ -14,7 +14,7 @@ Synopsis
|
||||
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
|
||||
provided at the bottom of the window when the program is running.
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ Synopsis
|
||||
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
|
||||
may be specified on the command line with the -D option.
|
||||
|
||||
|
||||
@@ -13,10 +13,10 @@ Synopsis
|
||||
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.
|
||||
|
||||
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
|
||||
inputs and invoking the specific package creation tools. These installer
|
||||
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
|
||||
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
|
||||
through the command-line option ``--config``, the file ``CPackConfig.cmake``
|
||||
in the current directory is used.
|
||||
|
||||
@@ -19,7 +19,7 @@ Synopsis
|
||||
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
|
||||
ENABLE_TESTING and ADD_TEST commands have testing support. This
|
||||
program will run the tests and report results.
|
||||
@@ -38,7 +38,7 @@ Options
|
||||
``--progress``
|
||||
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
|
||||
rather than printing start and end messages for each test on new lines.
|
||||
This can significantly reduce the verbosity of the test output.
|
||||
|
||||
Reference in New Issue
Block a user