---
name: "cmake-annotate"
section: "1"
platform: "linux"
package: "cmake-format"
version: "0.6.13-6"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/cmake-annotate"
---

# cmake-annotate(1)

Parse cmake listfiles and re-emit them with semantic annotations in HTML.

## NAME

cmake-annotate - Parse cmake listfiles and re-emit them with semantic annotations in HTML.

## SYNOPSIS

**cmake-annotate** \[-h\] \[--format {page,stub}\] \[-o OUTFILE\_PATH\] \[-c CONFIG\_FILE\] infilepath \[infilepath ...\]

## DESCRIPTION

Parse cmake listfiles and re-emit them with semantic annotations in HTML.

Some options regarding parsing are configurable by providing a configuration file. The configuration file format is the same as that used by cmake-format, and the same file can be used for both programs.

cmake-format can spit out the default configuration for you as starting point for customization. Run with \`--dump-config \[yaml\|json\|python\]\`.

- **infilepaths**

  ## OPTIONS

- **-v**, **--version**

  show program's version number and exit

- **-f** *{page,stub,iframe}*, **--format** *{page,stub,iframe}*

  whether to output a standalone \`page\` complete with \<html\>\</html\> tags, or just the annotated content

- **-o** *OUTFILE\_PATH*, **--outfile-path** *OUTFILE\_PATH*

  Where to write the formatted file. Default is stdout.

- **-c** *CONFIG\_FILE*, **--config-file** *CONFIG\_FILE*

  path to configuration file

## AUTHOR

```
Josh Bialkowski
```

```
josh.bialkowski@gmail.com
```

## DISTRIBUTION

The latest version of cmake-annotate may be downloaded from ⟨https://github.com/cheshirekow/cmake\_format⟩