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