bind/OPTIONS.md

<!--
Copyright (C) Internet Systems Consortium, Inc. ("ISC")

SPDX-License-Identifier: MPL-2.0

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0.  If a copy of the MPL was not distributed with this
file, you can obtain one at https://mozilla.org/MPL/2.0/.

See the COPYRIGHT file distributed with this work for additional
information regarding copyright ownership.
-->
Setting the `CPPFLAGS` environment variable before running `configure`
can be used to enable certain compile-time options that are not
explicitly defined in `configure`.

Some of these settings are:

| Setting                      | Description                                                                                                                            |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `-DCHECK_LOCAL=0`            | Don't check out-of-zone addresses in `named-checkzone`                                                                                 |
| `-DCHECK_SIBLING=0`          | Don't check sibling glue in `named-checkzone`                                                                                          |
| `-DISC_FACILITY=LOG_LOCAL0`  | Change the default syslog facility for `named`                                                                                         |
| `-DISC_HEAP_CHECK`           | Test heap consistency after every heap operation; used when debugging                                                                  |
| `-DISC_MEM_DEFAULTFILL=1`    | Overwrite memory with tag values when allocating or freeing it; this impairs performance but makes debugging of memory problems easier |
| `-DISC_MEM_TRACKLINES=0`     | Don't track memory allocations by file and line number; this improves performance but makes debugging more difficult                   |
| `-DNAMED_RUN_PID_DIR=0`      | Create default PID files in `${localstatedir}/run` rather than `${localstatedir}/run/named/`                                           |
| `-DNS_CLIENT_DROPPORT=0`     | Disable dropping queries from particular well-known ports                                                                              |
[master] change markdown comment style for pandoc 2017-04-27 23:38:51 -07:00			`<!--`
Update the copyright information in all files in the repository This commit converts the license handling to adhere to the REUSE specification. It specifically: 1. Adds used licnses to LICENSES/ directory 2. Add "isc" template for adding the copyright boilerplate 3. Changes all source files to include copyright and SPDX license header, this includes all the C sources, documentation, zone files, configuration files. There are notes in the doc/dev/copyrights file on how to add correct headers to the new files. 4. Handle the rest that can't be modified via .reuse/dep5 file. The binary (or otherwise unmodifiable) files could have license places next to them in <foo>.license file, but this would lead to cluttered repository and most of the files handled in the .reuse/dep5 file are system test files. 2021-06-03 08:37:05 +02:00			`Copyright (C) Internet Systems Consortium, Inc. ("ISC")`

			`SPDX-License-Identifier: MPL-2.0`

			`This Source Code Form is subject to the terms of the Mozilla Public`
			`License, v. 2.0. If a copy of the MPL was not distributed with this`
			`file, you can obtain one at https://mozilla.org/MPL/2.0/.`

			`See the COPYRIGHT file distributed with this work for additional`
			`information regarding copyright ownership.`
[master] change markdown comment style for pandoc 2017-04-27 23:38:51 -07:00			`-->`
Revise OPTIONS.md - The STD_CDEFINES build-time variable was dropped when the build system was migrated to Automake. CPPFLAGS is the variable which should now be used for setting preprocessor macros. - Sort the list of preprocessor macros which affect BIND behavior. Remove ISC_BUFFER_USEINLINE from the list as it can be controlled using its relevant ./configure option (--enable-buffer-useinline). Rename NS_RUN_PID_DIR to NAMED_RUN_PID_DIR to match the source code. - Tweak Markdown formatting. 2020-11-19 10:35:57 +01:00			Setting the `CPPFLAGS` environment variable before running `configure`
			`can be used to enable certain compile-time options that are not`
			explicitly defined in `configure`.
[master] update README, remove FAQ 4593. [doc] Update README using markdown, remove outdated FAQ file in favor of the knowledge base. 2017-04-20 19:21:54 -07:00
			`Some of these settings are:`

Revise OPTIONS.md - The STD_CDEFINES build-time variable was dropped when the build system was migrated to Automake. CPPFLAGS is the variable which should now be used for setting preprocessor macros. - Sort the list of preprocessor macros which affect BIND behavior. Remove ISC_BUFFER_USEINLINE from the list as it can be controlled using its relevant ./configure option (--enable-buffer-useinline). Rename NS_RUN_PID_DIR to NAMED_RUN_PID_DIR to match the source code. - Tweak Markdown formatting. 2020-11-19 10:35:57 +01:00			`\| Setting \| Description \|`
			`\| ---------------------------- \| -------------------------------------------------------------------------------------------------------------------------------------- \|`
			\| `-DCHECK_LOCAL=0` \| Don't check out-of-zone addresses in `named-checkzone` \|
			\| `-DCHECK_SIBLING=0` \| Don't check sibling glue in `named-checkzone` \|
			\| `-DISC_FACILITY=LOG_LOCAL0` \| Change the default syslog facility for `named` \|
			\| `-DISC_HEAP_CHECK` \| Test heap consistency after every heap operation; used when debugging \|
			\| `-DISC_MEM_DEFAULTFILL=1` \| Overwrite memory with tag values when allocating or freeing it; this impairs performance but makes debugging of memory problems easier \|
			\| `-DISC_MEM_TRACKLINES=0` \| Don't track memory allocations by file and line number; this improves performance but makes debugging more difficult \|
			\| `-DNAMED_RUN_PID_DIR=0` \| Create default PID files in `${localstatedir}/run` rather than `${localstatedir}/run/named/` \|
			\| `-DNS_CLIENT_DROPPORT=0` \| Disable dropping queries from particular well-known ports \|