From f9c3f7b16479f84cde3b0249f83e53a32960dff3 Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (l)" Date: Thu, 15 Nov 2018 10:49:42 +0100 Subject: 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. --- Help/manual/ccmake.1.rst | 2 +- Help/manual/cmake-gui.1.rst | 2 +- Help/manual/cmake.1.rst | 2 +- Help/manual/cpack.1.rst | 6 +++--- Help/manual/ctest.1.rst | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst index cc3ceec..9548471 100644 --- a/Help/manual/ccmake.1.rst +++ b/Help/manual/ccmake.1.rst @@ -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. diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst index 57a9850..9322e33 100644 --- a/Help/manual/cmake-gui.1.rst +++ b/Help/manual/cmake-gui.1.rst @@ -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. diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index b11526c..d8b71a9 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -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. diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst index 9ddab1e..679c547 100644 --- a/Help/manual/cpack.1.rst +++ b/Help/manual/cpack.1.rst @@ -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 `. Unless chosen differently through the command-line option ``--config``, the file ``CPackConfig.cmake`` in the current directory is used. diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index e24b10d..9e0ce27 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -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. -- cgit v0.12