cgcc.1

   1 .\" cgcc manpage by Josh Triplett
   2 .TH cgcc "1"
   3 .
   4 .SH NAME
   5 cgcc \- Compiler wrapper to run Sparse after compiling
   6 .
   7 .SH SYNOPSIS
   8 .B cgcc
   9 [\fISPARSE OPTIONS\fR]... [\fICOMPILER OPTIONS\fR]... [\fIINPUT FILES\fR]...
  10 .br
  11 .B make CC=cgcc
  12 .
  13 .SH DESCRIPTION
  14 \fBcgcc\fR provides a wrapper around a C compiler (\fBcc\fR by
  15 default) which also invokes the Sparse static analysis tool.
  16 .P
  17 \fBcgcc\fR accepts all Sparse command-line options, such as warning
  18 options, and passes all other options through to the compiler.
  19 .P
  20 By providing the same interface as the C compiler, \fBcgcc\fR allows
  21 projects to run Sparse as part of their build without modifying their
  22 build system, by using \fBcgcc\fR as the compiler.  For many projects,
  23 setting \fBCC=cgcc\fR on the \fBmake\fR command-line will work.
  24 .
  25 .SH ENVIRONMENT
  26 .TP
  27 .B REAL_CC
  28 If set, \fBcgcc\fR will use this as the compiler to invoke, rather
  29 than the default \fBcc\fR.
  30 .
  31 .TP
  32 .B CHECK
  33 If set, \fBcgcc\fR will use this as the Sparse program to invoke,
  34 rather than the default \fBsparse\fR.
  35 .
  36 .SH SEE ALSO
  37 .BR sparse (1)