.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH CBINDGEN "1" "February 2023" "cbindgen 0.24.3" "User Commands"
.SH NAME
cbindgen \- manual page for cbindgen 0.24.3
.SH DESCRIPTION
cbindgen 0.24.3
Generate C bindings for a Rust library
.SS "USAGE:"
.IP
cbindgen [OPTIONS] [INPUT]
.SS "ARGS:"
.TP
<INPUT>
A crate directory or source file to generate bindings for. In general this is the
folder where the Cargo.toml file of source Rust library resides.
.SS "OPTIONS:"
.TP
\fB\-c\fR, \fB\-\-config\fR <PATH>
Specify path to a `cbindgen.toml` config to use
.TP
\fB\-\-clean\fR
Whether to use a new temporary directory for expanding macros.
Affects performance, but might be required in certain build
processes.
.TP
\fB\-\-cpp\-compat\fR
Whether to add C++ compatibility to generated C bindings
.TP
\fB\-\-crate\fR <CRATE_NAME>
If generating bindings for a crate, the specific crate to
generate bindings for
.TP
\fB\-d\fR, \fB\-\-parse\-dependencies\fR
Whether to parse dependencies when generating bindings
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help information
.TP
\fB\-l\fR, \fB\-\-lang\fR <LANGUAGE>
Specify the language to output bindings in [possible values:
c++, C++, c, C, cython, Cython]
.TP
\fB\-\-lockfile\fR <PATH>
Specify the path to the Cargo.lock file explicitly. If this is
not specified, the Cargo.lock file is searched for in the same
folder as the Cargo.toml file. This option is useful for
projects that use workspaces.
.TP
\fB\-\-metadata\fR <PATH>
Specify the path to the output of a `cargo metadata` command
that allows to get dependency information. This is useful
because cargo metadata may be the longest part of cbindgen
runtime, and you may want to share it across cbindgen
invocations. By default cbindgen will run `cargo metadata
\fB\-\-all\-features\fR \fB\-\-format\-version\fR 1 \fB\-\-manifest\-path\fR
<path/to/crate/Cargo.toml>
.TP
\fB\-o\fR, \fB\-\-output\fR <PATH>
The file to output the bindings to
.TP
\fB\-\-only\-target\-dependencies\fR
Only fetch dependencies needed by the target platform. The
target platform defaults to the host platform; set TARGET to
override.
.TP
\fB\-\-profile\fR <PROFILE>
Specify the profile to use when expanding macros. Has no
effect otherwise. [possible values: Debug, debug, Release,
release]
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Report errors only (overrides verbosity options).
.TP
\fB\-s\fR, \fB\-\-style\fR <STYLE>
Specify the declaration style to use for bindings [possible
values: Both, both, Tag, tag, Type, type]
.TP
\fB\-v\fR
Enable verbose logging
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version information
.TP
\fB\-\-verify\fR
Generate bindings and compare it to the existing bindings file
and error if they are different
.SH "SEE ALSO"
The full documentation for
.B cbindgen
is maintained as a Texinfo manual.  If the
.B info
and
.B cbindgen
programs are properly installed at your site, the command
.IP
.B info cbindgen
.PP
should give you access to the complete manual.