From 6238f9bbd7a53baf9b45d182cb1394484e992db1 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Sun, 20 Oct 2019 10:25:51 +0200 Subject: [PATCH] doc: Start describing settings in main.conf --- src/iwd.conf.rst | 52 ++++++++++++++++++++++++++++++++++++++++++++++-- src/iwd.rst | 2 +- 2 files changed, 51 insertions(+), 3 deletions(-) diff --git a/src/iwd.conf.rst b/src/iwd.conf.rst index e70eedf1..4897615d 100644 --- a/src/iwd.conf.rst +++ b/src/iwd.conf.rst @@ -16,12 +16,60 @@ Configuration file for wireless daemon SYNOPSIS ======== -/etc/iwd/main.conf +**main.conf** DESCRIPTION =========== -The /etc/iwd/main.conf file configures the system-wide settings for iwd(8). +The *main.conf* configuration file configures the system-wide settings for +**iwd**. This file lives in the configuration directory specified by the +environment variable *$CONFIGURATION_DIRECTORY*, which is normally provided +by **systemd**. In the absence of such an environment variable it defaults +to */etc/iwd*. If no *main.conf* is present, then default values are +chosen. The presence of *main.conf* is not required. + +SETTINGS +======== + +The settings are split into several categories. Each category has a group +associated with it and described in separate tables below. + +General Settings +---------------- + +The group ``[General]`` contains general settings. + +.. list-table:: + :header-rows: 0 + :stub-columns: 0 + :widths: 20 80 + :align: left + + * - enable_network_config + - Values: true, false (default) + + Enable network configuration. + + Setting this option to *true* enables **iwd** to configure the network + interfaces with the IP addresses. There are two types IP addressing + supported by **iwd**: static and dynamic. The static IP addresses are + configured through the network configuration files. If no static IP + configuration has been provided for a network, iwd will attempt to + obtain the dynamic addresses from the network through the built-in + DHCP client. + + The network configuration feature is disabled by default. + + * - dns_resolve_method + - Values: resolvconf, systemd (default) + + Indicate a DNS resolution method used by the system. + + This configuration option must be used in conjunction with + ``enable_network_config`` and provides the choice of system resolver + integration. + + If not specified, ``systemd`` is used as default. SEE ALSO ======== diff --git a/src/iwd.rst b/src/iwd.rst index ac90d72c..2df29843 100644 --- a/src/iwd.rst +++ b/src/iwd.rst @@ -263,6 +263,6 @@ the file **main.conf** is currently read from this directory. SEE ALSO ======== -iwctl(1), iwmon(1), hwsim(1), ead(8), systemd.exec(5) +iwd.conf(5), iwctl(1), iwmon(1), hwsim(1), ead(8), systemd.exec(5) http://iwd.wiki.kernel.org