MAN page from Old RedHat 6.X cdrecord-1.9a05-1.i386.rpm

makefiles

Section: Schily\'s FILE FORMATS (4L)
Updated: 14. February 1997
Index

NAME

makefiles - users guide for compiling projects on different platforms

SYNOPSIS

make [target]
gmake [target]
smake [target]

Target may be one of:

.help: to get a list of possible targets and a short description.
all: to make the default targets
install: to make and install the default targets(see INS_BASE and INS_KBASEto learn how to modify the installation path).
ibins: to make and install a target in SRCROOT/bins
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.
clean: to remove core files and all intermediate object files.
clobber: to remove the targets fromclean,all dependency files and all final targets
distclean: to remove the targets fromclean and clobberand all made files for all architectures.
tags: to make vi(1)compatible tags
TAGS: to make emacs(1)compatible tags
config: reserved for future use.
rmtarget: to remove the default target
relink: to remove the default target and remake it immediately. This can beused to change .e.g LD_RUN_PATH in the executable.

DESCRIPTION

Makefiles is a set of rules that allows compiling of structuredprojects with small and uniformly structured makefiles.All rules are located in a central directory.Compiling the projects on different platforms can be done withoutthe need to modify any of the makefiles that are locatedin the projects directories.

Three make programs are supported:Sunpro make,GNU makeandsmake.

BSDmakecould be supported if it supports pattern matching rules correctly.

The main design goal was to have a set of small and easy to readmakefiles, each located in the project's leaf directory and therefore calledleaf-makefile.

Each of these leaf-makefiles,in fact contains no rule at all. It simply defines some macrosfor the make-programand 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.

Each leaf-makefileis formed in a really simple way:

*: It first defines two macros that define the relative locationof the project's root directory and the name of the directorythat contains the complete set of of rules and then includesthe rule file rules.topfrom the directory that forms the central rule depository.You only have to edit the macroSRCROOTto reflect the relative location of the project's root directory.
*: The next part of a leaf-makefiledefines macros that describe the target and the source.You can only have one target per leaf-makefile.Of course, there may be many source files, that are needed to createthat 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 filesand 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.
*: Eachleaf-makefilefinally includes a file from the rules directory that containsrules for the appropriate type of target that is to be madefrom this leaf-makefile.

The makefile in each directory has to be calledMakefile.If you want to have more than one makefile in a specific directory,you have to choose different names for the other makefiles.

There are rules for the following type of targets:

commands: The make rules for user level commands likecat, lsetc. are located in the file rules.cmd
drivers: The make rules for device driversare located in the file rules.drv
libraries: The make rules for non shared librariesare located in the file rules.lib
shared libraries: The make rules for shared librariesare located in the file rules.shl
localized files: The make rules for localized filesare located in the file rules.loc
nonlocalized files: The make rules for non localized filesare located in the file rules.aux
shell scripts: The make rules for shell scripts (a variant of localized files)are located in the file rules.scr
manual pages: The make rules for manual pages (a variant of localized files)are located in the file rules.man
diverted makefiles: The make rules for projects that need to have more thanone makefile in a specific directoryare located in the file rules.mksIt contains a rule that diverts to the listed sub makefiles.Each sub makefile may be of any type.
directories: The make rules for sub directoriesare located in the file rules.dir

Macros/Variables Used In Rules

The following is a description of the most important macrosused within the make rules.NOTE: not all of them might be changed in a specific makefile.Carefully read the description and change only those macrosthat are intended to be used to change the behavior ofthe compilation.

ARCHDIR: contains the location where object files and make targets will be placed.A typical name would be:OBJ/sparc-sunos5-cc
Do not change this macro.
ASFLAGS: The flags that are used with the assembler.
Do not change this macro.
ASMFILES: a list of assembler source files, to be specified in aleaf makefile.
ASOPTS: The internal macro that contains the flags for the assembler.Change this macro if you want to change the behavior.Use: ASOPTS= valueIf you want to override the default value. If you want tooverride the default assembler flags from the command linecall:make 'ASOPTS=value'Use: ASOPTS += valueIf you want to add flags to the default value from within a makefile.
ASOPTX: may be used if you want to add flags to the assembler flags from thecommand line. Use:make 'ASOPTX=value'
C_ARCH: this macro contains the c-compiler architecture name.
Do not change this macro.
CCOM: This macro may be used from the command line to use a differentc-compiler than the default.Use:make 'CCOM=gcc'to use gccfor the next run.Note: The value of CCOMmust not necessarily be identical to the real name of the c-compiler.It refers to a filename which contains the definition for thatc-compiler. This hint applies as well to all other macros that deal withthe name of the c-compiler.The only macro, that contains the real invocation name of the c-compiler,is CC.CCis set inside the machine dependent configuration file in the centralrules depository and must not be changed elsewhere.
CFILES: a list of C source files, to be specified in aleaf makefile.
CFLAGS: The flags that are used with the c-compiler.Do not use flags that belong to the c-preprocessor in the COPTOPT, COPTS and COPTXmacros.
Do not change this macro.
CLEAN_FILES: A list of files ( besides the object files ) that will beremoved withmake clean.
Do not change this macro.
CLEAN_FILEX: this macro may be used to define additional files that shouldbe removed withmake clean.
CLOBBER_FILEX: this macro may be used to define additional files that shouldbe removed withmake clobber.
COPTOPT: The c-compiler optimization flag. This flag is intended to be overridden either from a makefile or from command line.
COPTS: The internal macro that contains the flags for the c-compiler.Change this macro if you want to change the behavior.Use: COPTS= valueIf you want to override the default value. If you want tooverride the default c-compiler flags from the command linecall:make 'COPTS=value'Use: COPTS += valueIf you want to add flags to the default value from within a makefile.
COPTX: may be used if you want to add flags to the c-compiler flags from thecommand line. Use:make 'COPTX=value'
CPPFLAGS: The flags that are used with the c-preprocessor.This macro as well as:CPPOPTS and CPPOPTXare also used when compiling c-programs.They should contain only the following flags:-Dname=value , -Uname , -Idirectory and -Ydirectory.
Do not change this macro.
CPPOPTS: The internal macro that contains the flags for the c-preprocessor.Change this macro if you want to change the behavior.Use: CPPOPTS= valueIf you want to override the default value. If you want tooverride the default c-preprocessor flags from the command linecall:make 'CPPOPTS=value'Use: CPPOPTS += valueIf you want to add flags to the default value from within a makefile.
CPPOPTX: may be used if you want to add flags to the c-preprocessor flags from thecommand line. Use:make 'CPPOPTX=value'
CURDIR: This macro contains the name of the sub directory that is currently processed.
Do not change this macro.
DEFINSGRP: this macro may be set in the projects defaults file to set up thedefault group id for installation
DEFINSMODE: this macro may be set in the projects defaults file to set up thedefault file permission for installation
DEFINSUSR: this macro may be set in the projects defaults file to set up thedefault user id for installation
DEFUMASK: this macro may be set in the projects defaults file to set up thedefault umaskvalue for creating sub directories
DEFAULTSDIR: this macro may be set from command line or from the shell environmentif the user wants to use a different set of Defaultsfiles that is not located in the directoryDEFAULTSin the source root directory.This may be used to hold two or more set of defaults that differ e.g. in theinstallation path or the C-compiler.
DEFAULTSROOT: this macro may be set in a leaf makefile, if that makefile wants to usea Defaultsfile that is not located in $(DEFAULTSDIR)in the source root.This may be used, if a sub tree in a big project needs a different setup.
DEFLTSDIR: This is an internally used macro that is set from $(DEFAULTSDIR) or from the internal defaults.
Do not change this macro.
DEFLTSROOT: This is an internally used macro that is set from $(DEFAULTSROOT) or from the internal defaults.
Do not change this macro.
DEFCCOM: the default name of the c-compiler. This is usually set in the file$(DEFLTSROOT)/$(DEFLTSDIR)/Defaultsor $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults.$(O_ARCH).
DEFINCDIRS: a list of directories that are searched by default in addition to the system include directories. If this macro is not set, $(SRCROOT)/includeis used.
DIRNAME: this macro needs to be set in the makefile that is located inthe $(SRCROOT)directory.The value should be either set to the name of the directorywhere the makefile is located or to 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 filein the source root.
DIRS: this macro needs to be set in a makefile that is located ina directory that contains diversion directories.It must contain a list of directory names where the diversionsgo to e.g.DIRS= libfoo libbar libgarbage.
HFILES: for normal operation, makefiles will automatically find which include files are neededfor compilation.However, if you want to create a tag file that includestags for definitions that occur within include files, you should set HFILESto be a list of include files containing such definitions.
INCDIRS: this macro will normally be a copy from DEFINCDIRS.You may however specify a different value in a leaf makefileor from command line. This will overwrite the defaults value.
INS_BASE: this macro has to be specified in the file$(DEFLTSROOT)/$(DEFLTSDIR)/Defaultsor $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults.$(O_ARCH).It must contain the path name of the root for installing general targets of the project.SeeINSDIR.
INS_KBASE: this macro has to be specified in the file$(DEFLTSROOT)/$(DEFLTSDIR)/Defaultsor $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults.$(O_ARCH).It must contain the path name of the root for installing kernel modules from the project.SeeINSDIR.
INSDIR: this macro has to be specified in the leaf makefile.It must contain the path name of a directory relative toINS_BASE or INS_KBASE.The target will be installed into$(INS_BASE)/$(INSDIR) .
INSGRP: this macro may be set in a leaf makefile to set up thegroup id for installation
INSMODE: this macro may be set in a leaf makefile to set up thefile permission for installation
INSUSR: this macro may be set in a leaf makefile to set up theuser id for installation
K_ARCH: this macro contains the kernel/machine architecture for thetarget machine (e.g.sun3 sun4c sun4m sun4u 9000-725 aviion).It is set to the output ofuname -mconverted to lower case.
Do not change this macro.
KARCH: this macro contains the kernel/machine architecture for thetarget machine (e.g.sun3 sun4c sun4m sun4u 9000-725 aviion).It is set to the output ofuname -mconverted to lower case.
Do not change this macro unless you want to do a cross compilation.
LDFLAGS: The flags that are used with the linker.
Do not change this macro.
LDLIBS: The internal macro that holds the libraries that are used while linking the target.
Do not change this macro.
LDOPTS: The internal macro that contains the flags for the linker.Change this macro if you want to change the behavior.Use: LDOPTS= valueIf you want to override the default value. If you want tooverride the default linker flags from the command linecall:make 'LDOPTS=value'Use: LDOPTS += valueIf you want to add flags to the default value from within a makefile.
LDOPTX: may be used if you want to add flags to the linker flags from thecommand line. Use:make 'LDOPTX=value'
LDPATH: the default library search path for the linker. This is usually set in the file$(DEFLTSROOT)/$(DEFLTSDIR)/Defaultsor $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults.$(O_ARCH).
LIB_KVM: a predefined macro that contains the operating system dependentname of a librarythat is needed by programs that read/write kernel virtual memory.Add $(LIB_KVM)to your list of libraries (e.g.LIBS= -lintl $(LIB_KVM)),if your target uses kvm.
LIB_MATH: a predefined macro that contains the operating system dependentname of a librarythat is needed by programs that use routines of the math library.Add $(LIB_MATH)to your list of libraries (e.g.LIBS= -lintl $(LIB_MATH)),if your target uses math subroutines.
LIB_SOCKET: a predefined macro that contains the operating system dependentname of a librarythat is needed by programs that use socket calls.Add $(LIB_SOCKET)to your list of libraries (e.g.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.
LIBS_PATH: this macro contains the path to a directory where thoselibraries are located, that have been build duringa make run inside the current project.
Do not change this macro.
M_ARCH: this macro contains the machine architecture for thetarget machine (e.g.sun3 sun4 ip22 i86pc i586 9000-725 aviion).It is set to the output ofarchconverted to lower case.On systems, where M_ARCHis not available, it is set to the content of K_ARCH.
Do not change this macro.
MK_FILES: makefiles that divert into sub makes within the same directorymust set MK_FILESto be a list of makefile names for the sub makes.Makefile names for sub makes should have a name that is buildby adding .mkto the base name of the target that is defined inside thespecific makefile.
MAKEPROG: Set this macro to the name of your make program if it doesnot support the macroMAKE_NAME.The make program smakeis able to identify itself.If you want to use a make program that is not ableto identify itselfand it's name is notmake,set MAKEPROGto the name of the make program.Currently only gmakeis supported as alternate value for MAKEPROG.If you want to use an unsupported make programyou have to check if it supports the needed featuresformakefiles.You must write your own rule files for that make program.If you want to use gmake,you should dosetenv MAKEPROG gmakebefore you startgmakeor use a shell script that does this job for you.
MAKE: This macro is set up by the make program.It contains a path name that is sufficient to recursivelycall the same makeprogram again (either that last path component or the full pathname of the make program).
Do not change this macro.
MAKEFLAGS: This macro is set up by the make program.It contains the command line flags,makeis called with.
Do not change this macro.
MAKE_ARCH: This macro is currently set up by smake only.It contains the processor architecture of the target machine(e.g. mc68020, sparc, pentium).
Do not change this macro.
MAKE_BRAND: This macro is currently set up by smake only.It contains the brand of the target machine(e.g. Sun_Microsystems(e.g. ).
Do not change this macro.
MAKE_HOST: This macro is currently set up by smake only.It contains the host name of the target machine(e.g. duffy, sherwood, ghost).
Do not change this macro.
MAKE_MACH: This macro is currently set up by smake only.It contains the kernel architecture of the target machine(e.g. sun3, sun4c, sun4m, sun4u).
Do not change this macro.
MAKE_MODEL: This macro is currently set up by smake only.It contains the model name of the target machine(e.g. SUNW,SPARCstation-20).
Do not change this macro.
MAKE_M_ARCH: This macro is currently set up by smake only.It contains the machine architecture of the target machine(e.g. sun3, sun4).
Do not change this macro.
MAKE_NAME: This macro is currently set up by smake only.It contains the official name of themake program(e.g. make, smake, gmake).
Do not change this macro.
MAKE_OS: This macro is currently set up by smake only.It contains the operating system name of the target machine(e.g. sunos, linux, dgux).
Do not change this macro.
MAKE_OSDEFS: This macro is currently set up by smake only.It contains operating system specific defines for the compiler(e.g. -D__SVR4).
Do not change this macro.
MAKE_OSREL: This macro is currently set up by smake only.It contains the operating system release name of the target machine(e.g. 5.5, 4.1.1).
Do not change this macro.
MAKE_OSVERSION: This macro is currently set up by smake only.It contains the operating system version of the target machine(e.g. generic).
Do not change this macro.
MAKE_SERIAL: This macro is currently set up by smake only.It contains the serial number of the target machine(e.g. 1920098175).
Do not change this macro.
MANDIR: all makefiles for manual pages must set this macro to thepath name relative to INS_BASEwhere the manual page root dir for the project should be.Possible values for english manual pages areman or share/man,possible values for german manual pages areman/de or share/man/de.
MANFILE: makefiles for manual pages set this macro to the name of the troff source file for the manual page
MANSECT: makefiles for manual pages set this macro to the macro name thatcontains the real section name for this manual page. This is necessary because bsd based system have different naming conventions thansystem V based systems. See below for a valid list of manual sectionmacros.
MANSECT_ADMIN: This macro contains the name of the sub directory for administrativecommands and maintenance procedures.
Do not change this macro.
MANSECT_CMD: This macro contains the name of the sub directory for general user commands.
Do not change this macro.
MANSECT_DEMOS: This macro contains the name of the sub directory for democommands.
Do not change this macro.
MANSECT_DEVICE: This macro contains the name of the sub directory for user level device interfaces.
Do not change this macro.
MANSECT_DRIVER: This macro contains the name of the sub directory for kernel level device driver interfaces.
Do not change this macro.
MANSECT_FILEFORM: This macro contains the name of the sub directory for file formats.
Do not change this macro.
MANSECT_GAMES: This macro contains the name of the sub directory for games.
Do not change this macro.
MANSECT_HDR: This macro contains the name of the sub directory for header files.
Do not change this macro.
MANSECT_LIB: This macro contains the name of the sub directory for library function interfaces.
Do not change this macro.
MANSECT_MACROS: This macro contains the name of the sub directory for troff macros.
Do not change this macro.
MANSECT_NETWORK: This macro contains the name of the sub directory for user level network interfaces.
Do not change this macro.
MANSECT_SYSCALL: This macro contains the name of the sub directory for system call interfaces.Do not change this macro.
MANSECT_TABLES: This macro contains the name of the sub directory for tables.Do not change this macro.
MANSTYLE: This macro contains the name that is used to find the rightordering conventions for manual pages.Do not change this macro.
MANSUFFIX: makefiles for manual pages set this macro to the macro name thatcontains the real suffix for this manual page. This is necessary because bsd based system have different naming conventions thansystem V based systems. See below for a valid list of manual suffixmacros.
MANSUFF_ADMIN: This macro contains the name of the file suffix for administrativecommands and maintenance procedures.
Do not change this macro.
MANSUFF_CMD: This macro contains the name of the file suffix for general user commands.
Do not change this macro.
MANSUFF_DEMOS: This macro contains the name of the file suffix for democommands.
Do not change this macro.
MANSUFF_DEVICE: This macro contains the name of the file suffix for user level device interfaces.
Do not change this macro.
MANSUFF_DRIVER: This macro contains the name of the file suffix for kernel level device driver interfaces.
Do not change this macro.
MANSUFF_FILEFORM: This macro contains the name of the file suffix for file formats.
Do not change this macro.
MANSUFF_GAMES: This macro contains the name of the file suffix for games.
Do not change this macro.
MANSUFF_HDR: This macro contains the name of the file suffix for header files.
Do not change this macro.
MANSUFF_LIB: This macro contains the name of the file suffix for library function interfaces.
Do not change this macro.
MANSUFF_MACROS: This macro contains the name of the file suffix for troff macros.
Do not change this macro.
MANSUFF_NETWORK: This macro contains the name of the file suffix for user level network interfaces.
Do not change this macro.
MANSUFF_SYSCALL: This macro contains the name of the file suffix for system call interfaces.Do not change this macro.
MANSUFF_TABLES: This macro contains the name of the file suffix for tables.Do not change this macro.
MARCH: this macro contains the machine architecture for thetarget machine (e.g.sun3 sun4 ip22 i86pc i586 9000-725 aviion).It is set to the output ofarchconverted to lower case.On systems, where M_ARCHis not available, it is set to the content of K_ARCH.
Do not change this macro unless you want to do a cross compilation.
O_ARCH: this macro contains the name of the operating systemconverted to lower case.It is usually the output of:uname -s.It may contain a modified name if the compilation rulesfor different version of the operating system differ (e.g.onSunOS and Solaris,the official operation system name in both cases isSunOS).
Do not change this macro.
OARCH: this macro contains the object architecture that is usedfor architecture dependent sub directories.It is set to:$(PARCH)-$(O_ARCH)-$(C_ARCH).
Do not change this macro.
OARCHDIR: this macro contains the concatenation of OBJ/and $(OARCH).
Do not change this macro.
OFILES: this macro contains the list of objects that are thethe dependency list for the target.It is constructed from the list ofassembler source files,c source files,lex source files andyacc source files.
Do not change this macro.
OINCSDIR: this macro contains the concatenation of $(SRCROOT)/incs/and $(OARCH).It is the location where include files that are made within a make runand subject to global use will be placed.
Do not change this macro.
OLIBSDIR: this macro contains the concatenation of $(SRCROOT)/libs/and $(OARCH).It is the location where libraries that are made within a make runwill be placed.
Do not change this macro.
OSDEFS: this macro contains operating system specific c-preprocessordefinitions.
Do not change this macro.
OSNAME: the unmodified name of the operating system converted to lower case.SeeO_ARCH.
Do not change this macro.
OSREL: the release of the operating system.
Do not change this macro.
P_ARCH: this macro contains the processor architecture for thetarget machine (e.g.mc68020 mc88200 sparc pentium).It is set to the output ofuname -pconverted to lower case.On systems, where P_ARCHis not available, it is set to the content of K_ARCH.
Do not change this macro.
PARCH: this macro contains the processor architecture for thetarget machine (e.g.mc68020 mc88200 sparc pentium).It is set to the output ofuname -pconverted to lower case.On systems, where P_ARCHis not available, it is set to the content of K_ARCH.
Do not change this macro unless you want to do a cross compilation.
RULESDIR: the value of this macro must be set beforethe rules file$(SRCROOT)/$(RULESDIR/rules.topis included.If you want to test the behavior of a modified versionof themakefilesin RULESDIR,put a copy into an alternate directory, modify one or morefiles in it and then use make with a different value ofRULESDIR,that points to the alternate directory.
RUNPATH: is evaluated on systems, where LD_RUN_PATHis supported.It contains the default library search path for dynamic linked targetson runtime. This search path will be stored inside the target.This is usually set in the file$(DEFLTSROOT)/$(DEFLTSDIR)/Defaultsor $(DEFLTSROOT)/$(DEFLTSDIR)/Defaults.$(O_ARCH).Note that older systems will use LD_LIBRARY_PATHfor this purpose too.
SCRFILE: this macro must be set in a leaf makefile for shell scripts to definethe source for that script file.
SRCFILE: this macro must be set in a leaf makefile for localized files to definethe source for that file.
SRCROOT: this macro contains the relative position to the project'ssource root directory.The value of this macro must be set beforethe rules file$(SRCROOT)/$(RULESDIR/rules.topis included.SRCROOTshould be set to../..if the appropriate leaf makefile is located two directorylevels below the source route.
SUBARCHDIR: may be set to put the object files and the target intoa different directory than usual.SUBARCHDIRwill modify the value of ARCHDIR.If you want to make a target that is compiled for dbxyou may use:make COPTX=-g SUBARCHDIR=-dbx.
TARGET: all makefiles, that are not referring to library targets orsub makes / sub dir makes,must defineTARGETto be the output file name of the final link operation.
TARGETLIB: all makefiles that are used to make librariesmust defineTARGETLIBto be the central part of the target library.If you want to make e.g.libfoodefineTARGETLIB= foo.This is needed to allow operating systems to have different naming conventions for libraries.If you are making a non shared library, the example abovewould result in a filename:libfoo.afor the real target.
TARGETMAN: this macro must be set in a leaf makefile for manual pages to definethe base name for that manual page (not including the suffix).
XMK_FILE: makefiles that want to install manual pages should set XMK_FILEto Makefile.manto avoid having to install a diversion make file. The make file found inXMK_FILEwill be processed only if makeis called with the target install.

GETTING STARTED

To set up a new project, first copy the RULES and TEMPLATESdirectories and all its content into the project's root directory.

Then copy a top level makefile, a Defaultsfile and a Targetdirs.archnamefile into the project's root directory.

Then create the following directories:cmd, lib, include.

Now start creating target directories e.g belowcmd and lib.Don't forget to create a makefile and an appropriateTargetdirs.archname file on each node directory.

EXAMPLES

If you want to set up a private copy of parts of a project,you should choose a directory inside your directory tree that will becomethe shadow projects source root directory.Then create symbolic links named RULES and TEMPLATESto the real source root.If you don't want to modify the global include files,create a symbolic link to theincludedirectory too, else copy the include directory and its content.copy the top level makefile, the Defaultsfile and theTargetdirs.archname file.

Finally copy the desired sub tree together with allmakefiles and the Targetdirs.archname files that are located in the directories aboveyour part of the project that you want to have separately.

FILES

.../RULES/*
.../DEFAULTS/*
.../TARGETS/*
.../TEMPLATES/*

DIAGNOSTICS

Diagnostic messages depend on the make program.Have a look at the appropriate man page.

NOTES

The scope of this manual is only the usage of leaf makefiles.If you want to make changes to the make ruleshave a look atmakerules(4).

makefilescan be used with Sunpro make, Gnu makeand smake.Although Gnu make runs on many platforms, it has no useful debugoutput.

UseSunpro make or smakeif you have problems with a makefile.Sunpro make and smake,both have a -D flag, that allows you to watch the makefilesafter the first expansion. Use this option, if you are in doubtif your makefile gets expanded the right way and if the rightrules are included.There is also a -d option that gives debugging output while make is running. If you want more output, use -dd, -ddd and so on.

Smakehas an option -xM that shows you the include dependency formake rules.

The following is a list of all macros that are used in makefiles.Do not use them unless their meaning has been explainedbefore.

-O_ARCH,.OBJDIR,.SEARCHLIST,ALLTARGETS,AR,ARCH,ARCHDIR,ARCHDIRX,ARCH_DONE,ARFLAGS,AS,ASFLAGS,ASMFILES,ASOPTS,ASOPTX,CC,CCOM,CCOM_DEF,CFILES,CFLAGS,CHGRP,CHMOD,CHOWN,CLEAN_FILES,CLEAN_FILEX,CLOBBER_FILEX,COPTDYN,COPTGPROF,COPTOPT,COPTS,COPTX,CPP,CPPFLAGS,CPPOPTS,CPPOPTX,CTAGS,CURDIR,C_ARCH,DEFAULTSDIR,DEFAULTSROOT,DEFCCOM,DEFCCOM_DEF,DEFINCDIRS,DEFINCDIRS_DEF,DEFINSGRP,DEFINSMODE,DEFINSUSR,DEFUMASK,DEF_ROOT,DEP_DEP,DEP_FILE,DEP_SUFFIX,DIRNAME,DIRS,DYNLD,ETAGS,FLOAT_OPTIONS,HFILES,HOSTNAME,INCDIRS,INSDIR,INSGRP,INSGRP_DEF,INSMODE,INSMODE_DEF,INSTALL,INSUSR,INSUSR_DEF,INS_BASE,INS_KBASE,KARCH,KARCH_DEF,KDEFINES,K_ARCH,LD,LDCC,LDFLAGS,LDLIBS,LDOPTDYN,LDOPTS,LDOPTX,LDPATH,LIBS,LIBS_PATH,LIBX,LIB_KVM,LIB_MATH,LIB_PREFIX,LIB_SOCKET,LIB_SUFFIX,LN,LNDYNLIB,LOCALIZE,LORDER,MAKE,MK_FILES,MAKEPROG,MAKE_ARCH,MAKE_HOST,MAKE_MACH,MAKE_M_ARCH,MAKE_NAME,MAKE_OS,MAKE_OSDEFS,MAKE_OSREL,MANDIR,MANFILE,MANSECT,MANSECT_ADMIN,MANSECT_CMD,MANSECT_DEMOS,MANSECT_DEVICE,MANSECT_DRIVER,MANSECT_FILEFORM,MANSECT_GAMES,MANSECT_HDR,MANSECT_LIB,MANSECT_MACROS,MANSECT_NETWORK,MANSECT_SYSCALL,MANSECT_TABLES,MANSTYLE,MANSUFFIX,MANSUFF_ADMIN,MANSUFF_CMD,MANSUFF_DEMOS,MANSUFF_DEVICE,MANSUFF_DRIVER,MANSUFF_FILEFORM,MANSUFF_GAMES,MANSUFF_HDR,MANSUFF_LIB,MANSUFF_MACROS,MANSUFF_NETWORK,MANSUFF_SYSCALL,MANSUFF_TABLES,MARCH,MARCH_DEF,MKDEP,MKDEP_OUT,MKDIR,MV,M_ARCH,OARCH,OARCHDIR,OFILES,OINCSDIR,OLIBSDIR,OSDEFS,OSNAME,OSREL,O_ARCH,PALLDEP_FILE,PARCH,PARCH_DEF,PASMFILES,PDEP_FILE,PLOFILES,POFILES,PTARGET,PTARGET_BASE,PYOFILES,P_ARCH,RANLIB,RM,RMDEP,RMTARGET,RM_FORCE,RM_RECURS,RM_RF,RULESDIR,RUNPATH,SCRFILE,SHELL,SHL_SUFFIX,SRCFILE,SRCLIBS,SRCROOT,SUBARCH,SUBARCHDIR,SYMLINK,TAGS,TARGET,TARGETLIB,TARGETMAN,TARGET_BASE,TARGET_PATH,TSORT,UMASK,UMASK_DEF,UMASK_VAL,XARCH,XK_ARCH,XMK_FILE,XMAKEPROG,XM_ARCH,XP_ARCH,_CCOM,_DEFAULTSDIR,_DEFCCOM,_DEFINSGRP,_DEFINSMODE,_DEFINSUSR,_DEFUMASK,_DIRNAME,_INCDIRS,_MAKEPROG,_MARCH,_M_ARCH,_O_ARCH,_PARCH,_P_ARCH,_UNIQ,__CCOM,__DEFAULTSDIR,__DEFCCOM,__DEFINSGRP,__DEFINSMODE,__DEFINSUSR,__DEFUMASK,__DIRNAME,__INCDIRS,__MAKEPROG,__MARCH,__M_ARCH,__PARCH,__P_ARCH,

BUGS

Source Tree Hierarchy

The following outline gives a quick tour through a typicalsource hierarchy:

.../

root directory of the source tree

Makefile: the top Makefile
Targetdirs: a file containing a list of directories that are neededfor that project.If the system needs different target lists dependingon the target system architecture , use target specific files in.../TARGETS/
...

.../RULES/

the location of makefiles (included rules)

rules.top: the mandatory include rules (needed to setup basic rules)
rules.aux: rules needed to install a non localized auxiliary file
rules.cmd: rules needed to make an ordinary command (like /bin/sh)
rules.drv: rules needed to make a device driver
rules.lib: rules needed to make a standard (nonshared) library
rules.loc: rules needed to install a localized auxiliary file
rules.man: rules needed to install a localized manual page
rules.scr: rules needed to install a localized shell script
rules.shl: rules needed to make a shared library
rules.mks: rules needed to make more than one target in a specific directory
rules.dir: rules needed to make targets that are located in sub directoriesto the current directory
...

.../DEFAULTS/

default definitions for various target architectures arelocated in this directory. Templates for some architectures canbe found in the.../TEMPLATES/directory.

Defaults: default definitions for that source tree. System dependentdefinitions are in .../DEFAULTS/Defaults.*

.../TARGETS/

target list definitions for various target architectures arelocated in this directory.

.../TEMPLATES/

templates that should be used inside the project(rename to Makefile, if it is the only makefile in that directory, rename totarget.mk,if there is more than one target in that directory)

Defaults: Defaults file for the source root directory
Defaults.linux: Defaults file for linux.This should be installed in the .../DEFAULTS/directory.
Makefile.root: Makefile for the source root directory
Makefile.aux: Makefile for a non localized auxiliary file
Makefile.cmd: Makefile for an ordinary command (like /bin/sh)
Makefile.lib: Makefile for a standard (nonshared) library
Makefile.loc: Makefile for a localized auxiliary file
Makefile.man: Makefile for a localized manual page
Makefile_de.man: Makefile for a localized manual page in the german locale
Makefile.scr: Makefile for a localized shell script
Makefile.shl: Makefile for a shared library
Makefile.drv: Makefile for a device driver
Makefile.mks: Makefile for more than one target in a specific directory
Makefile.dir: Makefile for targets that are located in sub directoriesto the current directory
...

.../cmd/

source tree for normal commands

Makefile

the makefile for the cmd sub directory

Targetdirs.sun4m

a file containing a list of directories like myprog (see below) that are neededfor that specific architecture.

myprog/

directory where the sources for a specific command are located

Makefile

makefile formyprog

Makefile.man

makefile for the manual page ofmyprog

mprog.c

source for myprog

mprog.tr

troff source for the manual page of myprog

OBJ/

directory where system specific sub directories are located

sparc-sunos5-cc/: directory for binaries that belong to a specific system
...

...

.../lib/

directory where the sources for a libraries are located

Makefile: the makefile for the lib sub directory
Targetdirs.sun4m: a file containing a list of directories like libfoo(see below) that are neededfor that specific architecture.
libfoo/: directory where all source files for libfoo are located
...

.../kernel

directory for kernel modules

Makefile

the makefile for the kernelsub directory

Targetdirs.sun4m

a file containing a list of directories like drv (see below) that are neededfor that specific architecture.

drv/

directory where drivers are located

Makefile: the makefile for the drvsub directory
Targetdirs.sun4m: a file containing a list of directories like mydrv(see below) that are neededfor that specific architecture.
mydrv/: source for a specific driver
...

...

.../include

directory for global include files that are used in that project

.../bins

directory for binary programs that are created/needed while compilingthe project

sparc-sunos5-cc/: directory for binaries that belong to a specific system
...

.../libs

directory for libraries that are created/needed while compilingthe project

sparc-sunos5-cc/: directory for libraries that belong to a specific system
...

.../incs

directory for include files that are created/needed while compilingthe project

sparc-sunos5-cc/: directory for include files that belong to a specific system
...

...

AUTHOR

Joerg SchillingSeestr. 110D-13353 BerlinGermany

Mail bugs and suggestions to:

joergAATTschily.isdn.cs.tu-berlin.deorjsAATTcs.tu-berlin.deorjesAATTfokus.gmd.de

This document was created byman2html,using the manual pages.

makefiles

NAME

SYNOPSIS

DESCRIPTION

Macros/Variables Used In Rules

GETTING STARTED

EXAMPLES

FILES

SEE ALSO

DIAGNOSTICS

NOTES

BUGS

Source Tree Hierarchy

AUTHOR

Index