makefiles.4

创建一个符合iso-9660标准的iso文件系统

. \" %Z%%M%	%I% %E% Copyr 1996 J. Schilling
. \" User Manual page for makefile system
. \"
.if t .ds a \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'a
.if t .ds o \v'-0.55m'\h'0.00n'\z.\h'0.45n'\z.\v'0.55m'\h'-0.45n'o
.if t .ds u \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'u
.if t .ds A \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'A
.if t .ds O \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'O
.if t .ds U \v'-0.77m'\h'0.30n'\z.\h'0.45n'\z.\v'0.77m'\h'-.75n'U
.if t .ds s \(*b
.if t .ds S SS
.if n .ds a ae
.if n .ds o oe
.if n .ds u ue
.if n .ds s sz
.TH makefiles 4L "14. February 1997" "J\*org Schilling" "Schily\'s FILE FORMATS"
.\".TH makefiles 4L "14. February 1997" "J\*org Schilling" "GMD FOKUS FILE FORMATS"
.SH NAME
makefiles \- users guide for compiling projects on different platforms
.SH SYNOPSIS
.B "make [target]
.br
.B "gmake [target]
.br
.B "smake [target]
.br
.PP
Target may be one of:
.TP 10
\&.help
to get a list of possible targets and a short description.
.TP
all
to make the default targets
.TP
install
to make and install the default targets
(see 
.IR INS_BASE " and " INS_KBASE
to learn how to modify the installation path).
.TP
ibins
to make and install a target in 
.I SRCROOT/bins
.TP
depend
to re-make dependency rules for all default targets.
Note: All dependency files will automatically remade 
on the next run of make before they are included.
.TP
clean
to remove 
.I core 
files and all intermediate object files.
.TP
clobber
to remove the targets from
.IR clean ,
all dependency files and all final targets
.TP
distclean
to remove the targets from
.IR clean " and " clobber 
and all made files for all architectures.
.TP
tags
to make 
.IR vi (1)
compatible tags
.TP
TAGS
to make 
.IR emacs (1)
compatible tags
.TP
config
reserved for future use.
.TP
rmtarget
to remove the default target
.TP
relink
to remove the default target and remake it immediately. This can be
used to change .e.g LD_RUN_PATH in the executable.

.SH DESCRIPTION
Makefiles is a set of rules that allows compiling of structured
projects with small and uniformly structured makefiles.
All rules are located in a central directory.
Compiling the projects on different platforms can be done without
the need to modify any of the makefiles that are located
in the projects directories.
.PP
Three make programs are supported:
.IR "Sunpro make" , 
.I "GNU make"
and
.IR smake .
.PP
.I BSDmake
could be supported if it supports pattern matching rules correctly.
.PP
The main design goal was to have a set of small and easy to read
makefiles, each located in the project's leaf directory and therefore 
called
.IR leaf -makefile.
.PP
Each of these 
.IR leaf -makefiles,
in fact contains no rule at all. It simply defines some macros
for the 
.IR make -program
and includes two files from a central make rule depository.
The included files and the files that are recursively included 
define the rules that are needed to compile the project.
.PP
Each 
.IR leaf -makefile
is formed in a really simple way:
.TP
\(bu
It first defines two macros that define the relative location
of the project's root directory and the name of the directory
that contains the complete set of of rules and then includes
the rule file 
.I rules.top
from the directory that forms the central rule depository.
You only have to edit the macro
.I SRCROOT
to reflect the relative location of the project's root directory.
.TP
\(bu
The next part of a 
.IR leaf -makefile
defines macros that describe the target and the source.
You can only have one target per 
.IR leaf -makefile.
Of course, there may be many source files, that are needed to create
that target.
If you want to make more than one target in a specific directory,
you have to put more than one makefile into that directory.
This is the part of a makefile that describes a unique target.
Edit this part to contain all source files, all local include files
and all non global compile time flags that are needed for your target.
For a typical target this is as simple as filling in a form.
.TP
\(bu
Each
.IR leaf -makefile
finally includes a file from the rules directory that contains
rules for the appropriate type of target that is to be made
from this 
.IR leaf -makefile.
.PP
The makefile in each directory has to be called
.IR Makefile .
If you want to have more than one makefile in a specific directory,
you have to choose different names for the other makefiles.
.PP
There are rules for the following type of targets:
.TP 20
commands
The make rules for user level commands like
.IR cat ", " ls 
etc. are located in the file 
.I rules.cmd
.TP
drivers
The make rules for device drivers
are located in the file 
.I rules.drv
.TP
libraries
The make rules for non shared libraries
are located in the file 
.I rules.lib
.TP
shared libraries
The make rules for shared libraries
are located in the file 
.I rules.shl
.TP
localized files
The make rules for localized files
are located in the file 
.I rules.loc
.TP
nonlocalized files
The make rules for non localized files
are located in the file 
.I rules.aux
.TP
shell scripts
The make rules for shell scripts (a variant of localized files)
are located in the file 
.I rules.scr
.TP
manual pages
The make rules for manual pages (a variant of localized files)
are located in the file 
.I rules.man
.TP
diverted makefiles
The make rules for projects that need to have more than
one makefile in a specific directory
are located in the file 
.I rules.mks
It contains a rule that diverts to the listed sub makefiles.
Each sub makefile may be of any type.
.TP
directories
The make rules for sub directories
are located in the file 
.I rules.dir

.SH "Macros/Variables Used In Rules
.PP
The following is a description of the most important macros
used within the make rules.
.I NOTE: 
not all of them might be changed in a specific makefile.
Carefully read the description and change only those macros
that are intended to be used to change the behavior of
the compilation.

.TP 13
ARCHDIR
contains the location where object files and make targets will be placed.
A typical name would be:
.I "OBJ/sparc\-sunos5\-cc
.br
Do not change this macro.
.
.TP
ASFLAGS
The flags that are used with the assembler.
.br
Do not change this macro.
.
.TP
ASMFILES
a list of assembler source files, to be specified in a
leaf makefile.
.
.TP
ASOPTS
The internal macro that contains the flags for the assembler.
Change this macro if you want to change the behavior.
Use: 
.B "ASOPTS= value"
If you want to override the default value. If you want to
override the default assembler flags from the command line
call:
.B "make 'ASOPTS=value'"
Use: 
.B "ASOPTS += value"
If you want to add flags to the default value from within a makefile.
.
.TP
ASOPTX
may be used if you want to add flags to the assembler flags from the
command line. Use:
.B "make 'ASOPTX=value'
.
.TP
C_ARCH
this macro contains the c-compiler architecture name.
.br
Do not change this macro.
.
.TP
CCOM
This macro may be used from the command line to use a different
c-compiler than the default.
Use:
.B "make 'CCOM=gcc'
to use 
.I gcc
for the next run.
Note: The value of 
.I CCOM
must not necessarily be identical to the real name of the c-compiler.
It refers to a filename which contains the definition for that
c-compiler. This hint applies as well to all other macros that deal with
the name of the c-compiler.
The only macro, that contains the real invocation name of the c-compiler,
is 
.IR CC .
.I CC
is set inside the machine dependent configuration file in the central
rules depository and must not be changed elsewhere.
.
.TP
CFILES
a list of C source files, to be specified in a
leaf makefile.
.
.TP
CFLAGS
The flags that are used with the c-compiler.
Do not use flags that belong to the c-preprocessor in the 
.IR COPTOPT ", " COPTS " and " COPTX
macros.
.br
Do not change this macro.
.
.TP
CLEAN_FILES
A list of files ( besides the object files ) that will be
removed with
.IR "make clean" .
.br
Do not change this macro.
.
.TP
CLEAN_FILEX
this macro may be used to define additional files that should
be removed with
.IR "make clean" .
.
.TP
CLOBBER_FILEX
this macro may be used to define additional files that should
be removed with
.IR "make clobber" .
.
.TP
COPTOPT
The c-compiler optimization flag. This flag is intended to 
be overridden either from a makefile or from command line.
.
.TP
COPTS
The internal macro that contains the flags for the c-compiler.
Change this macro if you want to change the behavior.
Use: 
.B "COPTS= value"
If you want to override the default value. If you want to
override the default c-compiler flags from the command line
call:
.B "make 'COPTS=value'"
Use: 
.B "COPTS += value"
If you want to add flags to the default value from within a makefile.
.
.TP
COPTX
may be used if you want to add flags to the c-compiler flags from the
command line. Use:
.B "make 'COPTX=value'
.
.TP
CPPFLAGS
The flags that are used with the c-preprocessor.
This macro as well as:
.IR CPPOPTS " and " CPPOPTX
are also used when compiling c-programs.
They should contain only the following flags:
.IR "\-Dname=value ", " \-Uname " , " 
.IR \-Idirectory " and " \-Ydirectory .
.br
Do not change this macro.
.
.TP
CPPOPTS
The internal macro that contains the flags for the c-preprocessor.
Change this macro if you want to change the behavior.
Use: 
.B "CPPOPTS= value"
If you want to override the default value. If you want to
override the default c-preprocessor flags from the command line
call:
.B "make 'CPPOPTS=value'"
Use: 
.B "CPPOPTS += value"
If you want to add flags to the default value from within a makefile.
.
.TP
CPPOPTX
may be used if you want to add flags to the c-preprocessor flags from the
command line. Use:
.B "make 'CPPOPTX=value'
.
.TP
CURDIR
This macro contains the name of the sub directory that is currently processed.
.br
Do not change this macro.
.
.TP
DEFINSGRP
this macro may be set in the projects defaults file to set up the
default group id for installation 
.TP
DEFINSMODE
this macro may be set in the projects defaults file to set up the
default file permission for installation 
.TP
DEFINSUSR
this macro may be set in the projects defaults file to set up the
default user id for installation 
.TP
DEFUMASK
this macro may be set in the projects defaults file to set up the
default 
.I umask
value for creating sub directories
.
.TP
DEFAULTSDIR
this macro may be set from command line or from the shell environment
if the user wants to use a different set of 
.I Defaults
files that is not located in the directory
.B DEFAULTS
in the source root directory.
This may be used to hold two or more set of defaults that differ e.g. in the
installation path or the C-compiler.
.
.TP
DEFAULTSROOT
this macro may be set in a leaf makefile, if that makefile wants to use
a 
.I Defaults
file that is not located in 
.I $(DEFAULTSDIR)
in the source root.
This may be used, if a sub tree in a big project needs a different setup.
.
.TP
DEFLTSDIR
This is an internally used macro that is set from 
.I $(DEFAULTSDIR) 
or from the internal defaults.
.br
Do not change this macro.
.
.TP
DEFLTSROOT
This is an internally used macro that is set from 
.I $(DEFAULTSROOT) 
or from the internal defaults.
.br
Do not change this macro.
.
.TP
DEFCCOM
the default name of the c-compiler. This is usually set in the file
.I $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults
or 
.IR $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults.$(O_ARCH) .
.
.TP
DEFINCDIRS
a list of directories that are searched by default in addition to 
the system include directories. If this macro is not set, 
.I $(SRCROOT)/include
is used.
.
.TP
DIRNAME
this macro needs to be set in the makefile that is located in
the 
.I "$(SRCROOT)
directory.
The value should be either set to the name of the directory
where the makefile is located or to 
.BR SRCROOT .
The value of this macro is updated automatically 
to follow the directory hierarchy.
Do not change this macro in a make file other than the make file
in the source root.
.
.TP
DIRS
this macro needs to be set in a makefile that is located in
a directory that contains diversion directories.
It must contain a list of directory names where the diversions
go to e.g.
.BR "DIRS= libfoo libbar libgarbage" .
.
.TP
HFILES
for normal operation, 
.I makefiles 
will automatically find which include files are needed
for compilation.
However, if you want to create a tag file that includes
tags for definitions that occur within include files, 
you should set 
.I HFILES
to be a list of include files containing such definitions.
.
.TP
INCDIRS
this macro will normally be a copy from 
.IR DEFINCDIRS .
You may however specify a different value in a leaf makefile
or from command line. This will overwrite the defaults value.
.
.TP
INS_BASE
this macro has to be specified in the file
.I $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults
or 
.IR $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults.$(O_ARCH) .
It must contain the path name of the root for installing 
general targets of the project.
See
.IR INSDIR . 
.
.TP
INS_KBASE
this macro has to be specified in the file
.I $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults
or 
.IR $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults.$(O_ARCH) .
It must contain the path name of the root for installing 
kernel modules from the project.
See
.IR INSDIR .
.
.TP
INSDIR
this macro has to be specified in the leaf makefile.
It must contain the path name of a directory relative to
.IR INS_BASE " or " INS_KBASE .
The target will be installed into
.I "$(INS_BASE)/$(INSDIR)" .
.
.TP
INSGRP
this macro may be set in a leaf makefile to set up the
group id for installation 
.TP
INSMODE
this macro may be set in a leaf makefile to set up the
file permission for installation 
.TP
INSUSR
this macro may be set in a leaf makefile to set up the
user id for installation 
.
.TP
K_ARCH
this macro contains the kernel/machine architecture for the
target machine (e.g.
.IR "sun3 sun4c sun4m sun4u 9000\-725 aviion" ).
It is set to the output of
.I "uname \-m
converted to lower case.
.br
Do not change this macro.
.
.TP
KARCH
this macro contains the kernel/machine architecture for the
target machine (e.g.
.IR "sun3 sun4c sun4m sun4u 9000\-725 aviion" ).
It is set to the output of
.I "uname \-m
converted to lower case.
.br
Do not change this macro unless you want to do a cross compilation.
.
.TP
LDFLAGS
The flags that are used with the linker.
.br
Do not change this macro.
.
.TP
LDLIBS
The internal macro that holds the 
libraries that are used while linking the target.
.br
Do not change this macro.
.
.TP
LDOPTS
The internal macro that contains the flags for the linker.
Change this macro if you want to change the behavior.
Use: 
.B "LDOPTS= value"
If you want to override the default value. If you want to
override the default linker flags from the command line
call:
.B "make 'LDOPTS=value'"
Use: 
.B "LDOPTS += value"
If you want to add flags to the default value from within a makefile.
.
.TP
LDOPTX
may be used if you want to add flags to the linker flags from the
command line. Use:
.B "make 'LDOPTX=value'
.
.TP
LDPATH
the default library search path for the linker. 
This is usually set in the file
.I $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults
or 
.IR $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults.$(O_ARCH) .
.
.TP
LIB_KVM
a predefined macro that contains the operating system dependent
name of a library
that is needed by programs that read/write kernel virtual memory.
Add 
.I "$(LIB_KVM)
to your list of libraries (e.g.
.BR "LIBS= \-lintl $(LIB_KVM)" ),
if your target uses kvm.
.
.TP
LIB_MATH
a predefined macro that contains the operating system dependent
name of a library
that is needed by programs that use routines of the math library.
Add 
.I "$(LIB_MATH)
to your list of libraries (e.g.
.BR "LIBS= \-lintl $(LIB_MATH)" ),
if your target uses math subroutines.
.
.TP
LIB_SOCKET
a predefined macro that contains the operating system dependent
name of a library
that is needed by programs that use socket calls.
Add 
.I "$(LIB_SOCKET)
to your list of libraries (e.g.
.BR "LIBS= \-lintl $(LIB_SOCKET)" ),
if your target uses sockets. Note: this should (for portability reasons)
even be done on systems that don't require a socket library because 
they have the socket interface inside libc.
.
.TP
LIBS_PATH
this macro contains the path to a directory where those
libraries are located, that have been build during
a make run inside the current project.
.br
Do not change this macro.
.
.TP
M_ARCH
this macro contains the machine architecture for the