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

98 lines
2.5 KiB
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: CPack 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
cpack(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
cpack -G <generator> [<options>]
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 "cpack" executable is the CMake packaging program.
CMake-generated build trees created for projects that use the
INSTALL_* commands have packaging support. This program will generate
the package.
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
=======
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-G <generator>``
Use the specified generator to generate package.
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
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.
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-C <Configuration>``
Specify the project configuration
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
This option specifies the configuration that the project was build
with, for example 'Debug', 'Release'.
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-D <var>=<value>``
Set a CPack variable.
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
Set a variable that can be used by the generator.
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``--config <config file>``
Specify the config file.
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
Specify the config file to use to create the package. By default
CPackConfig.cmake in the current directory will be used.
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``--verbose,-V``
enable verbose output
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
Run cpack with verbose output.
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``--debug``
enable debug output (for CPack developers)
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
Run cpack with debug output (for CPack developers).
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-P <package name>``
override/define CPACK_PACKAGE_NAME
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
Fix spelling typos in comments and documentation (#16037) The Debian package checker tool (lintian) detected several typos in CMake.
2016-03-29 21:24:20 +03:00
If the package name is not specified on cpack command line
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
thenCPack.cmake defines it as CMAKE_PROJECT_NAME
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-R <package version>``
override/define CPACK_PACKAGE_VERSION
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
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
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-B <package directory>``
override/define CPACK_PACKAGE_DIRECTORY
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
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.
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``--vendor <vendor name>``
override/define CPACK_PACKAGE_VENDOR
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: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
If vendor is not specified on cpack command line (or inside
CMakeLists.txt) thenCPack.cmake defines it with a default value
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