diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index d64a56d250..0b0b36ef85 100644 --- a/doc/sphinx/arm/dhcp4-srv.rst +++ b/doc/sphinx/arm/dhcp4-srv.rst @@ -2850,6 +2850,7 @@ global ``dhcp-ddns`` section of the kea-dhcp4. Beginning with Kea 1.7.1 DDNS related parameters were split into two groups: 1. Connectivity Parameters + These are parameters which specify where and how kea-dhcp4 connects to and communicates with D2. These parameters can only be specified within the top-level ``dhcp-ddns`` section in the kea-dhcp4 @@ -2865,6 +2866,7 @@ DDNS related parameters were split into two groups: - ``ncr-format"`` 2. Behavioral Parameters + These parameters influence behavior such as how client host names and FQDN options are handled. They have been moved out of the ``dhcp-ddns`` section so that they may be specified at the global, shared-network, @@ -2958,9 +2960,9 @@ with it. kea-dhcp4 uses the following configuration parameters to control this communication: - ``enable-updates`` - As of Kea 1.7.1, this parameter only enables - connectivity to kea-dhcp-ddns such that DDNS updates can be constructed - and sent. It must be true for NCRs to be generated and sent to D2. - It defaults to false. + connectivity to kea-dhcp-ddns such that DDNS updates can be constructed + and sent. It must be true for NCRs to be generated and sent to D2. + It defaults to false. - ``server-ip`` - the IP address on which D2 listens for requests. The default is the local loopback interface at address 127.0.0.1. diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst index fe8fb6d59f..b2be666198 100644 --- a/doc/sphinx/arm/dhcp6-srv.rst +++ b/doc/sphinx/arm/dhcp6-srv.rst @@ -2570,6 +2570,7 @@ global ``dhcp-ddns`` section of the kea-dhcp6. Beginning with Kea 1.7.1 DDNS related parameters were split into two groups: 1. Connectivity Parameters + These are parameters which specify where and how kea-dhcp6 connects to and communicates with D2. These parameters can only be specified within the top-level ``dhcp-ddns`` section in the kea-dhcp6 @@ -2585,6 +2586,7 @@ DDNS related parameters were split into two groups: - ``ncr-format"`` 2. Behavioral Parameters + These parameters influence behavior such as how client host names and FQDN options are handled. They have been moved out of the ``dhcp-ddns`` section so that they may be specified at the global, shared-network, @@ -2678,9 +2680,9 @@ with it. kea-dhcp6 uses the following configuration parameters to control this communication: - ``enable-updates`` - As of Kea 1.7.1, this parameter only enables - connectivity to kea-dhcp-ddns such that DDNS updates can be constructed - and sent. It must be true for NCRs to be generated and sent to D2. - It defaults to false. + connectivity to kea-dhcp-ddns such that DDNS updates can be constructed + and sent. It must be true for NCRs to be generated and sent to D2. + It defaults to false. - ``server-ip`` - IP address on which D2 listens for requests. The default is the local loopback interface at address 127.0.0.1. diff --git a/doc/sphinx/arm/install.rst b/doc/sphinx/arm/install.rst index 768ba619e2..272cff941b 100644 --- a/doc/sphinx/arm/install.rst +++ b/doc/sphinx/arm/install.rst @@ -198,43 +198,43 @@ generate the makefiles using the defaults, simply run: Run ``./configure`` with the ``--help`` switch to view the different options. Some commonly used options are: ---prefix + - ``--prefix`` Define the installation location (the default is ``/usr/local``). ---with-mysql + - ``--with-mysql`` Build Kea with code to allow it to store leases and host reservations in a MySQL database. ---with-pgsql + - ``--with-pgsql`` Build Kea with code to allow it to store leases and host reservations in a PostgreSQL database. ---with-cql + - ``--with-cql`` Build Kea with code to allow it to store leases and host reservations in a Cassandra (CQL) database. ---with-log4cplus + - ``--with-log4cplus`` Define the path to find the Log4cplus headers and libraries. Normally this is not necessary. ---with-boost-include + - ``--with-boost-include`` Define the path to find the Boost headers. Normally this is not necessary. ---with-botan-config + - ``--with-botan-config`` Specify the path to the botan-config script to build with Botan for cryptographic functions. It is preferable to use OpenSSL (see below). ---with-openssl + - ``--with-openssl`` Replace Botan by the OpenSSL the cryptographic library. By default ``configure`` searches for a valid Botan installation. If one is not found, it searches for OpenSSL. Normally this is not necessary. ---enable-shell + - ``--enable-shell`` Build the optional ``kea-shell`` tool (more in :ref:`kea-shell`). The default is to not build it. ---with-site-packages + - ``--with-site-packages`` Only useful when ``kea-shell`` is enabled. It causes the kea-shell python packages to be installed in specified directory. This is mostly useful for Debian related distros. While most systems store @@ -243,7 +243,7 @@ options. Some commonly used options are: python packages are expected to be installed in /usr/lib/python3/dist-packages. ---enable-perfdhcp + - ``--enable-perfdhcp`` Build the optional ``perfdhcp`` DHCP benchmarking tool. The default is to not build it. @@ -274,20 +274,20 @@ There are also many additional options that are typically not necessary for regular users. However, they may be useful for package maintainers, developers, or people who want to extend Kea code or send patches: ---with-gtest, --with-gtest-source + - ``--with-gtest``, ``--with-gtest-source`` Enable the building of the C++ Unit Tests using the Google Test framework. This option specifies the path to the gtest source. (If the framework is not installed on your system, it can be downloaded from https://github.com/google/googletest.) ---enable-generate-docs + - ``--enable-generate-docs`` Enable the rebuilding Kea documentation. ISC publishes Kea documentation for each release; however, in some cases you may want to rebuild it. For example, if you want to change something in the docs, or want to generate new ones from git sources that are not released yet. ---enable-generate-parser + - ``--enable-generate-parser`` Many Kea components have parsers implemented using flex (.ll files) and bison (.yy files). Kea sources have C++/h files generated out from them. By default Kea does not use flex or bison to avoid @@ -296,7 +296,7 @@ developers, or people who want to extend Kea code or send patches: parameter), you will need to use flex and bison to regenerate parsers. This option lets you do that. ---enable-generate-messages + - ``--enable-generate-messages`` Enable the regeneration of messages files from their messages source files, e.g. regenerate xxx_messages.h and xxx_messages.cc from xxx_messages.mes using the Kea message compiler. By default Kea is @@ -305,7 +305,7 @@ developers, or people who want to extend Kea code or send patches: will need to build and use the Kea message compiler. This option lets you do that. ---with-benchmark, --with-benchmark-source + - ``--with-benchmark``, ``--with-benchmark-source`` Enable the building of the database backend benchmarks using the Google Benchmark framework. This option specifies the path to the gtest source. (If the framework is not installed on your system, it diff --git a/doc/sphinx/arm/logging.rst b/doc/sphinx/arm/logging.rst index d81686f130..fcafc0f6ac 100644 --- a/doc/sphinx/arm/logging.rst +++ b/doc/sphinx/arm/logging.rst @@ -646,31 +646,31 @@ and a typical log produced by this pattern would look somethng like this: That breaks down as like so: -- %D{%Y-%m-%d %H:%M:%S.%q} + - ``%D{%Y-%m-%d %H:%M:%S.%q}`` '%D' is the date and time in local time that the log message is generated, while everything between the curly braces, '{}' are date and time components. From the example log above this produces: ``2019-08-05 14:27:45.871`` -- %-5p + - ``%-5p`` The severity of message, output as a minimum of five characters, using right-padding with spaces. In our example log: ``DEBUG`` -- %c + - ``%c`` The log source. This includes two elements: the Kea process generating the message, in this case, ``kea-dhcp4``; and the component within the program from which the message originated, ``dhcpsrv`` (e.g. the name of the library used by DHCP server implementations). -- %i + - ``%i`` The process ID. From the example log: ``8475`` -- %t + - ``%t`` The thread ID. From the example log: ``12345``. Note the format of the thread ID is OS dependent: e.g. on some systems it is an address so is displayed in hexadecimal. -- %m + - ``%m`` The log message itself. Keg log messages all begin with a message identifier followed by arbitrary log text. Every message in Kea has a unique identifier, which can be used as an index to the @@ -787,6 +787,7 @@ The following environment variables can be used to control the behavior of logging during startup: KEA_LOCKFILE_DIR + Specifies a directory where the logging system should create its lock file. If not specified, it is prefix/var/run/kea, where "prefix" defaults to /usr/local. This variable must not end with a slash. @@ -795,19 +796,20 @@ KEA_LOCKFILE_DIR the same file. KEA_LOGGER_DESTINATION + Specifies logging output. There are several special values: - stdout - Log to standard output. + ``stdout`` + Log to standard output. - stderr - Log to standard error. + ``stderr`` + Log to standard error. - syslog[:fac] - Log via syslog. The optional fac (which is separated from the word - "syslog" by a colon) specifies the facility to be used for the log - messages. Unless specified, messages will be logged using the - facility "local0". + ``syslog[:fac]`` + Log via syslog. The optional fac (which is separated from the word + "syslog" by a colon) specifies the facility to be used for the log + messages. Unless specified, messages will be logged using the + facility "local0". Any other value is treated as a name of the output file. If not specified otherwise, Kea will log to standard output.