xref: /csrg-svn/old/pcc/cc/cc.1 (revision 50834)

.\" Copyright (c) 1980, 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" %sccs.include.redist.roff%
.\"
.\"	@(#)cc.1	6.7 (Berkeley) 08/09/91
.\"
.Dd
.Dt CC 1
.Os BSD 4
.Sh NAME
.Nm cc
.Nd C compiler
.Sh SYNOPSIS
.Nm cc
.Op  option
Ar ...
.Ar file ...
.Sh DESCRIPTION
.Nm Cc
is the UNIX C compiler.
.Nm Cc
accepts several types of arguments:
.Pp
Arguments whose names end with `.c' are taken to be
C source programs; they are compiled, and
each object program is left on the file
whose name is that of the source with `.o' substituted
for `.c'.
The `.o' file is normally deleted, however, if a single
C program is compiled and loaded all at one go.
.Pp
In the same way,
arguments whose names end with `.s' are taken to be assembly source programs
and are assembled, producing a `.o' file.
.Pp
The following options are interpreted by
.Nm cc .
See
.Xr ld 1
for load-time options.
.Bl -tag -width Ds
.It Fl c
Suppress the loading phase of the compilation, and force
an object file to be produced even if only one program is compiled.
.It Fl g
Have the compiler produce additional symbol table information
for
.Xr dbx 1
Also pass the
.Fl lg
flag to
.Xr ld 1 .
.It Fl go
Have the compiler produce additional symbol table information
for the obsolete debugger
.Xr sdb 1 .
Also pass the
.Fl lg
flag to
.Xr ld 1 .
.It Fl w
Suppress warning diagnostics.
.It Fl p
Arrange for the compiler to produce code
which counts the number of times each routine is called.
If loading takes place, replace the standard startup
routine by one which automatically calls
.Xr monitor 3
at the start and arranges to write out a
.Pa mon.out
file at normal termination of execution of the object program.
An execution profile can then be generated by
use of
.Xr prof 1 .
.It Fl pg
Causes the compiler to produce counting code in the manner of
.Fl p
but invokes a run-time recording mechanism that keeps more
extensive statistics and produces a
.Pa gmon.out
file at normal termination.
Also, a profiling library is searched, in lieu of the standard C library.
An execution profile can then be generated by  use of
.Xr gprof 1 .
.It Fl O
Invoke an
object-code improver.
.It Fl R
Passed on to
.Xr as 1
making initialized variables shared and read-only.
.It Fl S
Compile the named C programs, and leave the
assembler-language output on corresponding files suffixed `.s'.
.It Fl M
Run only the macro preprocessor
on the named C programs,
requesting it to generate Makefile dependencies
and send the result to the standard output.
.It Fl E
Run only the macro preprocessor
on the named C programs, and send the result to the
standard output.
.It Fl C
prevent the macro preprocessor from eliding comments.
.It Fl o Ns Ar output
Name the final output file
.Ar output .
If this option is used the file `a.out' will be left undisturbed.
.El
.Bl -tag -width Ds -compact
.It Fl D Ns Ar name=def
.It Fl D Ns Ar name
Define the
.Ar name
to the preprocessor,
as if by `#define'.
If no definition is given, the name is defined as "1".
.El
.Bl -tag -width Ds
.It Fl U Ns Ar name
Remove any initial definition of
.Ar name .
.It Fl I Ns Ar dir
`#include' files
whose names do not begin with `/'
are always
sought first in the directory
of the
.Ar file
argument,
then in directories named in
.Fl I
options,
then in directories on a standard list.
.It Fl L Ns Ar dir
Library archives are sought first in
directories named in
.Fl L
options,
then in directories on a standard list.
.It Fl f
Use an alternate compiler which does not convert expressions involving
only floats to double. This does not conform to the standard which states
that all intermediate results should be converted to double but does
provide a speed improvement for programs which don't require full double
precision.  This option also makes
.Sy register float
variables work appropriately.
.It Fl B Ns Ar path
Find substitute compiler passes in the named path
with the suffixes cpp, ccom and c2.
.It Fl t Ns Op p012
Find only the designated compiler passes in the
files whose names are constructed by a
.Fl B
option.
.El
.Pp
Other arguments
are taken
to be either loader option arguments, or C-compatible
object programs, typically produced by an earlier
.Nm cc
run,
or perhaps libraries of C-compatible routines.
These programs, together with the results of any
compilations specified, are loaded (in the order
given) to produce an executable program with name
.Pa a.out .
.Sh FILES
.Bl -tag -width /usr/libexec/sccom -compact
.It Pa file.c
Input file.
.It Pa file.o
Object file.
.It Pa a.out
Loaded output.
.It Pa ctm?
Temporary.
.It Pa /usr/bin/cpp
Preprocessor.
.It Pa /usr/libexec/ccom
Compiler.
.It Pa /usr/libexec/ccom
Compiler for single precision floats.
.It Pa /usr/libexec/c2
Optional optimizer.
.It Pa /usr/lib/crt0.o
Runtime startoff.
.It Pa /usr/lib/mcrt0.o
Startoff for profiling.
.It Pa /usr/lib/gcrt0.o
Startoff for gprof-profiling.
.It Pa /usr/lib/libc.a
Standard library, see.
.Xr intro 3 .
.It Pa /usr/lib/libc_p.a
Profiling library, see
.Xr intro 3 .
.It Pa /usr/include
Standard directory for `#include' files.
.It Pa mon.out
File produced for analysis by
.Xr prof 1 .
.It Pa gmon.out
File produced for analysis by
.Xr gprof 1 .
.El
.Sh SEE ALSO
.Xr monitor 3 ,
.Xr prof 1 ,
.Xr gprof 1 ,
.Xr adb 1 ,
.Xr ld 1 ,
.Xr dbx 1 ,
.Xr as 1
.Rs
.%A B. W. Kernighan
.%A D. M. Ritchie
.%T "The Programming Language"
.%I Prentice-Hall
.%D 1978
.Re
.Rs
.%A B. W. Kernighan
.%T "Programming in C \- a tutorial"
.Re
.Rs
.%A D. M. Ritchie
.%T "C Reference Manual"
.Re
.Sh DIAGNOSTICS
The diagnostics produced by C itself are intended to be
self-explanatory.
Occasional messages may be produced by the assembler
or loader.
.Sh HISTORY
The
.Nm \&cc
compiler was distributed with
.At v6 .
.Sh BUGS
The compiler currently ignores advice to put
.Ic char ,
.Ic unsigned char ,
.Ic short ,
.Ic unsigned short ,
.Ic float ,
or
.Ic double
variables in registers, except as noted above.  It previously
produced poor, and in some cases incorrect, code for such declarations.