Edit

vcpkg print-usage

Synopsis

vcpkg print-usage [options] <package>

Description

The vcpkg print-usage command prints usage information for one installed port. The package must be installed for the selected triplet. See the install command documentation for the accepted <package> syntax.

Port authors can use this command to inspect custom usage information or preview the usage information that vcpkg generates from the installed files.

Examples

Print the usage information that users receive for an installed package:

vcpkg print-usage zlib:x64-windows

Ignore any custom usage file and preview the generated usage information:

vcpkg print-usage --generated zlib:x64-windows

Preview generated usage information without the heuristic warning:

vcpkg print-usage --generated --affirm zlib:x64-windows

Options

All vcpkg commands support a set of common options.

--generated

Print generated usage information even if the port installs a custom usage file.

--affirm

Affirm that the generated usage information is correct and omit the warning that it might be inaccurate from the output.

This option only changes the command's output. To affirm generated usage information in a port, install a usage-accurate marker file.