bsd.README revision 1.187
1#	$NetBSD: bsd.README,v 1.187 2006/11/09 17:06:54 christos Exp $
2#	@(#)bsd.README	8.2 (Berkeley) 4/2/94
3
4This is the README file for the new make "include" files for the BSD
5source tree.  The files are installed in /usr/share/mk, and are, by
6convention, named with the suffix ".mk".
7
8Note, this file is not intended to replace reading through the .mk
9files for anything tricky.
10
11=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
12
13RANDOM THINGS WORTH KNOWING:
14
15The files are simply C-style #include files, and pretty much behave like
16you'd expect.  The syntax is slightly different in that a single '.' is
17used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
18
19One difference that will save you lots of debugging time is that inclusion
20of the file is normally done at the *end* of the Makefile.  The reason for
21this is because .mk files often modify variables and behavior based on the
22values of variables set in the Makefile.  To make this work, remember that
23the FIRST target found is the target that is used, i.e. if the Makefile has:
24
25	a:
26		echo a
27	a:
28		echo a number two
29
30the command "make a" will echo "a".  To make things confusing, the SECOND
31variable assignment is the overriding one, i.e. if the Makefile has:
32
33	a=	foo
34	a=	bar
35
36	b:
37		echo ${a}
38
39the command "make b" will echo "bar".  This is for compatibility with the
40way the V7 make behaved.
41
42It's fairly difficult to make the BSD .mk files work when you're building
43multiple programs in a single directory.  It's a lot easier to split up the
44programs than to deal with the problem.  Most of the agony comes from making
45the "obj" directory stuff work right, not because we switched to a new version
46of make.  So, don't get mad at us, figure out a better way to handle multiple
47architectures so we can quit using the symbolic link stuff.  (Imake doesn't
48count.)
49
50The file .depend in the source directory is expected to contain dependencies
51for the source files.  This file is read automatically by make after reading
52the Makefile.
53
54The variable DESTDIR works as before.  It's not set anywhere but will change
55the tree where the file gets installed.
56
57The profiled libraries are no longer built in a different directory than
58the regular libraries.  A new suffix, ".po", is used to denote a profiled
59object, and ".so" denotes a shared (position-independent) object.
60
61There are various make variables used during the build.
62
63Many variables support a (case sensitive) value of "no" or "yes",
64and are tested with  ${VAR} == "no"  and  ${VAR} != "no" .
65
66
67The basic rule for the variable naming scheme is as follows:
68
69MKxxx		Can be set to "no" to disable functionality, or
70		"yes" to enable it.
71		Usually defaults to "yes", although some variables
72		default to "no".
73		Due to make(1) implementation issues, if a temporary
74		command-line override of a mk.conf or <bsd.own.mk>
75		setting is required whilst still honouring a particular
76		Makefile's setting of MKxxx, use
77			env MKxxx=value make
78		instead of
79			make MKxxx=value
80
81NOxxx		If defined, disables a feature.
82		Not intended for users.
83		This is to allow Makefiles to disable functionality
84		that they don't support (such as missing man pages).
85		NOxxx variables must be defined before <bsd.own.mk>
86		is included.
87
88The following variables that control how things are made/installed that
89are not set by default. These should not be set by Makefiles; they're for
90the user to define in MAKECONF (see <bsd.own.mk>, below) or on the make(1)
91command line:
92
93BUILD 		If defined, 'make install' checks that the targets in the
94		source directories are up-to-date and remakes them if they
95                are out of date, instead of blindly trying to install
96                out of date or non-existent targets.
97
98MAKEVERBOSE	Control how "verbose" the standard make(1) rules are.
99		Default: 2
100		Supported values:
101		    0	Minimal output ("quiet")
102		    1	Describe what is occurring
103		    2	Describe what is occurring and echo the actual command
104
105
106MKBFD		If "no", don't build libbfd, libiberty, or any of the things
107		that depend on them (binutils/gas/ld, gdb, dbsym, mdsetimage).
108		Default: yes
109
110MKCATPAGES	If "no", don't build or install the catman pages.
111		Default: yes
112
113MKCRYPTO	If "no", no cryptography support will be built into the system,
114		and also acts as "MKKERBEROS=no".
115		Default: yes
116
117MKCRYPTO_IDEA	If not "no", IDEA support will be built into libcrypto_idea.a.
118		Default: no
119
120MKCRYPTO_MDC2	If not "no", MDC2 support will be built into libcrypto_mdc2.a
121		Default: no
122
123MKCRYPTO_RC5	If not "no", RC5 support will be built into libcrypto_rc5.a.
124		Default: no
125
126MKCVS		If "no", don't build or install cvs(1).
127		Default: yes
128
129MKDEBUG		If "no", don't build and install separate debugging symbols
130		into /usr/libdata/debug.
131		Default: no
132
133MKDEBUGLIB	Build debugging libraries.
134		Default: no
135
136MKDOC		If "no", don't build or install the documentation.
137		Default: yes
138
139MKDYNAMICROOT	If "no", build programs in /bin and /sbin statically,
140		don't install certain libraries in /lib, and don't
141		install the shared linker into /libexec.
142		Default: yes
143
144MKGCC		If "no", don't build gcc(1) or any of the gcc-related
145		libraries (libgcc, libobjc, libstdc++).
146		Default: yes
147
148MKGCCCMDS	If "no", don't build gcc(1).
149		Default: yes
150
151MKGDB		If "no", don't build gdb(1).
152		Default: yes
153
154MKHESIOD	If "no", disables building of Hesiod infrastructure
155		(libraries and support programs).
156		Default: yes
157
158MKHOSTOBJ	If not "no", for programs intended to be run on the compile
159		host, the name, release, and architecture of the host
160		operating system will be suffixed to the name of the object
161		directory created by "make obj".
162		Default: no
163
164MKHTML		If "no", don't build or install the html man pages.
165		Default: no
166
167MKIEEEFP	If "no", don't add code for IEEE754/IEC60559 conformance.
168		Has no effect on most platforms.
169		Default: yes
170
171MKINET6		If "no", disables building of INET6 (IPv6) infrastructure
172		(libraries and support programs).
173		Default: yes
174
175MKINFO		If "no", don't build or install Info documentation from
176		Texinfo source files.
177		Default: yes
178
179MKIPFILTER	If "no", don't build or install the IP Filter programs and LKM.
180		Default: yes
181
182MKISCSI		If "no", don't build or install iscsi library or applications
183		(depends on libpthread.)
184		Default: yes
185
186MKKERBEROS	If "no", disables building of Kerberos v5
187		infrastructure (libraries and support programs).
188		Default: yes
189
190MKLINKLIB	If "no", act as "MKPICINSTALL=no MKPROFILE=no".
191		Also:
192			- don't install the .a libraries
193			- don't install _pic.a libraries on PIC systems
194			- don't build .a libraries on PIC systems
195			- don't install the .so symlink on ELF systems
196		I.e, only install the shared library (and the .so.major
197		symlink on ELF).
198		Default: yes
199
200MKLINT		If "no", don't build or install the lint libraries.
201		Default: yes
202
203MKMAN		If "no", don't build or install the man or catman pages,
204		and also acts as "MKCATPAGES=no MKHTML=no".
205		Default: yes
206
207MKMANZ		If not "no", compress manual pages at installation time.
208		Default: no
209
210MKNLS		If "no", don't build or install the NLS files and locale
211		definition files.
212		Default: yes
213
214MKOBJ		If "no", don't enable the rule which creates objdirs,
215		and also acts as "MKOBJDIRS=no".
216		Default: yes
217
218MKOBJDIRS	If "no", don't create objdirs during a "make build".
219		Default: no
220
221MKPAM		If "no", disables building of PAM authentication
222		infrastructure (libraries and support programs).
223		Default: yes
224
225MKPF		If "no", don't build or install the pf programs and LKM.
226		Default: yes
227
228MKPIC		If "no", don't build or install shared libraries, and
229		also acts as "MKPICLIB=no"
230		Default: yes (for MACHINE_ARCHs that support it) 
231
232MKPICINSTALL	If "no", don't install the *_pic.a libraries.
233		Default: yes
234
235MKPICLIB	If "no", don't build *_pic.a libraries, and build the
236		shared object libraries from the .a libraries.
237		A symlink is installed in ${DESTDIR}/usr/lib for the
238		_pic.a library pointing to the .a library.
239		Default: yes
240
241MKPOSTFIX	If "no", don't build or install postfix(1).
242		Default: yes
243
244MKPROFILE	If "no", don't build or install the profiling (*_p.a) libraries.
245		Default: yes
246
247MKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
248		MKMAN=no MKNLS=no".
249		I.e, don't build catman pages, documentation, Info
250		documentation, man pages, NLS files, ...
251		Default: yes
252
253MKSKEY		If "no", disables building of S/key authentication
254		infrastructure (libraries and support programs).
255		Default: yes
256
257MKSOFTFLOAT	If not "no", build with options to enable the compiler to
258		generate output containing library calls for floating
259		point and possibly soft-float library support.
260		Default: no
261
262MKSTATICLIB	If "no", don't build or install the normal static (*.a)
263		libraries.
264		Default: yes
265
266MKUNPRIVED	If not "no", don't set the owner/group/mode when installing
267		files or directories, and keep a metadata log of what
268		the owner/group/mode should be.  This allows a
269		non-root "make install".
270		Default: no
271
272MKUPDATE 	If not "no", 'make install' only installs targets that are
273		more recently modified in the source directories that their
274		installed counterparts.
275		Default: no
276
277MKUUCP		If "no", don't build or install uucp(1).
278		Default: yes
279
280MKX11		If not "no", 'make build' also descends into src/x11
281		to cross build X11R6 and automatically enables creation
282		of X sets.
283		Default: no
284
285MKYP		If "no", disables building of YP (NIS)
286		infrastructure (libraries and support programs).
287		Default: yes
288
289USE_HESIOD	If "no", disables building Hesiod support into
290		various system utilities/libraries that support it.
291		If ${MKHESIOD} is "no", USE_HESIOD will also be
292		forced to "no".
293
294USE_INET6	If "no", disables building INET6 (IPv6) support into
295		various system utilities/libraries that support it.
296		If ${MKINET6} is "no", USE_INET6 will also be
297		forced to "no".
298
299USE_KERBEROS	If "no", disables building Kerberos v5
300		support into various system utilities/libraries that
301		support it.  If ${MKKERBEROS} is "no", USE_KERBEROS
302		will also be forced to "no".
303
304USE_PAM		If "no", disables building PAM authentication support
305		into various system utilities/libraries that support it.
306		If ${MKPAM} is "no", USE_PAM will also be forced to "no".
307
308USE_SKEY	If "no", disables building S/key authentication
309		support into various system utilities/libraries that
310		support it.  If ${MKSKEY} is "no", USE_SKEY will
311		also be forced to "no".
312
313USE_SSP		If "yes", it turns of the gcc stack protection code
314		where stack overflows are detected and the program
315		aborts. This imposes some performance penalty. Defaults
316		to "no".
317
318USE_YP		If "no", disables building YP (NIS) support into
319		various system utilities/libraries that support it.
320		If ${MKYP} is "no", USE_YP will also be forced to "no".
321
322COPTS.lib<lib>
323OBJCOPTS.lib<lib>
324LDADD.lib<lib>
325CPPFLAGS.lib<lib>
326CXXFLAGS.lib<lib>
327COPTS.<prog>
328OBJCCOPTS.<prog>
329LDADD.<prog>
330CPPFLAGS.<prog>
331CXXFLAGS.<prog>	These provide a way to specify additions to the associated
332		variables in a way that applies only to a particular library
333		or program.  <lib> corresponds to the LIB variable set in
334		the library's makefile.  <prog> corresponds to either PROG
335		or PROG_CXX (if set).  For example, if COPTS.libcrypto is
336		set to "-g", "-g" will be added to COPTS only when compiling
337		the crypto library.
338
339=-=-=-=-=   sys.mk   =-=-=-=-=
340
341The include file <sys.mk> has the default rules for all makes, in the BSD
342environment or otherwise.  You probably don't want to touch this file.
343
344=-=-=-=-=   bsd.own.mk   =-=-=-=-=
345
346The include file <bsd.own.mk> contains source tree configuration parameters,
347such as the owners, groups, etc. for both manual pages and binaries, and
348a few global "feature configuration" parameters.
349
350It has no targets.
351
352To get system-specific configuration parameters, <bsd.own.mk> will try to
353include the file specified by the "MAKECONF" variable.  If MAKECONF is not
354set, or no such file exists, the system make configuration file, /etc/mk.conf
355is included.  These files may define any of the variables described below.
356
357<bsd.own.mk> sets the following variables, if they are not already defined
358(defaults are in brackets):
359
360NETBSDSRCDIR	Top of the NetBSD source tree.
361		If _SRC_TOP_ != "", that will be used as the default,
362		otherwise BSDSRCDIR will be used as the default.
363		Various makefiles within the NetBSD source tree will
364		use this to reference the top level of the source tree.
365
366_SRC_TOP_	Top of the system source tree, as determined by <bsd.own.mk>
367		based on the presence of tools/ and build.sh.  This variable
368		is "internal" to <bsd.own.mk>, although its value is only
369		determined once and then propagated to all sub-makes.
370
371BSDSRCDIR	The real path to the system sources, so that 'make obj'
372		will work correctly.  [/usr/src]
373
374BSDOBJDIR	The real path to the system 'obj' tree, so that 'make obj'
375		will work correctly.  [/usr/obj]
376
377BINGRP		Binary group.  [wheel]
378
379BINOWN		Binary owner.  [root]
380
381BINMODE		Binary mode.  [555]
382
383NONBINMODE	Mode for non-executable files.  [444]
384
385MANDIR		Base path for manual installation.  [/usr/share/man/cat]
386
387MANGRP		Manual group.  [wheel]
388
389MANOWN		Manual owner.  [root]
390
391MANMODE		Manual mode.  [${NONBINMODE}]
392
393MANINSTALL	Manual installation type: maninstall, catinstall, or both
394		[maninstall catinstall]
395
396LDSTATIC	Control program linking; if set blank, link everything
397		dynamically.  If set to "-static", link everything statically.
398		If not set, programs link according to their makefile.
399
400LIBDIR		Base path for library installation.  [/usr/lib]
401
402LINTLIBDIR	Base path for lint(1) library installation.  [/usr/libdata/lint]
403
404LIBGRP		Library group.  [${BINGRP}]
405
406LIBOWN		Library owner.  [${BINOWN}]
407
408LIBMODE		Library mode.  [${NONBINMODE}]
409
410DOCDIR		Base path for system documentation (e.g. PSD, USD, etc.)
411	        installation.  [/usr/share/doc]
412
413HTMLDOCDIR	Base path for html system documentation installation.
414		[/usr/share/doc/html]
415
416DOCGRP		Documentation group.  [wheel]
417
418DOCOWN		Documentation owner.  [root]
419
420DOCMODE		Documentation mode.  [${NONBINMODE}]
421
422NLSDIR		Base path for Native Language Support files installation.
423		[/usr/share/nls]
424
425NLSGRP		Native Language Support files group.  [wheel]
426
427NLSOWN		Native Language Support files owner.  [root]
428
429NLSMODE		Native Language Support files mode.  [${NONBINMODE}]
430
431X11SRCDIR	The path to the xsrc tree.  [/usr/xsrc]
432
433X11SRCDIR.xc	The path to the X11R6 xc src tree.  [${X11SRCDIR}/xfree/xc]
434
435X11SRCDIR.local	The path to the local X11R6 src tree.  [${X11SRCDIR}/local]
436
437X11ROOTDIR	Root directory of the X11 installation.  [/usr/X11R6]
438
439X11BINDIR	X11 bin directory.  [${X11ROOTDIR}/bin]
440
441X11FONTDIR	X11 font directory.  [${X11ROOTDIR}/lib/X11/fonts]
442
443X11INCDIR	X11 include directory.  [${X11ROOTDIR}/include]
444
445X11LIBDIR	X11 lib/x11 (config) directory.  [${X11ROOTDIR}/lib/X11]
446
447X11MANDIR	X11 manual directory.  [${X11ROOTDIR}/man]
448
449X11USRLIBDIR	X11 library directory.  [${X11ROOTDIR}/lib]
450
451STRIPFLAG	The flag passed to the install program to cause the binary
452		to be stripped.  This is to be used when building your
453		own install script so that the entire system can be made
454		stripped/not-stripped using a single knob.  []
455
456COPY		The flag passed to the install program to cause the binary
457		to be copied rather than moved.  This is to be used when
458		building our own install script so that the entire system
459		can either be installed with copies, or with moves using
460		a single knob.  [-c]
461
462MAKEDIRTARGET dir target [params]
463		Runs "cd $${dir} && ${MAKE} [params] $${target}",
464		displaying a "pretty" message whilst doing so.
465
466RELEASEMACHINEDIR
467		Subdirectory used below RELEASEDIR when building
468		a release.  [${MACHINE}]
469
470RELEASEMACHINE	Subdirectory or path component used for the following
471		paths:
472			distrib/${RELEASEMACHINE}
473			distrib/notes/${RELEASEMACHINE}
474			etc/etc.${RELEASEMACHINE}
475		Used when building a release.  [${MACHINE}]
476
477Additionally, the following variables may be set by <bsd.own.mk> or in a
478make configuration file to modify the behaviour of the system build
479process (default values are in brackets along with comments, if set by
480<bsd.own.mk>):
481
482USETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
483		be used as part of a build in progress.
484		Supported values:
485
486		yes	Use the tools from TOOLDIR.
487			Must be set to this if cross-compiling.
488
489		no	Do not use the tools from TOOLDIR, but refuse to
490			build native compilation tool components that are
491			version-specific for that tool.
492
493		never	Do not use the tools from TOOLDIR, even when
494			building native tool components.  This is similar to
495			the traditional NetBSD build method, but does not
496			verify that the compilation tools in use are
497			up-to-date enough in order to build the tree
498			successfully.  This may cause build or runtime
499			problems when building the whole NetBSD source tree.
500
501		Default: "yes" if building all or part of a whole NetBSD
502		source tree (detected automatically); "no" otherwise
503		(to preserve traditional semantics of the <bsd.*.mk>
504		make(1) include files).
505
506OBJECT_FMT	Object file format.  [set to "ELF" on architectures that
507		use ELF -- currently all architectures but ns32k, set to
508		"a.out" on ns32k].
509
510TOOLCHAIN_MISSING
511		If not "no", this indicates that the platform being built
512		does not have a working in-tree toolchain.  If the
513		${MACHINE_ARCH} in question falls into this category,
514		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
515		Otherwise, the variable is unconditionally assigned the
516		value "no".
517		If not "no", ${MKBFD}, ${MKGCC}, and ${MKGDB} are
518		unconditionally assigned the value "no".
519
520EXTERNAL_TOOLCHAIN
521		This variable is not directly set by <bsd.own.mk>, but
522		including <bsd.own.mk> is the canonical way to gain
523		access to this variable.  The variable should be defined
524		either in the user's environment or in the user's mk.conf
525		file.  If defined, this variable indicates the root of
526		an external toolchain which will be used to build the
527		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
528		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
529		cross-compile framework.
530
531		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
532		assigned the value "no", since the external version of the
533		compiler may not be able to build the library components of
534		the in-tree compiler.
535
536		NOTE: This variable is not yet used in as many places as
537		it should be.  Expect the exact semantics of this variable
538		to change in the short term as parts of the cross-compile
539		framework continue to be cleaned up.
540
541<bsd.own.mk> is generally useful when building your own Makefiles so that
542they use the same default owners etc. as the rest of the tree.
543
544
545=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
546
547The include file <bsd.dep.mk> contains the default targets for building
548.depend files.  It creates .d files from entries in SRCS and DPSRCS
549that are C, C++, or Objective C source files, and builds .depend from the
550.d files.  All other files in SRCS and all of DPSRCS will be used as
551dependencies for the .d files.  In order for this to function correctly,
552it should be .included after all other .mk files and directives that may
553modify SRCS or DPSRCS.  It uses the following variables:
554
555SRCS		List of source files to build the program.
556
557DPSRCS		List of source files which are needed for generating
558		dependencies, but are not needed in ${SRCS}.
559
560
561=-=-=-=-=   bsd.files.mk   =-=-=-=-=
562
563The include file <bsd.files.mk> handles the FILES variables and is included
564from <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
565
566FILES		The list of files to install.
567
568CONFIGFILES	Similar semantics to FILES, except that the files
569		are installed by the `configinstall' target,
570		not the `install' target.
571		The FILES* variables documented below also apply.
572
573FILESOWN	File owner.  [${BINOWN}]
574
575FILESGRP	File group.  [${BINGRP}]
576
577FILESMODE	File mode.  [${BINMODE}]
578
579FILESDIR	The location to install the files.
580
581FILESNAME	Optional name to install each file as.
582
583FILESOWN_<fn>	File owner of the specific file <fn>.
584
585FILESGRP_<fn>	File group of the specific file <fn>.
586
587FILESMODE_<fn>	File mode of the specific file <fn>.
588
589FILESDIR_<fn>	The location to install the specific file <fn>>
590
591FILESNAME_<fn>	Optional name to install <fn> as.
592
593
594BUILDSYMLINKS	List of two word items:
595			lnsrc lntgt
596		For each lnsrc item, create a symlink named lntgt.
597		The lntgt symlinks are removed by the cleandir target.
598
599UUDECODE_FILES	List of files which are stored as <file>.uue in the source
600		tree. Each one will be decoded with ${TOOL_UUDECODE}.
601		The source files have a `.uue' suffix, the generated files do 
602		not.
603
604UUDECODE_FILES_RENAME_fn Rename the output from the decode to the provided name.
605		
606		*NOTE: These files are simply decoded, with no install or other
607		       rule applying implicitly except being added to the clean
608		       target.
609
610=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
611
612The include file <bsd.gcc.mk> computes various parameters related to GCC
613support libraries.  It defines no targets.  <bsd.own.mk> MUST be included
614before <bsd.gcc.mk>.
615
616The primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
617of which need to know where to find certain GCC support libraries.
618
619The behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
620which is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
621the compiler is asked where to find the support libraries, otherwise the
622support libraries are found in ${DESTDIR}/usr/lib.
623
624<bsd.gcc.mk> sets the following variables:
625
626_GCC_CRTBEGIN	The full path name to crtbegin.o.
627
628_GCC_CRTBEGINS	The full path name to crtbeginS.o.
629
630_GCC_CRTEND	The full path name to crtend.o.
631
632_GCC_CRTENDS	The full path name to crtendS.o.
633
634_GCC_LIBGCCDIR	The directory where libgcc.a is located.
635
636
637=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
638
639The include file <bsd.inc.mk> defines the includes target and uses the
640variables:
641
642INCS		The list of include files.
643
644INCSDIR		The location to install the include files.
645
646INCSNAME	Target name of the include file, if only one; same as
647		FILESNAME, but for include files.
648
649INCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
650		are installed in the 'includes' target and not the
651		(much later) 'install' target.
652
653INCSNAME_<file>	The name file <file> should be installed as, if not <file>,
654		same as FILESNAME_<file>, but for include files.
655
656
657=-=-=-=-=   bsd.info.mk   =-=-=-=-=
658
659The include file <bsd.info.mk> is used to generate and install GNU Info
660documentation from respective Texinfo source files.  It defines three
661implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
662following variables:
663
664TEXINFO		List of Texinfo source files.  Info documentation will
665		consist of single files with the extension replaced by
666		.info.
667
668INFOFLAGS	Flags to pass to makeinfo.  []
669
670
671=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
672
673The include file <bsd.kernobj.mk> defines variables related to the
674location of kernel sources and object directories.
675
676KERNSRCDIR	Is the location of the top of the kernel src.
677		[${_SRC_TOP_}/sys]
678
679KERNARCHDIR	Is the location of the machine dependent kernel sources.
680		[arch/${MACHINE}]
681
682KERNCONFDIR	Is where the configuration files for kernels are found.
683		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
684
685KERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
686		instance will be compiled in ${KERNOBJDIR}/GENERIC.
687		The default value is
688		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
689		if it exists or the target 'obj' is being made.
690		Otherwise the default is
691		${KERNSRCDIR}/${KERNARCHDIR}/compile.
692
693It is important that Makefiles (such as those under src/distrib) that
694wish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
695rather than make assumptions about the location of the compiled kernel.
696
697
698=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
699
700The include file <bsd.kinc.mk> defines the many targets (includes,
701subdirectories, etc.), and is used by kernel makefiles to handle
702include file installation.  It is intended to be included alone, by
703kernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
704Please see <bsd.kinc.mk> for more details, and keep the documentation
705in that file up to date.
706
707
708=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
709
710The include file <bsd.lib.mk> has support for building libraries.  It has
711the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
712includes, install, lint, and tags.  Additionally, it has a checkver target
713which checks for installed shared object libraries whose version is greater
714that the version of the source. It has a limited number of suffixes,
715consistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
716<bsd.shlib.mk> to get shared library parameters.
717
718It sets/uses the following variables:
719
720LIB		The name of the library to build.
721
722LIBDIR		Target directory for libraries.
723
724SHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
725		is not "no".
726
727USE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
728		as the path to install shared libraries to.
729		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
730		Default: no
731
732MKPRIVATELIB	If not "no", act as "MKPROFILE=no MKPIC=no MKLINT=no",
733		and don't install the (.a) library.
734		This is useful for "build only" helper libraries.
735		Default: no
736
737LINTLIBDIR	Target directory for lint libraries.
738
739LIBGRP		Library group.
740
741LIBOWN		Library owner.
742
743LIBMODE		Library mode.
744
745LDADD		Additional loader objects.
746
747MAN		The manual pages to be installed (use a .1 - .9 suffix).
748
749NOCHECKVER_<library>
750NOCHECKVER	If set, disables checking for installed shared object
751		libraries with versions greater than the source.  A
752		particular library name, without the "lib" prefix, may
753		be appended to the variable name to disable the check for
754		only that library.
755
756SRCS		List of source files to build the library.  Suffix types
757		.s, .c, and .f are supported.  Note, .s files are preferred
758		to .c files of the same name.  (This is not the default for
759		versions of make.)
760
761LIBDPLIBS	A list of the tuples:
762			libname  path-to-srcdir-of-libname
763
764		For each tuple;
765		     *	LIBDO.libname contains the .OBJDIR of the library
766			`libname', and if it is not set it is determined
767			from the srcdir and added to MAKEOVERRIDES (the
768			latter is to allow for build time optimization).
769		     *	LDADD gets  -L${LIBDO.libname} -llibname    added.
770		     *	DPADD gets  ${LIBDO.libname}/liblibname.so  or
771				    ${LIBDO.libname}/liblibname.a   added.
772
773		This variable may be used for individual libraries, as
774		well as in parent directories to cache common libraries 
775		as a build-time optimization.
776
777The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
778if it exists, as well as the include file <bsd.man.mk>.
779
780It has rules for building profiled objects; profiled libraries are
781built by default.
782
783Libraries are ranlib'd when made.
784
785
786=-=-=-=-=   bsd.links.mk   =-=-=-=-=
787
788The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
789and is included from from <bsd.lib.mk> and <bsd.prog.mk>.
790
791LINKS		The list of hard links, consisting of pairs of paths:
792			source-file target-file
793		${DESTDIR} is prepended to both paths before linking.
794		For example, to link /bin/test and /bin/[, use:
795			LINKS=/bin/test /bin/[
796
797CONFIGLINKS	Similar semantics to LINKS, except that the links
798		are installed by the `configinstall' target,
799		not the `install' target.
800
801SYMLINKS	The list of symbolic links, consisting of pairs of paths:
802			source-file target-file
803		${DESTDIR} is only prepended to target-file before linking.
804		For example, to symlink /usr/bin/tar to /bin/tar resulting
805		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
806			SYMLINKS=/bin/tar /usr/bin/tar
807
808CONFIGSYMLINKS	Similar semantics to SYMLINKS, except that the symbolic links
809		are installed by the `configinstall' target,
810		not the `install' target.
811
812
813=-=-=-=-=   bsd.man.mk   =-=-=-=-=
814
815The include file <bsd.man.mk> handles installing manual pages and their
816links.
817
818It has a two targets:
819
820	maninstall:
821		Install the manual page sources and their links.
822	catinstall:
823		Install the preformatted manual pages and their links.
824
825It sets/uses the following variables:
826
827MANDIR		Base path for manual installation.
828
829MANGRP		Manual group.
830
831MANOWN		Manual owner.
832
833MANMODE		Manual mode.
834
835MANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
836		or "/tahoe" for machine specific manual pages.
837
838MAN		The manual pages to be installed (use a .1 - .9 suffix).
839
840MLINKS		List of manual page links (using a .1 - .9 suffix).  The
841		linked-to file must come first, the linked file second,
842		and there may be multiple pairs.  The files are soft-linked.
843
844The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
845it exists.
846
847
848=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
849
850The include file <bsd.obj.mk> defines targets related to the creation
851and use of separated object and source directories.
852
853If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
854${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
855it exists.  Otherwise make(1) looks for the existence of a
856subdirectory (or a symlink to a directory) of the source directory
857into which built targets should be placed.  If an environment variable
858named MAKEOBJDIR is set, make(1) uses its value as the name of the
859object directory; failing that, make first looks for a subdirectory
860named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
861
862Object directories are not created automatically by make(1) if they
863don't exist; you need to run a separate "make obj".  (This will happen
864during a top-level build if "MKOBJDIRS" is set to a value other than
865"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
866and this is determined by a simple string prefix comparison -- object
867directories are created in a separate object directory tree, and a
868symlink to the object directory in that tree is created in the source
869directory; otherwise, "make obj" assumes that you're not in the main
870source tree and that it's not safe to use a separate object tree.
871
872Several variables used by <bsd.obj.mk> control exactly what
873directories and links get created during a "make obj":
874
875MAKEOBJDIR	If set, this is the component name of the object
876		directory.
877
878OBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
879		object directories or links named "obj.${MACHINE}";
880		otherwise, just creates ones named "obj".
881
882USR_OBJMACHINE  If set, and the current directory is a subdirectory of
883		${BSDSRCDIR}, create object directory in the
884		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
885		otherwise, create it in the corresponding subdirectory
886		of ${BSDOBJDIR}
887
888BUILDID		If set, the contents of this variable are appended
889		to the object directory name.  If OBJMACHINE is also
890		set, ".${BUILDID}" is added after ".${MACHINE}".
891
892
893=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
894
895The include file <bsd.prog.mk> handles building programs from one or
896more source files, along with their manual pages.  It has a limited number
897of suffixes, consistent with the current needs of the BSD tree. 
898<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
899
900It has eight targets:
901
902	all:
903		build the program and its manual page.  This also
904		creates a GDB initialization file (.gdbinit) in
905		the objdir.  The .gdbinit file sets the shared library
906		prefix to ${DESTDIR} to facilitate cross-debugging.
907	clean:
908		remove the program, any object files and the files a.out,
909		Errs, errs, mklog, and ${PROG}.core.
910	cleandir:
911		remove all of the files removed by the target clean, as
912		well as .depend, tags, and any manual pages.
913		`distclean' is a synonym for `cleandir'.
914	depend:
915		make the dependencies for the source files, and store
916		them in the file .depend.
917	includes:
918		install any header files.
919	install:
920		install the program and its manual pages; if the Makefile
921		does not itself define the target install, the targets
922		beforeinstall and afterinstall may also be used to cause
923		actions immediately before and after the install target
924		is executed.
925	lint:
926		run lint on the source files
927	tags:
928		create a tags file for the source files.
929
930It sets/uses the following variables:
931
932BINGRP		Binary group.
933
934BINOWN		Binary owner.
935
936BINMODE		Binary mode.
937
938CLEANFILES	Additional files to remove for the clean and cleandir targets.
939
940COPTS		Additional flags to the compiler when creating C objects.
941
942COPTS.<fn>	Additional flags to the compiler when creating the
943		C objects for <fn>.
944		For <fn>.[ly], "<fn>.c" must be used.
945
946CPUFLAGS	Additional flags to the compiler/assembler to select
947		CPU instruction set options, CPU tuning options, etc.
948
949CPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
950		For <fn>.[ly], "<fn>.c" must be used.
951
952CPPFLAGS	Additional flags to the C pre-processor.
953
954CPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
955		For <fn>.[ly], "<fn>.c" must be used.
956
957GDBINIT		List of GDB initialization files to add to "source"
958		directives in the .gdbinit file that is created in the
959		objdir.
960
961LDADD		Additional loader objects.  Usually used for libraries.
962		For example, to load with the compatibility and utility
963		libraries, use:
964
965			LDADD+=-lutil -lcompat
966
967LDFLAGS		Additional linker flags (passed to ${CC} during link).
968
969LINKS		See <bsd.links.mk>
970
971OBJCOPTS	Additional flags to the compiler when creating ObjC objects.
972
973OBJCOPTS.<fn>	Additional flags to the compiler when creating the
974		ObjC objects for <fn>.
975		For <fn>.[ly], "<fn>.c" must be used.
976
977SYMLINKS	See <bsd.links.mk>
978
979MAN		Manual pages (should end in .1 - .9).  If no MAN variable is
980		defined, "MAN=${PROG}.1" is assumed.
981
982PROG		The name of the program to build.  If not supplied, nothing
983		is built.
984
985PROG_CXX	If defined, the name of the program to build.  Also
986		causes <bsd.prog.mk> to link the program with the C++
987		compiler rather than the C compiler.  PROG_CXX overrides
988		the value of PROG if PROG is also set.
989
990PROGNAME	The name that the above program will be installed as, if
991		different from ${PROG}.
992
993SRCS		List of source files to build the program.  If SRCS is not
994		defined, it's assumed to be ${PROG}.c.
995
996DPSRCS		List of source files which are needed for generating
997		dependencies, but are not needed in ${SRCS}.
998
999DPADD		Additional dependencies for the program.  Usually used for
1000		libraries.  For example, to depend on the compatibility and
1001		utility libraries use:
1002
1003			DPADD+=${LIBCOMPAT} ${LIBUTIL}
1004
1005		The following libraries are predefined for DPADD:
1006
1007		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
1008		LIBASN1?=	${DESTDIR}/usr/lib/libasn1.a
1009		LIBBLUETOOTH?=	${DESTDIR}/usr/lib/libbluetooth.a
1010		LIBBSDMALLOC?=	${DESTDIR}/usr/lib/libbsdmalloc.a
1011		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
1012		LIBC?=		${DESTDIR}/usr/lib/libc.a
1013		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
1014		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
1015		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
1016		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
1017		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
1018		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
1019		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
1020		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
1021		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
1022		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
1023		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
1024		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
1025		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
1026		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
1027		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
1028		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
1029		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
1030		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
1031		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
1032		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
1033		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
1034		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
1035		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
1036		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
1037		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
1038		LIBL?=		${DESTDIR}/usr/lib/libl.a
1039		LIBM?=		${DESTDIR}/usr/lib/libm.a
1040		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
1041		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
1042		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
1043		LIBPAM?=	${DESTDIR}/usr/lib/libpam.a
1044		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
1045		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
1046		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
1047		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
1048		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
1049		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
1050		LIBRADIUS?=	${DESTDIR}/usr/lib/libradius.a
1051		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
1052		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
1053		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
1054		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
1055		LIBRT?=		${DESTDIR}/usr/lib/librt.a
1056		LIBSDP?=	${DESTDIR}/usr/lib/libsdp.a
1057		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
1058		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
1059		LIBSS?=		${DESTDIR}/usr/lib/libss.a
1060		LIBSSH?=	${DESTDIR}/usr/lib/libssh.a
1061		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
1062		LIBSSP?=	${DESTDIR}/usr/lib/libssp.a
1063		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
1064		LIBSUPCXX?=	${DESTDIR}/usr/lib/libsupc++.a
1065		LIBTERMCAP?=	${DESTDIR}/usr/lib/libtermcap.a
1066		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
1067		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
1068		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
1069		LIBY?=		${DESTDIR}/usr/lib/liby.a
1070		LIBZ?=		${DESTDIR}/usr/lib/libz.a
1071
1072SHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
1073		strings, using xstr(1). Note that this will not work with
1074		parallel makes.
1075
1076STRIPFLAG	The flag passed to the install program to cause the binary
1077		to be stripped.
1078
1079SUBDIR		A list of subdirectories that should be built as well.
1080		Each of the targets will execute the same target in the
1081		subdirectories.
1082
1083SCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
1084		These are installed exactly like programs.
1085
1086SCRIPTSDIR	The location to install the scripts.  Each script can be
1087		installed to a separate path by setting SCRIPTSDIR_<script>.
1088
1089SCRIPTSNAME	The name that the above program will be installed as, if
1090		different from ${SCRIPTS}. These can be further specialized
1091		by setting SCRIPTSNAME_<script>.
1092
1093FILES		See description of <bsd.files.mk>.
1094
1095SHLINKDIR	Target directory for shared linker.  See description of
1096		<bsd.own.mk> for additional information about this variable.
1097
1098The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
1099if it exists, as well as the include file <bsd.man.mk>.
1100
1101Some simple examples:
1102
1103To build foo from foo.c with a manual page foo.1, use:
1104
1105	PROG=	foo
1106
1107	.include <bsd.prog.mk>
1108
1109To build foo from foo.c with a manual page foo.2, add the line:
1110
1111	MAN=	foo.2
1112
1113If foo does not have a manual page at all, add the line:
1114
1115	MKMAN=	no
1116
1117If foo has multiple source files, add the line:
1118
1119	SRCS=	a.c b.c c.c d.c
1120
1121
1122=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
1123
1124The include file <bsd.rpc.mk> contains a makefile fragment used to
1125construct source files built by rpcgen.
1126
1127The following macros may be defined in makefiles which include
1128<bsd.rpc.mk> in order to control which files get built and how they
1129are to be built:
1130
1131RPC_INCS:	construct .h file from .x file
1132RPC_XDRFILES:	construct _xdr.c from .x file
1133		(for marshalling/unmarshalling data types)
1134RPC_SVCFILES:	construct _svc.c from .x file
1135		(server-side stubs)
1136RPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
1137
1138RPC_XDIR:	Directory containing .x/.h files
1139
1140
1141=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
1142
1143The include file <bsd.shlib.mk> computes parameters for shared library
1144installation and use.  It defines no targets.  <bsd.own.mk> MUST be
1145included before <bsd.shlib.mk>.
1146
1147<bsd.own.mk> sets the following variables, if they are not already defined
1148(defaults are in brackets):
1149
1150SHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
1151		instead of ${LIBDIR} as the base path for shared library
1152		installation.  [/lib]
1153
1154SHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
1155		a program.  [/lib for programs in /bin and /sbin, /usr/lib
1156		for all others.]
1157
1158_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
1159		otherwise set to ${LIBDIR}
1160
1161SHLINKINSTALLDIR Base path for shared linker.  [/libexec]
1162
1163SHLINKDIR	Path to use for shared linker when building a program.
1164		[/libexec for programs in /bin and /sbin, /usr/libexec for
1165		all others.]
1166
1167
1168=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
1169
1170The include file <bsd.subdir.mk> contains the default targets for building
1171subdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
1172clean, cleandir, depend, includes, install, lint, and tags.  For all of
1173the directories listed in ${SUBDIR}, the specified directory will be
1174visited and the target made.  There is also a default target which allows
1175the command "make subdir" where subdir is any directory listed in ${SUBDIR}.
1176
1177As a special case, the use of a token .WAIT as an entry in SUBDIR acts
1178as a synchronization barrier when multiple make jobs are run; subdirs
1179before the .WAIT must complete before any subdirs after .WAIT are
1180started.  See make(1) for some caveats on use of .WAIT and other
1181special sources.
1182
1183
1184=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
1185
1186The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1187<bsd.lib.mk>.  It contains overrides that are used when building
1188the NetBSD source tree.
1189
1190The following variables control how various files are compiled/built.
1191(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
1192
1193AR		Create, modify, and extract from archives.  [ar]
1194
1195ARFLAGS		Options to ${AR}.  [rl]
1196
1197AS		Assembler.  [as]
1198
1199AFLAGS		Options to ${AS}.  []
1200
1201CC		C compiler.  [cc]
1202
1203CFLAGS		Options to ${CC}.  [Usually -O or -O2]
1204
1205CPP		C Pre-Processor.  [cpp]
1206
1207CPPFLAGS	Options to ${CPP}.  []
1208
1209CPUFLAGS	Optimization flags for ${CC}.  []
1210
1211CXX		C++ compiler.  [c++]
1212
1213CXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
1214
1215ELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
1216
1217FC		Fortran compiler.  [f77]
1218
1219FFLAGS		Options to {$FC}.  [-O]
1220
1221INSTALL		install(1) command.  [install]
1222
1223LEX		Lexical analyzer.  [lex]
1224
1225LFLAGS		Options to ${LEX}.  []
1226
1227LPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
1228
1229LD		Linker.  [ld]
1230
1231LDFLAGS		Options to ${CC} during the link process.  []
1232
1233LINT		C program verifier.  [lint]
1234
1235LINTFLAGS	Options to ${LINT}.  [-chapbxzFS]
1236
1237LORDER		List dependencies for object files.  [lorder]
1238
1239MAKE		make(1).  [make]
1240
1241MKDEP		Construct Makefile dependency list.  [mkdep]
1242
1243NM		List symbols from object files.  [nm]
1244
1245PC		Pascal compiler.  [pc]  (Not present)
1246
1247PFLAGS		Options to ${PC}.  []
1248
1249OBJC		Objective C compiler.  [${CC}]
1250
1251OBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
1252
1253OBJCOPY		Copy and translate object files.  [objcopy]
1254
1255OBJDUMP		Display information from object files.  [objdump]
1256
1257RANLIB		Generate index to archive.  [ranlib]
1258
1259SHELL		Shell.  [sh]
1260
1261SIZE		List section sizes and total size.  [size]
1262
1263STRIP		Discard symbols from object files.  [strip]
1264
1265TSORT		Topological sort of a directed graph.  [tsort -q]
1266
1267YACC		LALR(1) parser generator.  [yacc]
1268
1269YFLAGS		Options to ${YACC}.  []
1270
1271YHEADER		If defined, add "-d" to YFLAGS, and add dependencies
1272		from <file>.y to <file>.h and <file>.c, and add
1273		<foo>.h to CLEANFILES.
1274
1275YPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
1276
1277
1278The following variables are defined to commands to perform the
1279appropriate operation, with the default in [brackets].
1280(Note that these are overridden in <bsd.own.mk> if USETOOLS == "yes"):
1281
1282TOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
1283
1284TOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
1285
1286TOOL_CAT		Concatenate and print files.  [cat]
1287
1288TOOL_CKSUM		Display file checksums.  [cksum]
1289
1290TOOL_COMPILE_ET		Error table compiler.  [compile_et]
1291
1292TOOL_CONFIG		Build kernel compilation directories.  [config]
1293
1294TOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
1295
1296TOOL_CTAGS		Create a tags file.  [ctags]
1297
1298TOOL_DB			Manipulate db(3) databases.  [db]
1299
1300TOOL_EQN		Format equations for groff.  [eqn]
1301
1302TOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
1303
1304TOOL_GENASSYM		Generate constants for assembly files.  [genassym]
1305
1306TOOL_GENCAT		Generate NLS message catalogs.  [gencat]
1307
1308TOOL_GROFF		Front end for groff document formatting system.  [groff]
1309
1310TOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
1311
1312TOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
1313
1314TOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
1315
1316TOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
1317
1318TOOL_M4			M4 macro language processor.  [m4]
1319
1320TOOL_MAKEFS		Create file system image from directory tree.  [makefs]
1321
1322TOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
1323
1324TOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
1325
1326TOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
1327
1328TOOL_MENUC		Menu compiler.  [menuc]
1329
1330TOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
1331
1332TOOL_MKESDB		Make encoding scheme database.  [mkesdb]
1333
1334TOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
1335
1336TOOL_MKMAGIC		Create database for file(1).  [file]
1337
1338TOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
1339
1340TOOL_MSGC		Simple message list compiler.  [msgc]
1341
1342TOOL_MTREE		Map a directory hierarchy.  [mtree]
1343
1344TOOL_PAX		Manipulate file archives and copy directories.  [pax]
1345
1346TOOL_PIC		Compile pictures for groff.  [pic]
1347
1348TOOL_PREPMKBOOTIMAGE	prep-mkbootimage (XXXBUILDSH).  [prep-mkbootimage]
1349
1350TOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
1351
1352TOOL_REFER		Preprocess bibliographic references for groff.  [refer]
1353
1354TOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
1355
1356TOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
1357
1358TOOL_ROFF_HTML		Generate HTML groff output.
1359			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
1360
1361TOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
1362
1363TOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
1364
1365TOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
1366
1367TOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
1368
1369TOOL_STAT		Display file status.  [stat]
1370
1371TOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
1372
1373TOOL_TBL		Format tables for groff.  [tbl]
1374
1375TOOL_UUDECODE		Uudecode a binary file.  [uudecode]
1376
1377TOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
1378
1379TOOL_ZIC		Time zone compiler.  [zic]
1380
1381
1382Other variables of note (incomplete list):
1383
1384WARNS		Crank up gcc warning options; the distinct levels are:
1385			WARNS=1
1386			WARNS=2
1387			WARNS=3
1388			WARNS=4
1389
1390=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
1391
1392The include file <bsd.x11.mk> contains parameters and targets for
1393cross-building X11R6 from ${X11SRCDIR.xc}.
1394It should be included after the general Makefile contents but before
1395the include files such as <bsd.prog.mk> and <bsd.lib.mk>.
1396
1397It provides the following targets:
1398	.man.1 .man.3 .man.4 .man.5 .man.7:
1399		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
1400		these rules convert from X11R6's manual page source
1401		into an mdoc.old source file.
1402	cleanx11man:
1403		Clean up the mdoc.old files generated by the above.
1404
1405It sets the following variables:
1406
1407BINDIR			Set to ${X11BINDIR}.
1408			To override, define after including <bsd.x11.mk>
1409
1410LIBDIR			Set to ${X11USRLIBDIR}.
1411			To override, define after including <bsd.x11.mk>
1412
1413MANDIR			Set to ${X11MANDIR}.
1414			To override, define after including <bsd.x11.mk>
1415
1416CPPFLAGS		Appended with definitions to include from
1417			${DESTDIR}${X11INCDIR}
1418
1419LDFLAGS			Appended with definitions to link from
1420			${DESTDIR}${X11USRLIBDIR}
1421
1422X11FLAGS.CONNECTION	Equivalent to X11R6's CONNECTION_FLAGS.
1423
1424X11FLAGS.EXTENSION	Equivalent to X11R6's EXT_DEFINES.
1425
1426X11FLAGS.LOADABLE	Equivalent to X11R6's LOADABLE.
1427
1428X11FLAGS.OS_DEFINES	Equivalent to X11R6's OS_DEFINES.
1429
1430X11FLAGS.SERVER		Equivalent to X11R6's ServerDefines.
1431
1432X11FLAGS.THREADLIB	Equivalent to X11R6's THREADS_DEFINES for libraries.
1433
1434X11FLAGS.THREADS	Equivalent to X11R6's THREADS_DEFINES.
1435
1436X11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
1437
1438X11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
1439
1440It uses the following variables:
1441
1442APPDEFS			List of app-default files to install.
1443
1444CPPSCRIPTS		List of files/scripts to run through cpp(1)
1445			and then ${X11TOOL_UNXCOMM}.  The source files
1446			have a `.cpp' suffix, the generated files do not.
1447
1448CPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
1449
1450CPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
1451
1452
1453=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1454