.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.3.
.TH INCLUDE-WHAT-YOU-USE "1" "June 2021" "include-what-you-use 8.16-1~exp1" "User Commands"
.SH NAME
include-what-you-use \- Analyze #includes in C and C++ source files
.SH DESCRIPTION
USAGE: include\-what\-you\-use [\-Xiwyu \fB\-\-iwyu_opt]\fR... <clang opts> <source file>
Here are the <iwyu_opts> you can specify (e.g. \fB\-Xiwyu\fR \fB\-\-verbose\fR=\fI\,3\/\fR):
.HP
\fB\-\-check_also=\fR<glob>: tells iwyu to print iwyu\-violation info
.IP
for all files matching the given glob pattern (in addition
to the default of reporting for the input .cc file and its
associated .h files).  This flag may be specified multiple
times to specify multiple glob patterns.
.HP
\fB\-\-keep=\fR<glob>: tells iwyu to always keep these includes.
.IP
This flag may be specified multiple times to specify
multiple glob patterns.
.HP
\fB\-\-mapping_file=\fR<filename>: gives iwyu a mapping file.
.HP
\fB\-\-no_default_mappings\fR: do not add iwyu's default mappings.
.HP
\fB\-\-pch_in_code\fR: mark the first include in a translation unit as a
.TP
precompiled header.
Use \fB\-\-pch_in_code\fR to prevent IWYU from
.TP
removing necessary PCH includes.
Though Clang forces PCHs
.IP
to be listed as prefix headers, the PCH\-in\-code pattern can
be used with GCC and is standard practice on MSVC
(e.g. stdafx.h).
.HP
\fB\-\-prefix_header_includes=\fR<value>: tells iwyu what to do with
.IP
in\-source includes and forward declarations involving
prefix headers.  Prefix header is a file included via
command\-line option \fB\-include\fR.  If prefix header makes
include or forward declaration obsolete, presence of such
include can be controlled with the following values
.TP
add:
new lines are added
.TP
keep:
new lines aren't added, existing are kept intact
.IP
remove: new lines aren't added, existing are removed
.IP
Default value is 'add'.
.HP
\fB\-\-transitive_includes_only\fR: do not suggest that a file add
.IP
foo.h unless foo.h is already visible in the file's
transitive includes.
.HP
\fB\-\-max_line_length\fR: maximum line length for includes.
.IP
Note that this only affects comments and alignment thereof,
the maximum line length can still be exceeded with long
file names (default: 80).
.HP
\fB\-\-no_comments\fR: do not add 'why' comments.
.HP
\fB\-\-no_fwd_decls\fR: do not use forward declarations.
.HP
\fB\-\-verbose=\fR<level>: the higher the level, the more output.
.HP
\fB\-\-quoted_includes_first\fR: when sorting includes, place quoted
.IP
ones first.
.HP
\fB\-\-cxx17ns\fR: suggests the more concise syntax introduced in C++17
.PP
In addition to IWYU\-specific options you can specify the following
options without \fB\-Xiwyu\fR prefix:
.HP
\fB\-\-help\fR: prints this help and exits.
.HP
\fB\-\-version\fR: prints version and exits.