diff options
| author | Michael Scott <michael.scott250@gmail.com> | 2015-06-04 21:51:22 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-06-08 20:28:31 (GMT) |
| commit | c3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (patch) | |
| tree | 4b76a32ab9bf416fe1b5d5bd60bc68e1f267b3a7 /Help/command/install_programs.rst | |
| parent | d17aa60659a1a69f9101c61a149eca5842291226 (diff) | |
| download | CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.zip CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.gz CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.bz2 | |
Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more
places.
Diffstat (limited to 'Help/command/install_programs.rst')
| -rw-r--r-- | Help/command/install_programs.rst | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/Help/command/install_programs.rst b/Help/command/install_programs.rst index 26789d8..79aa486 100644 --- a/Help/command/install_programs.rst +++ b/Help/command/install_programs.rst @@ -1,13 +1,13 @@ install_programs ---------------- -Deprecated. Use the install(PROGRAMS ) command instead. +Deprecated. Use the :command:`install(PROGRAMS)` command instead. -This command has been superceded by the install command. It is -provided for compatibility with older CMake code. The FILES form is -directly replaced by the PROGRAMS form of the INSTALL command. The -regexp form can be expressed more clearly using the GLOB form of the -FILE command. +This command has been superceded by the :command:`install` command. It is +provided for compatibility with older CMake code. The ``FILES`` form is +directly replaced by the ``PROGRAMS`` form of the :command:`install` +command. The regexp form can be expressed more clearly using the ``GLOB`` +form of the :command:`file` command. :: @@ -15,7 +15,7 @@ FILE command. install_programs(<dir> FILES file1 [file2 ...]) Create rules to install the listed programs into the given directory. -Use the FILES argument to guarantee that the file list version of the +Use the ``FILES`` argument to guarantee that the file list version of the command will be used even when there is only one argument. :: @@ -26,8 +26,9 @@ In the second form any program in the current source directory that matches the regular expression will be installed. This command is intended to install programs that are not built by -cmake, such as shell scripts. See the TARGETS form of the INSTALL -command to create installation rules for targets built by cmake. +cmake, such as shell scripts. See the ``TARGETS`` form of the +:command:`install` command to create installation rules for targets built +by cmake. -The directory <dir> is relative to the installation prefix, which is -stored in the variable CMAKE_INSTALL_PREFIX. +The directory ``<dir>`` is relative to the installation prefix, which is +stored in the variable :variable:`CMAKE_INSTALL_PREFIX`. |