Okay, here is a well-structured explanation of CMake's help and command-line options based on the provided documentation snippet.

---

**CMake Command-Line Options and Help System**

CMake provides a comprehensive set of command-line options and a built-in help system to assist users in understanding its usage and configuration. These options can be used with the `cmake` command to retrieve information, control behavior, or invoke specific help topics.

**1. Basic Help and Information**

• **`--help`, `-help`, `-usage`, `-h`, `/?`**: Prints a general usage summary and available options, then exits. This is the most common way to get started with understanding the basic command-line interface.
• *Source:* `Usage describes the basic command line interface and its options.`

• **`--version`, `-version`, `/V`**: Shows the program name and version number banner, then exits. Optionally, writes the version to a specified file.
• *Source:* `--version,-version,/V [file] Show program name/version banner and exit.`

**2. Detailed Help Topics**

CMake allows requesting help on specific manuals, commands, modules, policies, or properties:

• **`--help-full`, `[file]`**: Prints all available CMake manuals (like `cmake-commands(7)`, `cmake-modules(7)`, etc.) in a readable format, then exits. Can optionally write the output to a file.
• *Source:* `--help-full [file] Print all help manuals and exit.`

• **`--help-manual`, `<man>`, `[file]`**: Prints the specified manual (e.g., `cmake-commands(7)`, `cmake-modules(7)`) in a readable format, then exits. Can optionally write the output to a file.
• *Source:* `--help-manual <man> [file] Print one help manual and exit.`

Related Images