summaryrefslogtreecommitdiffstats
path: root/Help/manual/cpack.1.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-11-14 15:05:32 (GMT)
committerBrad King <brad.king@kitware.com>2013-11-14 15:05:32 (GMT)
commit3442f2bcc47ccce86124144423b416b98d589b20 (patch)
tree590e67c1e439cba91173865d8d649c525ba585af /Help/manual/cpack.1.rst
parentd592fc48cd24653ada365a3026e5d7f928955eb5 (diff)
downloadCMake-3442f2bcc47ccce86124144423b416b98d589b20.zip
CMake-3442f2bcc47ccce86124144423b416b98d589b20.tar.gz
CMake-3442f2bcc47ccce86124144423b416b98d589b20.tar.bz2
Help: Format manual/*.1.rst options as definition lists
Convert the command-line option documentation formatting from bullet lists to definition lists.
Diffstat (limited to 'Help/manual/cpack.1.rst')
-rw-r--r--Help/manual/cpack.1.rst74
1 files changed, 42 insertions, 32 deletions
diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst
index 5967d6f..ba2086e 100644
--- a/Help/manual/cpack.1.rst
+++ b/Help/manual/cpack.1.rst
@@ -27,57 +27,67 @@ native tool on their platform.
Options
=======
-* ``-G <generator>``: Use the specified generator to generate package.
+``-G <generator>``
+ Use the specified generator to generate package.
- CPack may support multiple native packaging systems on certain
- platforms. A generator is responsible for generating input files
- for particular system and invoking that systems. Possible generator
- names are specified in the Generators section.
+ CPack may support multiple native packaging systems on certain
+ platforms. A generator is responsible for generating input files
+ for particular system and invoking that systems. Possible generator
+ names are specified in the Generators section.
-* ``-C <Configuration>``: Specify the project configuration
+``-C <Configuration>``
+ Specify the project configuration
- This option specifies the configuration that the project was build
- with, for example 'Debug', 'Release'.
+ This option specifies the configuration that the project was build
+ with, for example 'Debug', 'Release'.
-* ``-D <var>=<value>``: Set a CPack variable.
+``-D <var>=<value>``
+ Set a CPack variable.
- Set a variable that can be used by the generator.
+ Set a variable that can be used by the generator.
-* ``--config <config file>``: Specify the config file.
+``--config <config file>``
+ Specify the config file.
- Specify the config file to use to create the package. By default
- CPackConfig.cmake in the current directory will be used.
+ Specify the config file to use to create the package. By default
+ CPackConfig.cmake in the current directory will be used.
-* ``--verbose,-V``: enable verbose output
+``--verbose,-V``
+ enable verbose output
- Run cpack with verbose output.
+ Run cpack with verbose output.
-* ``--debug``: enable debug output (for CPack developers)
+``--debug``
+ enable debug output (for CPack developers)
- Run cpack with debug output (for CPack developers).
+ Run cpack with debug output (for CPack developers).
-* ``-P <package name>``: override/define CPACK_PACKAGE_NAME
+``-P <package name>``
+ override/define CPACK_PACKAGE_NAME
- If the package name is not specified on cpack commmand line
- thenCPack.cmake defines it as CMAKE_PROJECT_NAME
+ If the package name is not specified on cpack commmand line
+ thenCPack.cmake defines it as CMAKE_PROJECT_NAME
-* ``-R <package version>``: override/define CPACK_PACKAGE_VERSION
+``-R <package version>``
+ override/define CPACK_PACKAGE_VERSION
- If version is not specified on cpack command line thenCPack.cmake
- defines it from CPACK_PACKAGE_VERSION_[MAJOR|MINOR|PATCH]look into
- CPack.cmake for detail
+ If version is not specified on cpack command line thenCPack.cmake
+ defines it from CPACK_PACKAGE_VERSION_[MAJOR|MINOR|PATCH]look into
+ CPack.cmake for detail
-* ``-B <package directory>``: override/define CPACK_PACKAGE_DIRECTORY
+``-B <package directory>``
+ override/define CPACK_PACKAGE_DIRECTORY
- The directory where CPack will be doing its packaging work.The
- resulting package will be found there. Inside this directoryCPack
- creates '_CPack_Packages' sub-directory which is theCPack temporary
- directory.
+ The directory where CPack will be doing its packaging work.The
+ resulting package will be found there. Inside this directoryCPack
+ creates '_CPack_Packages' sub-directory which is theCPack temporary
+ directory.
-* ``--vendor <vendor name>``: override/define CPACK_PACKAGE_VENDOR
+``--vendor <vendor name>``
+ override/define CPACK_PACKAGE_VENDOR
- If vendor is not specified on cpack command line (or inside
- CMakeLists.txt) thenCPack.cmake defines it with a default value
+ If vendor is not specified on cpack command line (or inside
+ CMakeLists.txt) thenCPack.cmake defines it with a default value
.. include:: OPTIONS_HELP.txt