The Single UNIX ® Specification, Version 2
Copyright © 1997 The Open Group

 NAME

c89 - compile standard C programs

 SYNOPSIS



c89 [-c][-D name[=value]]...[-E][-g][-I directory] ... [-L directory]
... [-o outfile][-O][-s][-U name] ... operand ...

 DESCRIPTION

The c89 utility is an interface to the standard C compilation system; it will accept source code conforming to the ISO C standard. The system conceptually consists of a compiler and link editor. The files referenced by operands will be compiled and linked to produce an executable file. (It is unspecified whether the linking occurs entirely within the operation of c89; some systems may produce objects that are not fully resolved until the file is executed.)

If the -c option is specified, for all pathname operands of the form file.c the files:


$(basename pathname .c).o

will be created as the result of successful compilation. If the -c option is not specified, it is unspecified whether such .o files are created or deleted for the file.c operands.

If there are no options that prevent link editing (such as -c or -E), and all operands compile and link without error, the resulting executable file will be written according to the -o outfile option (if present) or to the file a.out.

The executable file will be created as specified in the XSH specification, except that the file permissions will be set to:

S_IRWXO | S_IRWXG | S_IRWXU
and that the bits specified by the umask of the process will be cleared.

 OPTIONS

The c89 utility supports the XBD specification, Utility Syntax Guidelines  , except that:

The following options are supported:

-c
Suppress the link-edit phase of the compilation, and do not remove any object files that are produced.
-g
Produce symbolic information in the object or executable files; the nature of this information is unspecified, and may be modified by implementation-dependent interactions with other options.
-s
Produce object or executable files, or both, from which symbolic and other information not required for proper execution using the XSH specification exec family has been removed (stripped). If both -g and -s options are present, the action taken is unspecified.
-o outfile
Use the pathname outfile, instead of the default a.out, for the executable file produced. If the -o option is present with -c or -E, the result is unspecified.
-D name[=value]
Define name as if by a C-language #define directive. If no =value is given, a value of 1 will be used. The -D option has lower precedence than the -U option. That is, if name is used in both a -U and a -D option, name will be undefined regardless of the order of the options. Additional implementation-dependent names may be provided by the compiler. Implementations support at least 2048 bytes of -D definitions and 256 names.
-E
Copy C-language source files to standard output, expanding all preprocessor directives; no compilation will be performed. If any operand is not a text file, the effects are unspecified.
-I directory
Change the algorithm for searching for headers whose names are not absolute pathnames to look in the directory named by the directory pathname before looking in the usual places. Thus, headers whose names are enclosed in double-quotes ("") will be searched for first in the directory of the file with the #include line, then in directories named in -I options, and last in the usual places. For headers whose names are enclosed in angle brackets (<>), the header will be searched for only in directories named in -I options and then in the usual places. Directories named in -I options will be searched in the order specified. Implementations support at least ten instances of this option in a single c89 command invocation.
-L directory
Change the algorithm of searching for the libraries named in the -l objects to look in the directory named by the directory pathname before looking in the usual places. Directories named in -L options will be searched in the order specified. Implementations support at least ten instances of this option in a single c89 command invocation. If a directory specified by a -L option contains files named libc.a, libm.a, libl.a, or liby.a, the results are unspecified.
-O
Optimise. The nature of the optimisation is unspecified.
-U name
Remove any initial definition of name.

Multiple instances of the -D, -I, -U and -L options can be specified.

 OPERANDS

An operand is either in the form of a pathname or the form -l library. At least one operand of the pathname form must be specified. The following operands are supported:
file.c
A C-language source file to be compiled and optionally linked. The operand must be of this form if the -c option is used.
file.a
A library of object files typically produced by the ar utility, and passed directly to the link editor. Implementations may recognise implementation-dependent suffixes other than .a as denoting object file libraries.
file.o
An object file produced by c89 -c and passed directly to the link editor. Implementations may recognise implementation-dependent suffixes other than .o as denoting object files.

The processing of other files is implementation-dependent.

-l library
(The letter ell.) Search the library named:

liblibrary.a

A library will be searched when its name is encountered, so the placement of a -l operand is significant. Several standard libraries can be specified in this manner, as described in the EXTENDED DESCRIPTION section. Implementations may recognise implementation-dependent suffixes other than .a as denoting libraries.

 STDIN

Not used.

 INPUT FILES

The input file must be one of the following: a text file containing a C-language source program; an object file in the format produced by c89 -c or a library of object files, in the format produced by archiving zero or more object files, using ar. Implementations may supply additional utilities that produce files in these formats. Additional input file formats are implementation-dependent.

 ENVIRONMENT VARIABLES

The following environment variables affect the execution of c89:
LANG
Provide a default value for the internationalisation variables that are unset or null. If LANG is unset or null, the corresponding value from the implementation-dependent default locale will be used. If any of the internationalisation variables contains an invalid setting, the utility will behave as if none of the variables had been defined.
LC_ALL
If set to a non-empty string value, override the values of all the other internationalisation variables.
LC_CTYPE
Determine the locale for the interpretation of sequences of bytes of text data as characters (for example, single- as opposed to multi-byte characters in arguments and input files).
LC_MESSAGES
Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard error.
NLSPATH
Determine the location of message catalogues for the processing of LC_MESSAGES .
TMPDIR
Provide a pathname that  will override  the default directory for temporary files, if any.

 ASYNCHRONOUS EVENTS

Default.

 STDOUT

If more than one file operand ending in .c (or possibly other unspecified suffixes) is given, for each such file:

"%s:\n", <file> may be written. These messages, if written, will precede the processing of each input file; they will not be written to the standard output if they are written to the standard error, as described in the STDERR section.

If the -E option is specified, the standard output will be a text file that represents the results of the preprocessing stage of the language; it may contain extra information appropriate for subsequent compilation passes.

 STDERR

Used only for diagnostic messages. If more than one file operand ending in .c (or possibly other unspecified suffixes) is given, for each such file:

"%s:\n", <file> may be written to allow identification of the diagnostic and warning messages with the appropriate input file. These messages, if written, will precede the processing of each input file; they will not be written to the standard error if they are written to the standard output, as described in the STDOUT section.

This utility may produce warning messages about certain conditions that do not warrant returning an error (non-zero) exit value.

 OUTPUT FILES

Object files or executable files or both are produced in unspecified formats.

 EXTENDED DESCRIPTION

 Standard Libraries
The c89 utility recognises the following -l operands for standard libraries:
-l c
This operand makes visible all library functions referenced in the XSH specification with the possible exception of those functions listed as residing in <aio.h>, <math.h>, <mqueue.h>, <pthread.h>, <sched.h>, <semaphore.h>, pthread_atfork() in <unistd.h> and those functions marked as an RT extension in <sys/mman.h> and <time.h>. This operand is not required to be present to cause a search of this library.
-l l
This operand makes visible all functions required by the C-language output of lex that are not made available through the -l c operand.
-l pthread
This operand makes visible all functions referenced in <pthread.h> and pthread_atfork() referenced in <unistd.h>. An implementation may search this library in the absence of this operand.
-l m
This operand makes visible all functions referenced in <math.h>. An implementation may search this library in the absence of this operand.
-l rt
This operand makes visible all functions referenced in <aio.h>, <mqueue.h>, <sched.h> and <semaphore.h>, and those functions marked as an RT extension in <sys/mman.h> and <time.h>. An implementation may search this library in the absence of this operand.
-l y
This operand makes visible all functions required by the C-language output of yacc that are not made available through the -l c operand.

In the absence of options that inhibit invocation of the link editor, such as -c or -E, the c89 utility will cause the equivalent of a -l c operand to be passed to the link editor as the last -l operand, causing it to be searched after all other object files and libraries are loaded.

It is unspecified whether the libraries libc.a, libm.a, librt.a, libpthread.a, libl.a or liby.a exist as regular files. The implementation may accept as -l operands names of objects that do not exist as regular files.

 External Symbols
The C compiler and link editor support the significance of external symbols up to a length of at least 31 bytes; the action taken upon encountering symbols exceeding the implementation-dependent maximum symbol length is unspecified.

The compiler and link editor support a minimum of 511 external symbols per source or object file, and a minimum of 4095 external symbols in total. A diagnostic message will be written to the standard output if the implementation-dependent limit is exceeded; other actions are unspecified.

 Programming Environments

All implementations will support one of the following programming environments as a default. Implementations may support more than one of the following programming environments. Applications can use sysconf() or getconf to determine which programming environments are supported.

Programming Environment
getconf Name
Bits in
int
Bits in
long
Bits in
pointer
Bits in
off_t
_XBS5_ILP32_OFF32 32 32 32 32
_XBS5_ILP32_OFFBIG 32 32 32 >= 64
_XBS5_LP64_OFF64 32 64 64 64
_XBS5_LPBIG_OFFBIG >= 32 >= 64 >= 64 >= 64
 Table: Programming Environments - Type Sizes

Implementations provide configuration strings for C compiler flags, linker/loader flags and libraries for each supported environment. When an application needs to use a specific programming environment rather than the implementation default programming environment while compiling, the application must first verify that the implementation supports the desired environment. If the desired programming environment is supported, the application must then invoke c89 with the appropriate C compiler flags as the first options for the compile, the appropriate linker/loader flags after any other options but before any operands, and the appropriate libraries at the end of the operands.

Portable applications must not attempt to link together object files compiled for different programming models. Applications must also be aware that binary data placed in shared memory or in files might not be recognised by applications built for other programming models.

Programming Environment
getconf Name
Use c89 and cc Arguments
getconf Name
_XBS5_ILP32_OFF32 C Compiler Flags XBS5_ILP32_OFF32_CFLAGS
  Linker/Loader Flags XBS5_ILP32_OFF32_LDFLAGS
  Libraries XBS5_ILP32_OFF32_LIBS
_XBS5_ILP32_OFFBIG C Compiler Flags XBS5_ILP32_OFFBIG_CFLAGS
  Linker/Loader Flags XBS5_ILP32_OFFBIG_LDFLAGS
  Libraries XBS5_ILP32_OFFBIG_LIBS
_XBS5_LP64_OFF64 C Compiler Flags XBS5_LP64_OFF64_CFLAGS
  Linker/Loader Flags XBS5_LP64_OFF64_LDFLAGS
  Libraries XBS5_LP64_OFF64_LIBS
_XBS5_LPBIG_OFFBIG C Compiler Flags XBS5_LPBIG_OFFBIG_CFLAGS
  Linker/Loader Flags XBS5_LPBIG_OFFBIG_LDFLAGS
  Libraries XBS5_LPBIG_OFFBIG_LIBS
Table: Programming Environments - c89 and cc Arguments

 EXIT STATUS

The following exit values are returned:
0
Successful compilation or link edit.
>0
An error occurred.

 CONSEQUENCES OF ERRORS

When c89 encounters a compilation error that causes an object file not to be created, it will write a diagnostic to standard error and continue to compile other source code operands, but it will not perform the link phase and will return a non-zero exit status. If the link edit is unsuccessful, a diagnostic message will be written to standard error and c89 will exit with a non-zero status. A portable application must rely on the exit status of c89, rather than on the existence or mode of the executable file.

 APPLICATION USAGE

Since the c89 utility usually creates files in the current directory during the compilation process, it is typically necessary to run the c89 utility in a directory in which a file can be created.

On systems conforming to the ISO/IEC 9945-2:1993 standard, c89 may be provided only as part of the C-Language Development Option; XSI-conformant systems always provide c89.

Some historical implementations have created .o files when -c is not specified and more than one source file is given. Since this area is left unspecified, the application cannot rely on .o files being created, but it also must be prepared for any related .o files that already exist being deleted at the completion of the link edit.

Some historical implementations have permitted -L options to be interspersed with -l operands on the command line. For an application to compile consistently on systems that do not behave like this, it is necessary for a portable application to supply all -L options before any of the -l options.

There is the possible implication that if a user supplies versions of the standard library functions (before they would be encountered by an implicit -l c or explicit -l m), that those versions would be used in place of the standard versions. There are various reasons this might not be true (functions defined as macros, manipulations for clean name space, and so on), so the existence of files named in the same manner as the standard libraries within the -L directories is explicitly stated to produce unspecified behaviour.

All of the interfaces specified in the XSH specification may be made visible by implementations when the Standard C Library is searched. Portable applications must explicitly request searching the other standard libraries when functions made visible by those libraries are used.

An application strictly portable to the ISO/IEC 9945-2:1993 standard cannot rely on TMPDIR overriding the default temporary directory. On XSI-conformant systems, however, this will always be the case.

 EXAMPLES

The following are examples of usage:
c89 -o foo foo.c
Compiles foo.c and creates the executable file foo.
c89 -c foo.c
Compiles foo.c and creates the object file foo.o.
c89 foo.c
Compiles foo.c and creates the executable file a.out.
c89 foo.c bar.o
Compiles foo.c links it with bar.o, and creates the executable file a.out. Also creates and leaves foo.o.

The following example shows how an application using threads interfaces can test for support of and use a programming environment supporting 32-bit int, long and pointer types and an off_t type using at least 64 bits:


if [ $(getconf _XBS5_ILP32_OFFBIG) != "-1" ]
then
    c89 $(getconf XBS5_ILP32_OFFBIG_CFLAGS) -D_XOPEN_SOURCE=500 \
        $(getconf XBS5_ILP32_OFFBIG_LDFLAGS) foo.c -o foo \
        $(getconf XBS5_ILP32_OFFBIG_LIBS) -l pthread
else
    echo ILP32_OFFBIG programming environment not supported
    exit 1
fi

The following examples clarify the use and interactions of -L options and -l operands:

  1. Consider the case in which module a.c calls function f() in library libQ.a, and module b.c calls function g() in library libp.a. Assume that both libraries reside in /a/b/c. The command line to compile and link in the desired way is:
    
    c89 -L /a/b/c main.o a.c -l Q b.c -l p
    
    
    In this case the -l Q operand need only precede the first -l p operand, since both libQ.a and libp.a reside in the same directory.

  2. Multiple -L operands can be used when library name collisions occur. Building on the previous example, suppose that the user wants to use a new libp.a, in /a/a/a, but still wants f() from /a/b/c/libQ.a:
    
    c89 -L /a/a/a -L /a/b/c main.o a.c -l Q b.c -l p
    
    

    In this example, the linker searches the -L options in the order specified, and finds /a/a/a/libp.a before /a/b/c/libp.a when resolving references for b.c. The order of the -l operands is still important, however.

 FUTURE DIRECTIONS

None.

 SEE ALSO

ar, cc, getconf, make, nm, strip, the XSH specification description of sysconf(), umask.

UNIX ® is a registered Trademark of The Open Group.
Copyright © 1997 The Open Group
[ Main Index | XSH | XCU | XBD | XCURSES | XNS ]