bsd.README revision 1.145
1#	$NetBSD: bsd.README,v 1.145 2004/02/06 22:13:58 jwise 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, except for ${MACHINE_ARCH} == "sh3"
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.  [-s]
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
432Additionally, the following variables may be set by <bsd.own.mk> or in a
433make configuration file to modify the behaviour of the system build
434process (default values are in brackets along with comments, if set by
435<bsd.own.mk>):
436
437USETOOLS	Indicates whether the tools specified by ${TOOLDIR} should
438		be used as part of a build in progress.
439		Supported values:
440
441		yes	Use the tools from TOOLDIR.
442			Must be set to this if cross-compiling.
443
444		no	Do not use the tools from TOOLDIR, but refuse to
445			build native compilation tool components that are
446			version-specific for that tool.
447
448		never	Do not use the tools from TOOLDIR, even when
449			building native tool components.  This is similar to
450			the traditional NetBSD build method, but does not
451			verify that the compilation tools in use are
452			up-to-date enough in order to build the tree
453			successfully.  This may cause build or runtime
454			problems when building the whole NetBSD source tree.
455
456		Default: "yes" if building all or part of a whole NetBSD
457		source tree (detected automatically); "no" otherwise
458		(to preserve traditional semantics of the <bsd.*.mk>
459		make(1) include files).
460
461OBJECT_FMT	Object file format.  [set to "ELF" on architectures that
462		use ELF -- currently if ${MACHINE_ARCH} is "alpha",
463		"mipsel", "mipseb", "powerpc", "sparc", "sparc64",
464		"i386" and some m68k machines, or set to "a.out" on
465		other architectures].
466
467TOOLCHAIN_MISSING
468		If not "no", this indicates that the platform being built
469		does not have a working in-tree toolchain.  If the
470		${MACHINE_ARCH} in question falls into this category,
471		TOOLCHAIN_MISSING is conditionally assigned the value "yes". 
472		Otherwise, the variable is unconditionally assigned the
473		value "no".
474		If not "no", ${MKBFD}, ${MKGCC}, and ${MKGDB} are
475		unconditionally assigned the value "no".
476
477EXTERNAL_TOOLCHAIN
478		This variable is not directly set by <bsd.own.mk>, but
479		including <bsd.own.mk> is the canonical way to gain
480		access to this variable.  The variable should be defined
481		either in the user's environment or in the user's mk.conf
482		file.  If defined, this variable indicates the root of
483		an external toolchain which will be used to build the
484		tree.  For example, if a platform is a ${TOOLCHAIN_MISSING}
485		platform, EXTERNAL_TOOLCHAIN can be used to re-enable the
486		cross-compile framework.
487
488		If EXTERNAL_TOOLCHAIN is defined, ${MKGCC} is unconditionally
489		assigned the value "no", since the external version of the
490		compiler may not be able to build the library components of
491		the in-tree compiler.
492
493		NOTE: This variable is not yet used in as many places as
494		it should be.  Expect the exact semantics of this variable
495		to change in the short term as parts of the cross-compile
496		framework continue to be cleaned up.
497
498<bsd.own.mk> is generally useful when building your own Makefiles so that
499they use the same default owners etc. as the rest of the tree.
500
501
502=-=-=-=-=   bsd.dep.mk   =-=-=-=-=
503
504The include file <bsd.dep.mk> contains the default targets for building
505.depend files.  It creates .d files from entries in SRCS and DPSRCS
506that are C, C++, or Objective C source files, and builds .depend from the
507.d files.  All other files in SRCS and all of DPSRCS will be used as
508dependencies for the .d files.  In order for this to function correctly,
509it should be .included after all other .mk files and directives that may
510modify SRCS or DPSRCS.  It uses the following variables:
511
512SRCS		List of source files to build the program.
513
514DPSRCS		List of source files which are needed for generating
515		dependencies, but are not needed in ${SRCS}.
516
517
518=-=-=-=-=   bsd.files.mk   =-=-=-=-=
519
520The include file <bsd.files.mk> handles the FILES variables and is included
521from <bsd.lib.mk> and <bsd.prog.mk>, and uses the following variables:
522
523FILES		The list of files to install.
524
525FILESOWN	File owner.  [${BINOWN}]
526
527FILESGRP	File group.  [${BINGRP}]
528
529FILESMODE	File mode.  [${BINMODE}]
530
531FILESDIR	The location to install the files.
532
533FILESNAME	Optional name to install each file as.
534
535FILESDIR.<fn>	The location to install the specific file <fn>.
536
537FILESNAME.<fn>	Optional name to install <fn> as.
538
539BUILDSYMLINKS	List of two word items:
540			lnsrc lntgt
541		For each lnsrc item, create a symlink named lntgt.
542		The lntgt symlinks are removed by the cleandir target.
543
544
545=-=-=-=-=   bsd.gcc.mk   =-=-=-=-=
546
547The include file <bsd.gcc.mk> computes various parameters related to GCC
548support libraries.  It defines no targets.  <bsd.own.mk> MUST be included
549before <bsd.gcc.mk>.
550
551The primary users of <bsd.gcc.mk> are <bsd.prog.mk> and <bsd.lib.mk>, each
552of which need to know where to find certain GCC support libraries.
553
554The behavior of <bsd.gcc.mk> is influenced by the EXTERNAL_TOOLCHAIN variable,
555which is generally set by the user.  If EXTERNAL_TOOLCHAIN it set, then
556the compiler is asked where to find the support libraries, otherwise the
557support libraries are found in ${DESTDIR}/usr/lib.
558
559<bsd.gcc.mk> sets the following variables:
560
561_GCC_CRTBEGIN	The full path name to crtbegin.o.
562
563_GCC_CRTBEGINS	The full path name to crtbeginS.o.
564
565_GCC_CRTEND	The full path name to crtend.o.
566
567_GCC_CRTENDS	The full path name to crtendS.o.
568
569_GCC_LIBGCCDIR	The directory where libgcc.a is located.
570
571
572=-=-=-=-=   bsd.inc.mk   =-=-=-=-=
573
574The include file <bsd.inc.mk> defines the includes target and uses the
575variables:
576
577INCS		The list of include files.
578
579INCSDIR		The location to install the include files.
580
581INCSNAME	Target name of the include file, if only one; same as
582		FILESNAME, but for include files.
583
584INCSYMLINKS	Similar to SYMLINKS in <bsd.links.mk>, except that these
585		are installed in the 'includes' target and not the
586		(much later) 'install' target.
587
588INCSNAME_<file>	The name file <file> should be installed as, if not <file>,
589		same as FILESNAME_<file>, but for include files.
590
591
592=-=-=-=-=   bsd.info.mk   =-=-=-=-=
593
594The include file <bsd.info.mk> is used to generate and install GNU Info
595documentation from respective Texinfo source files.  It defines three
596implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
597following variables:
598
599TEXINFO		List of Texinfo source files.  Info documentation will
600		consist of single files with the extension replaced by
601		.info.
602
603INFOFLAGS	Flags to pass to makeinfo.  []
604
605
606=-=-=-=-=   bsd.kernobj.mk   =-=-=-=-=
607
608The include file <bsd.kernobj.mk> defines variables related to the
609location of kernel sources and object directories.
610
611KERNSRCDIR	Is the location of the top of the kernel src.
612		[${_SRC_TOP_}/sys]
613
614KERNARCHDIR	Is the location of the machine dependent kernel sources.
615		[arch/${MACHINE}]
616
617KERNCONFDIR	Is where the configuration files for kernels are found.
618		[${KERNSRCDIR}/${KERNARCHDIR}/conf]
619
620KERNOBJDIR	Is the kernel build directory.  The kernel GENERIC for
621		instance will be compiled in ${KERNOBJDIR}/GENERIC.
622		The default value is
623		${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
624		if it exists or the target 'obj' is being made.
625		Otherwise the default is
626		${KERNSRCDIR}/${KERNARCHDIR}/compile.
627
628It is important that Makefiles (such as those under src/distrib) that
629wish to find compiled kernels use <bsd.kernobj.mk> and ${KERNOBJDIR}
630rather than make assumptions about the location of the compiled kernel.
631
632
633=-=-=-=-=   bsd.kinc.mk   =-=-=-=-=
634
635The include file <bsd.kinc.mk> defines the many targets (includes,
636subdirectories, etc.), and is used by kernel makefiles to handle
637include file installation.  It is intended to be included alone, by
638kernel Makefiles.  It uses similar variables to <bsd.inc.mk>.
639Please see <bsd.kinc.mk> for more details, and keep the documentation
640in that file up to date.
641
642
643=-=-=-=-=   bsd.lib.mk   =-=-=-=-=
644
645The include file <bsd.lib.mk> has support for building libraries.  It has
646the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
647includes, install, lint, and tags.  Additionally, it has a checkver target
648which checks for installed shared object libraries whose version is greater
649that the version of the source. It has a limited number of suffixes,
650consistent with the current needs of the BSD tree.  <bsd.lib.mk> includes
651<bsd.shlib.mk> to get shared library parameters.
652
653It sets/uses the following variables:
654
655LIB		The name of the library to build.
656
657LIBDIR		Target directory for libraries.
658
659SHLIBINSTALLDIR	Target directory for shared libraries if ${USE_SHLIBDIR}
660		is not "no".
661
662USE_SHLIBDIR	If not "no", use ${SHLIBINSTALLDIR} instead of ${LIBDIR}
663		as the path to install shared libraries to.
664		USE_SHLIBDIR must be defined before <bsd.own.mk> is included.
665		Default: no
666
667LINTLIBDIR	Target directory for lint libraries.
668
669LIBGRP		Library group.
670
671LIBOWN		Library owner.
672
673LIBMODE		Library mode.
674
675LDADD		Additional loader objects.
676
677MAN		The manual pages to be installed (use a .1 - .9 suffix).
678
679NOCHECKVER_<library>
680NOCHECKVER	If set, disables checking for installed shared object
681		libraries with versions greater than the source.  A
682		particular library name, without the "lib" prefix, may
683		be appended to the variable name to disable the check for
684		only that library.
685
686SRCS		List of source files to build the library.  Suffix types
687		.s, .c, and .f are supported.  Note, .s files are preferred
688		to .c files of the same name.  (This is not the default for
689		versions of make.)
690
691The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
692if it exists, as well as the include file <bsd.man.mk>.
693
694It has rules for building profiled objects; profiled libraries are
695built by default.
696
697Libraries are ranlib'd when made.
698
699
700=-=-=-=-=   bsd.links.mk   =-=-=-=-=
701
702The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
703and is included from from <bsd.lib.mk> and <bsd.prog.mk>.
704
705LINKS		The list of hard links, consisting of pairs of paths:
706			source-file target-file
707		${DESTDIR} is prepended to both paths before linking.
708		For example, to link /bin/test and /bin/[, use:
709			LINKS=/bin/test /bin/[
710
711SYMLINKS	The list of symbolic links, consisting of pairs of paths:
712			source-file target-file
713		${DESTDIR} is only prepended to target-file before linking.
714		For example, to symlink /usr/bin/tar to /bin/tar resulting
715		in ${DESTDIR}/usr/bin/tar -> /bin/tar:
716			SYMLINKS=/bin/tar /usr/bin/tar
717
718
719=-=-=-=-=   bsd.man.mk   =-=-=-=-=
720
721The include file <bsd.man.mk> handles installing manual pages and their
722links.
723
724It has a two targets:
725
726	maninstall:
727		Install the manual page sources and their links.
728	catinstall:
729		Install the preformatted manual pages and their links.
730
731It sets/uses the following variables:
732
733MANDIR		Base path for manual installation.
734
735MANGRP		Manual group.
736
737MANOWN		Manual owner.
738
739MANMODE		Manual mode.
740
741MANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
742		or "/tahoe" for machine specific manual pages.
743
744MAN		The manual pages to be installed (use a .1 - .9 suffix).
745
746MLINKS		List of manual page links (using a .1 - .9 suffix).  The
747		linked-to file must come first, the linked file second,
748		and there may be multiple pairs.  The files are soft-linked.
749
750The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
751it exists.
752
753
754=-=-=-=-=   bsd.obj.mk   =-=-=-=-=
755
756The include file <bsd.obj.mk> defines targets related to the creation
757and use of separated object and source directories.
758
759If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
760${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
761it exists.  Otherwise make(1) looks for the existence of a
762subdirectory (or a symlink to a directory) of the source directory
763into which built targets should be placed.  If an environment variable
764named MAKEOBJDIR is set, make(1) uses its value as the name of the
765object directory; failing that, make first looks for a subdirectory
766named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
767
768Object directories are not created automatically by make(1) if they
769don't exist; you need to run a separate "make obj".  (This will happen
770during a top-level build if "MKOBJDIRS" is set to a value other than
771"no").  When the source directory is a subdirectory of ${BSDSRCDIR} --
772and this is determined by a simple string prefix comparison -- object
773directories are created in a separate object directory tree, and a
774symlink to the object directory in that tree is created in the source
775directory; otherwise, "make obj" assumes that you're not in the main
776source tree and that it's not safe to use a separate object tree.
777
778Several variables used by <bsd.obj.mk> control exactly what
779directories and links get created during a "make obj":
780
781MAKEOBJDIR	If set, this is the component name of the object
782		directory.
783
784OBJMACHINE	If this is set but MAKEOBJDIR is not set, creates
785		object directories or links named "obj.${MACHINE}";
786		otherwise, just creates ones named "obj".
787
788USR_OBJMACHINE  If set, and the current directory is a subdirectory of
789		${BSDSRCDIR}, create object directory in the
790		corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
791		otherwise, create it in the corresponding subdirectory
792		of ${BSDOBJDIR}
793
794BUILDID		If set, the contents of this variable are appended
795		to the object directory name.  If OBJMACHINE is also
796		set, ".${BUILDID}" is added after ".${MACHINE}".
797
798
799=-=-=-=-=   bsd.prog.mk   =-=-=-=-=
800
801The include file <bsd.prog.mk> handles building programs from one or
802more source files, along with their manual pages.  It has a limited number
803of suffixes, consistent with the current needs of the BSD tree. 
804<bsd.prog.mk> includes <bsd.shlib.mk> to get shared library parameters.
805
806It has eight targets:
807
808	all:
809		build the program and its manual page.  This also
810		creates a GDB initialization file (.gdbinit) in
811		the objdir.  The .gdbinit file sets the shared library
812		prefix to ${DESTDIR} to facilitate cross-debugging.
813	clean:
814		remove the program, any object files and the files a.out,
815		Errs, errs, mklog, and ${PROG}.core.
816	cleandir:
817		remove all of the files removed by the target clean, as
818		well as .depend, tags, and any manual pages.
819		`distclean' is a synonym for `cleandir'.
820	depend:
821		make the dependencies for the source files, and store
822		them in the file .depend.
823	includes:
824		install any header files.
825	install:
826		install the program and its manual pages; if the Makefile
827		does not itself define the target install, the targets
828		beforeinstall and afterinstall may also be used to cause
829		actions immediately before and after the install target
830		is executed.
831	lint:
832		run lint on the source files
833	tags:
834		create a tags file for the source files.
835
836It sets/uses the following variables:
837
838BINGRP		Binary group.
839
840BINOWN		Binary owner.
841
842BINMODE		Binary mode.
843
844CLEANFILES	Additional files to remove for the clean and cleandir targets.
845
846COPTS		Additional flags to the compiler when creating C objects.
847
848COPTS.<fn>	Additional flags to the compiler when creating the
849		C objects for <fn>.
850		For <fn>.[ly], "<fn>.c" must be used.
851
852CPUFLAGS	Additional flags to the compiler/assembler to select
853		CPU instruction set options, CPU tuning options, etc.
854
855CPUFLAGS.<fn>	Additional flags to the compiler/assembler for <fn>.
856		For <fn>.[ly], "<fn>.c" must be used.
857
858CPPFLAGS	Additional flags to the C pre-processor.
859
860CPPFLAGS.<fn>	Additional flags to the C pre-processor for <fn>.
861		For <fn>.[ly], "<fn>.c" must be used.
862
863GDBINIT		List of GDB initialization files to add to "source"
864		directives in the .gdbinit file that is created in the
865		objdir.
866
867LDADD		Additional loader objects.  Usually used for libraries.
868		For example, to load with the compatibility and utility
869		libraries, use:
870
871			LDADD+=-lutil -lcompat
872
873LDFLAGS		Additional loader flags.
874
875LINKS		See <bsd.links.mk>
876
877SYMLINKS	See <bsd.links.mk>
878
879MAN		Manual pages (should end in .1 - .9).  If no MAN variable is
880		defined, "MAN=${PROG}.1" is assumed.
881
882PROG		The name of the program to build.  If not supplied, nothing
883		is built.
884
885PROG_CXX	If defined, the name of the program to build.  Also
886		causes <bsd.prog.mk> to link the program with the C++
887		compiler rather than the C compiler.  PROG_CXX overrides
888		the value of PROG if PROG is also set.
889
890PROGNAME	The name that the above program will be installed as, if
891		different from ${PROG}.
892
893SRCS		List of source files to build the program.  If SRCS is not
894		defined, it's assumed to be ${PROG}.c.
895
896DPSRCS		List of source files which are needed for generating
897		dependencies, but are not needed in ${SRCS}.
898
899DPADD		Additional dependencies for the program.  Usually used for
900		libraries.  For example, to depend on the compatibility and
901		utility libraries use:
902
903			DPADD+=${LIBCOMPAT} ${LIBUTIL}
904
905		The following libraries are predefined for DPADD:
906
907		LIBCRT0?=	${DESTDIR}/usr/lib/crt0.o
908		LIBBZ2?=	${DESTDIR}/usr/lib/libbz2.a
909		LIBC?=		${DESTDIR}/usr/lib/libc.a
910		LIBC_PIC?=	${DESTDIR}/usr/lib/libc_pic.a
911		LIBCDK?=	${DESTDIR}/usr/lib/libcdk.a
912		LIBCOM_ERR?=	${DESTDIR}/usr/lib/libcom_err.a
913		LIBCOMPAT?=	${DESTDIR}/usr/lib/libcompat.a
914		LIBCRYPT?=	${DESTDIR}/usr/lib/libcrypt.a
915		LIBCRYPTO?=	${DESTDIR}/usr/lib/libcrypto.a
916		LIBCRYPTO_IDEA?=${DESTDIR}/usr/lib/libcrypto_idea.a
917		LIBCRYPTO_MDC2?=${DESTDIR}/usr/lib/libcrypto_mdc2.a
918		LIBCRYPTO_RC5?=	${DESTDIR}/usr/lib/libcrypto_rc5.a
919		LIBCURSES?=	${DESTDIR}/usr/lib/libcurses.a
920		LIBDBM?=	${DESTDIR}/usr/lib/libdbm.a
921		LIBDES?=	${DESTDIR}/usr/lib/libdes.a
922		LIBEDIT?=	${DESTDIR}/usr/lib/libedit.a
923		LIBEVENT?=	${DESTDIR}/usr/lib/libevent.a
924		LIBFORM?=	${DESTDIR}/usr/lib/libform.a
925		LIBGCC?=	${DESTDIR}/usr/lib/libgcc.a
926		LIBGNUMALLOC?=	${DESTDIR}/usr/lib/libgnumalloc.a
927		LIBGSSAPI?=	${DESTDIR}/usr/lib/libgssapi.a
928		LIBHDB?=	${DESTDIR}/usr/lib/libhdb.a
929		LIBINTL?=	${DESTDIR}/usr/lib/libintl.a
930		LIBIPSEC?=	${DESTDIR}/usr/lib/libipsec.a
931		LIBKADM?=	${DESTDIR}/usr/lib/libkadm.a
932		LIBKADM5CLNT?=	${DESTDIR}/usr/lib/libkadm5clnt.a
933		LIBKADM5SRV?=	${DESTDIR}/usr/lib/libkadm5srv.a
934		LIBKAFS?=	${DESTDIR}/usr/lib/libkafs.a
935		LIBKDB?=	${DESTDIR}/usr/lib/libkdb.a
936		LIBKRB?=	${DESTDIR}/usr/lib/libkrb.a
937		LIBKRB5?=	${DESTDIR}/usr/lib/libkrb5.a
938		LIBKSTREAM?=	${DESTDIR}/usr/lib/libkstream.a
939		LIBKVM?=	${DESTDIR}/usr/lib/libkvm.a
940		LIBL?=		${DESTDIR}/usr/lib/libl.a
941		LIBM?=		${DESTDIR}/usr/lib/libm.a
942		LIBMENU?=	${DESTDIR}/usr/lib/libmenu.a
943		LIBOBJC?=	${DESTDIR}/usr/lib/libobjc.a
944		LIBOSSAUDIO?=	${DESTDIR}/usr/lib/libossaudio.a
945		LIBPCAP?=	${DESTDIR}/usr/lib/libpcap.a
946		LIBPCI?=	${DESTDIR}/usr/lib/libpci.a
947		LIBPMC?=	${DESTDIR}/usr/lib/libpmc.a
948		LIBPOSIX?=	${DESTDIR}/usr/lib/libposix.a
949		LIBPTHREAD?=	${DESTDIR}/usr/lib/libpthread.a
950		LIBPTHREAD_DBG?=${DESTDIR}/usr/lib/libpthread_dbg.a
951		LIBRESOLV?=	${DESTDIR}/usr/lib/libresolv.a
952		LIBRMT?=	${DESTDIR}/usr/lib/librmt.a
953		LIBROKEN?=	${DESTDIR}/usr/lib/libroken.a
954		LIBRPCSVC?=	${DESTDIR}/usr/lib/librpcsvc.a
955		LIBRT?=		${DESTDIR}/usr/lib/librt.a
956		LIBSKEY?=	${DESTDIR}/usr/lib/libskey.a
957		LIBSL?=		${DESTDIR}/usr/lib/libsl.a
958		LIBSS?=		${DESTDIR}/usr/lib/libss.a
959		LIBSSL?=	${DESTDIR}/usr/lib/libssl.a
960		LIBSTDCXX?=	${DESTDIR}/usr/lib/libstdc++.a
961		LIBTERMCAP?=	${DESTDIR}/usr/lib/libtermcap.a
962		LIBUSBHID?=	${DESTDIR}/usr/lib/libusbhid.a
963		LIBUTIL?=	${DESTDIR}/usr/lib/libutil.a
964		LIBWRAP?=	${DESTDIR}/usr/lib/libwrap.a
965		LIBY?=		${DESTDIR}/usr/lib/liby.a
966		LIBZ?=		${DESTDIR}/usr/lib/libz.a
967
968SHAREDSTRINGS	If defined, a new .c.o rule is used that results in shared
969		strings, using xstr(1). Note that this will not work with
970		parallel makes.
971
972STRIPFLAG	The flag passed to the install program to cause the binary
973		to be stripped.
974
975SUBDIR		A list of subdirectories that should be built as well.
976		Each of the targets will execute the same target in the
977		subdirectories.
978
979SCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
980		These are installed exactly like programs.
981
982SCRIPTSNAME	The name that the above program will be installed as, if
983		different from ${SCRIPTS}. These can be further specialized
984		by setting SCRIPTSNAME_<script>.
985
986FILES		See description of <bsd.files.mk>.
987
988SHLINKDIR	Target directory for shared linker.  See description of
989		<bsd.own.mk> for additional information about this variable.
990
991USE_LIBSTDCXX	If "no", the support libraries needed for C++ programs
992		are set to `-lsupc++ -lm', rather than `-lstdc++ -lm'.
993		Default: yes
994
995The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
996if it exists, as well as the include file <bsd.man.mk>.
997
998Some simple examples:
999
1000To build foo from foo.c with a manual page foo.1, use:
1001
1002	PROG=	foo
1003
1004	.include <bsd.prog.mk>
1005
1006To build foo from foo.c with a manual page foo.2, add the line:
1007
1008	MAN=	foo.2
1009
1010If foo does not have a manual page at all, add the line:
1011
1012	MKMAN=	no
1013
1014If foo has multiple source files, add the line:
1015
1016	SRCS=	a.c b.c c.c d.c
1017
1018
1019=-=-=-=-=   bsd.rpc.mk   =-=-=-=-=
1020
1021The include file <bsd.rpc.mk> contains a makefile fragment used to
1022construct source files built by rpcgen.
1023
1024The following macros may be defined in makefiles which include
1025<bsd.rpc.mk> in order to control which files get built and how they
1026are to be built:
1027
1028RPC_INCS:	construct .h file from .x file
1029RPC_XDRFILES:	construct _xdr.c from .x file
1030		(for marshalling/unmarshalling data types)
1031RPC_SVCFILES:	construct _svc.c from .x file
1032		(server-side stubs)
1033RPC_SVCFLAGS:	Additional flags passed to builds of RPC_SVCFILES.
1034
1035RPC_XDIR:	Directory containing .x/.h files
1036
1037
1038=-=-=-=-=   bsd.shlib.mk   =-=-=-=-=
1039
1040The include file <bsd.shlib.mk> computes parameters for shared library
1041installation and use.  It defines no targets.  <bsd.own.mk> MUST be
1042included before <bsd.shlib.mk>.
1043
1044<bsd.own.mk> sets the following variables, if they are not already defined
1045(defaults are in brackets):
1046
1047SHLIBINSTALLDIR	If ${USE_SHLIBDIR} is not "no", use ${SHLIBINSTALLDIR}
1048		instead of ${LIBDIR} as the base path for shared library
1049		installation.  [/lib]
1050
1051SHLIBDIR	The path to USE_SHLIBDIR shared libraries to use when building
1052		a program.  [/lib for programs in /bin and /sbin, /usr/lib
1053		for all others.]
1054
1055_LIBSODIR	Set to ${SHLIBINSTALLDIR} if ${USE_SHLIBDIR} is not "no",
1056		otherwise set to ${LIBDIR}
1057
1058SHLINKINSTALLDIR Base path for shared linker.  [/libexec]
1059
1060SHLINKDIR	Path to use for shared linker when building a program.
1061		[/libexec for programs in /bin and /sbin, /usr/libexec for
1062		all others.]
1063
1064
1065=-=-=-=-=   bsd.subdir.mk   =-=-=-=-=
1066
1067The include file <bsd.subdir.mk> contains the default targets for building
1068subdirectories.  It has the same eight targets as <bsd.prog.mk>: all,
1069clean, cleandir, depend, includes, install, lint, and tags.  For all of
1070the directories listed in ${SUBDIR}, the specified directory will be
1071visited and the target made.  There is also a default target which allows
1072the command "make subdir" where subdir is any directory listed in ${SUBDIR}.
1073
1074As a special case, the use of a token .WAIT as an entry in SUBDIR acts
1075as a synchronization barrier when multiple make jobs are run; subdirs
1076before the .WAIT must complete before any subdirs after .WAIT are
1077started.  See make(1) for some caveats on use of .WAIT and other
1078special sources.
1079
1080
1081=-=-=-=-=   bsd.sys.mk   =-=-=-=-=
1082
1083The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1084<bsd.lib.mk>.  It contains overrides that are used when building
1085the NetBSD source tree.
1086
1087The following variables control how various files are compiled/built.
1088(Note that these may be overridden in <bsd.own.mk> if USETOOLS == "yes"):
1089
1090AR		Create, modify, and extract from archives.  [ar]
1091
1092ARFLAGS		Options to ${AR}.  [rl]
1093
1094CC		C compiler.  [cc]
1095
1096CFLAGS		Options to ${CC}.  [Usually -O or -O2]
1097
1098CPP		C Pre-Processor.  [cpp]
1099
1100CPPFLAGS	Options to ${CPP}.  []
1101
1102CPUFLAGS	Optimization flags for ${CC}
1103
1104CXX		C++ compiler.  [c++]
1105
1106CXXFLAGS	Options to ${CXX}.  [${CFLAGS}]
1107
1108ELF2ECOFF	Convert ELF-format executable to ECOFF.  [elf2ecoff]
1109
1110FC		Fortran compiler.  [f77]
1111
1112FFLAGS		Options to {$FC}.  [-O]
1113
1114INSTALL		install(1) command.  [install]
1115
1116LEX		Lexical analyzer.  [lex]
1117
1118LFLAGS		Options to ${LEX}.  []
1119
1120LPREFIX		Symbol prefix for ${LEX} (see -P option in lex(1)) [yy]
1121
1122LD		Linker.  [ld]
1123
1124LDFLAGS		Options to ${LD}.  []
1125
1126LINT		C program verifier.  [lint]
1127
1128LINTFLAGS	Options to ${LINT}.  [-chapbxzF]
1129
1130LORDER		List dependencies for object files.  [lorder]
1131
1132MAKE		make(1).  [make]
1133
1134MKDEP		Construct Makefile dependency list.  [mkdep]
1135
1136NM		List symbols from object files.  [nm]
1137
1138PC		Pascal compiler.  [pc]  (Not present)
1139
1140PFLAGS		Options to ${PC}.  []
1141
1142OBJC		Objective C compiler.  [${CC}]
1143
1144OBJCFLAGS	Options to ${OBJC}.  [${CFLAGS}]
1145
1146OBJCOPY		Copy and translate object files.  [objcopy]
1147
1148RANLIB		Generate index to archive.  [ranlib]
1149
1150SHELL		Shell.  [sh]
1151
1152SIZE		List section sizes and total size.  [size]
1153
1154STRIP		Discard symbols from object files.  [strip]
1155
1156TSORT		Topological sort of a directed graph.  [tsort -q]
1157
1158YACC		LALR(1) parser generator.  [yacc]
1159
1160YFLAGS		Options to ${YACC}.  []
1161
1162YHEADER		If defined, add "-d" to YFLAGS, and add dependencies
1163		from <file>.y to <file>.h and <file>.c, and add
1164		<foo>.h to CLEANFILES.
1165
1166YPREFIX		If defined, add "-p ${YPREFIX}" to YFLAGS.
1167
1168
1169The following variables are defined to commands to perform the
1170appropriate operation, with the default in [brackets].
1171(Note that these are overridden in <bsd.own.mk> if USETOOLS == "yes"):
1172
1173TOOL_ASN1_COMPILE	ASN1 compiler.  [asn1_compile]
1174
1175TOOL_CAP_MKDB		Create capability database.  [cap_mkdb]
1176
1177TOOL_CAT		Concatenate and print files.  [cat]
1178
1179TOOL_CKSUM		Display file checksums.  [cksum]
1180
1181TOOL_COMPILE_ET		Error table compiler.  [compile_et]
1182
1183TOOL_CONFIG		Build kernel compilation directories.  [config]
1184
1185TOOL_CRUNCHGEN		Generate crunched binary build environment.  [crunchgen]
1186
1187TOOL_CTAGS		Create a tags file.  [ctags]
1188
1189TOOL_DB			Manipulate db(3) databases.  [db]
1190
1191TOOL_EQN		Format equations for groff.  [eqn]
1192
1193TOOL_FGEN		IEEE 1275 Open Firmware FCode Tokenizer.  [fgen]
1194
1195TOOL_GENCAT		Generate NLS message catalogs.  [gencat]
1196
1197TOOL_GROFF		Front end for groff document formatting system.  [groff]
1198
1199TOOL_HEXDUMP		Ascii, decimal, hexadecimal, octal dump.  [hexdump]
1200
1201TOOL_INDXBIB		Make bibliographic database's inverted index.  [indxbib]
1202
1203TOOL_INSTALLBOOT	Install disk bootstrap software.  [installboot]
1204
1205TOOL_INSTALL_INFO	Update info/dir entries.  [install-info]
1206
1207TOOL_M4			M4 macro language processor.  [m4]
1208
1209TOOL_MAKEFS		Create file system image from directory tree.  [makefs]
1210
1211TOOL_MAKEINFO		Translate Texinfo documents.  [makeinfo]
1212
1213TOOL_MAKEWHATIS		Create a whatis.db database.  [makewhatis]
1214
1215TOOL_MDSETIMAGE		Set kernel RAM disk image.  [mdsetimage]
1216
1217TOOL_MENUC		Menu compiler.  [menuc]
1218
1219TOOL_MKCSMAPPER		Make charset mapping table.  [mkcsmapper]
1220
1221TOOL_MKESDB		Make encoding scheme database.  [mkesdb]
1222
1223TOOL_MKLOCALE		Make LC_CTYPE locale files.  [mklocale]
1224
1225TOOL_MKMAGIC		Create database for file(1).  [file]
1226
1227TOOL_MKTEMP		Make (unique) temporary file name.  [mktemp]
1228
1229TOOL_MSGC		Simple message list compiler.  [msgc]
1230
1231TOOL_MTREE		Map a directory hierarchy.  [mtree]
1232
1233TOOL_PAX		Manipulate file archives and copy directories.  [pax]
1234
1235TOOL_PIC		Compile pictures for groff.  [pic]
1236
1237TOOL_PREPMKBOOTIMAGE	prep-mkbootimage (XXXBUILDSH).  [prep-mkbootimage]
1238
1239TOOL_PWD_MKDB		Generate the password databases.  [pwd_mkdb]
1240
1241TOOL_REFER		Preprocess bibliographic references for groff.  [refer]
1242
1243TOOL_ROFF_ASCII		Generate ASCII groff output.  [nroff]
1244
1245TOOL_ROFF_DVI		Generate DVI groff output.  [${TOOL_GROFF} -Tdvi]
1246
1247TOOL_ROFF_HTML		Generate HTML groff output.
1248			[${TOOL_GROFF} -Tlatin1 -mdoc2html]
1249
1250TOOL_ROFF_PS		Generate PS groff output.  [${TOOL_GROFF} -Tps]
1251
1252TOOL_ROFF_RAW		Generate "raw" groff output.  [${TOOL_GROFF} -Z]
1253
1254TOOL_RPCGEN		Remote Procedure Call (RPC) protocol compiler.  [rpcgen]
1255
1256TOOL_SOELIM		Eliminate .so's from groff input.  [soelim]
1257
1258TOOL_STAT		Display file status.  [stat]
1259
1260TOOL_SUNLABEL		Read or modify a SunOS disk label.  [sunlabel]
1261
1262TOOL_TBL		Format tables for groff.  [tbl]
1263
1264TOOL_UUDECODE		Uudecode a binary file.  [uudecode]
1265
1266TOOL_VGRIND		Grind nice listings of programs.  [vgrind -f]
1267
1268TOOL_ZIC		Time zone compiler.  [zic]
1269
1270
1271Other variables of note (incomplete list):
1272
1273WARNS		Crank up gcc warning options; the distinct levels are:
1274			WARNS=1
1275			WARNS=2
1276			WARNS=3
1277
1278FORMAT_AUDIT	If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on
1279WFORMAT 	-Wnetbsd-format-audit for extra-stringent format checking.
1280		WFORMAT belongs in individual makefiles and/or
1281		Makefile.inc files.  (set WFORMAT=1 in individual
1282		makefiles if a program is not security critical and is
1283		doing bizarre things with format strings which would
1284		be even uglier if rewritten) FORMAT_AUDIT should go in
1285		mk.conf if you're doing format-string auditing.
1286		FORMAT_AUDIT may go away in time.
1287
1288
1289=-=-=-=-=   bsd.x11.mk   =-=-=-=-=
1290
1291The include file <bsd.x11.mk> contains parameters and targets for
1292cross-building X11R6 from ${X11SRCDIR.xc}.
1293It should be included after the general Makefile contents but before
1294the include files such as <bsd.prog.mk> and <bsd.lib.mk>.
1295
1296It provides the following targets:
1297	.man.1 .man.3 .man.4 .man.5 .man.7:
1298		If ${MAN} or ${PROG} is set and ${MKMAN} != "no",
1299		these rules convert from X11R6's manual page source
1300		into an mdoc.old source file.
1301	cleanx11man:
1302		Clean up the mdoc.old files generated by the above.
1303
1304It sets the following variables:
1305
1306BINDIR			Set to ${X11BINDIR}.
1307			To override, define after including <bsd.x11.mk>
1308
1309LIBDIR			Set to ${X11USRLIBDIR}.
1310			To override, define after including <bsd.x11.mk>
1311
1312MANDIR			Set to ${X11MANDIR}.
1313			To override, define after including <bsd.x11.mk>
1314
1315CPPFLAGS		Appended with definitions to include from
1316			${DESTDIR}${X11INCDIR}
1317
1318LDFLAGS			Appended with definitions to link from
1319			${DESTDIR}${X11USRLIBDIR}
1320
1321X11FLAGS.CONNECTION	Equivalent to X11R6's CONNECTION_FLAGS.
1322
1323X11FLAGS.EXTENSION	Equivalent to X11R6's EXT_DEFINES.
1324
1325X11FLAGS.LOADABLE	Equivalent to X11R6's LOADABLE.
1326
1327X11FLAGS.OS_DEFINES	Equivalent to X11R6's OS_DEFINES.
1328
1329X11FLAGS.SERVER		Equivalent to X11R6's ServerDefines.
1330
1331X11FLAGS.THREADLIB	Equivalent to X11R6's THREADS_DEFINES for libraries.
1332
1333X11FLAGS.THREADS	Equivalent to X11R6's THREADS_DEFINES.
1334
1335X11FLAGS.VERSION	cpp(1) definitions of OSMAJORVERSION and OSMINORVERSION.
1336
1337X11TOOL_UNXCOMM		Commandline to convert `XCOMM' comments to `#'
1338
1339It uses the following variables:
1340
1341APPDEFS			List of app-default files to install.
1342
1343CPPSCRIPTS		List of files/scripts to run through cpp(1)
1344			and then ${X11TOOL_UNXCOMM}.  The source files
1345			have a `.cpp' suffix, the generated files do not.
1346
1347CPPSCRIPTFLAGS		Additional flags to cpp(1) when building CPPSCRIPTS.
1348
1349CPPSCRIPTFLAGS_<fn>	Additional flags to cpp(1) when building CPPSCRIPT <fn>.
1350
1351
1352=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1353