From 2c032d8f1c6292c1338a615e6ec40252889ba85c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 22 Jan 2015 00:29:39 +0100 Subject: Imported Upstream version 1.0.0 --- man/NetworkManager.conf.xml.in | 560 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 560 insertions(+) create mode 100644 man/NetworkManager.conf.xml.in (limited to 'man/NetworkManager.conf.xml.in') diff --git a/man/NetworkManager.conf.xml.in b/man/NetworkManager.conf.xml.in new file mode 100644 index 00000000..d9d51b84 --- /dev/null +++ b/man/NetworkManager.conf.xml.in @@ -0,0 +1,560 @@ + + + + + + + + NetworkManager.conf + NetworkManager developers + + + + NetworkManager.conf + 5 + NetworkManager + Configuration + 1.0 + + + + NetworkManager.conf + NetworkManager configuration file + + + + /etc/NetworkManager/NetworkManager.conf, + /etc/NetworkManager/conf.d/name.conf + + + + + Description + This is a configuration file for NetworkManager. It is used + to set up various aspects of NetworkManager's behavior. The + location of the file may be changed through use of the + argument for NetworkManager. + + If a default NetworkManager.conf is + provided by your distribution's packages, you should not modify + it, since your changes may get overwritten by package + updates. Instead, you can add additional .conf + files to the conf.d directory. These will be read in order, + with later files overriding earlier ones. + + + + + + File Format + + The configuration file format is so-called key file (sort of + ini-style format). It consists of sections (groups) of + key-value pairs. Lines beginning with a '#' and blank lines are + considered comments. Sections are started by a header line + containing the section enclosed in '[' and ']', and ended + implicitly by the start of the next section or the end of the + file. Each key-value pair must be contained in a section. + + + For keys that take a list of devices as their value, you can + specify devices by their MAC addresses or interface names, or + "*" to specify all devices. + + + Minimal system settings configuration file looks like this: + + [main] + plugins=keyfile + + + + As an extension to the normal keyfile format, you can also + append a value to a previously-set list-valued key by doing: + + plugins+=another-plugin + + + + + + <literal>main</literal> section + + + plugins + + + Lists system settings plugin names separated by ','. These + plugins are used to read and write system-wide + connections. When multiple plugins are specified, the + connections are read from all listed plugins. When writing + connections, the plugins will be asked to save the + connection in the order listed here; if the first plugin + cannot write out that connection type (or can't write out + any connections) the next plugin is tried, etc. If none of + the plugins can save the connection, an error is returned + to the user. + + + If NetworkManager defines a distro-specific + network-configuration plugin for your system, then that + will normally be listed here. (See below for the available + plugins.) Note that the keyfile plugin + is always appended to the end of this list (if it doesn't + already appear earlier in the list), so if there is no + distro-specific plugin for your system then you can leave + this key unset and NetworkManager will fall back to using + keyfile. + + + + + monitor-connection-files + Whether the configured settings plugin(s) + should set up file monitors and immediately pick up changes + made to connection files while NetworkManager is running. This + is disabled by default; NetworkManager will only read + the connection files at startup, and when explicitly requested + via the ReloadConnections D-Bus call. If this key is set to + 'true', then NetworkManager will reload + connection files any time they changed. + + + auth-polkit + Whether the system uses PolicyKit for authorization. + If false, all requests will be allowed. If + true, non-root requests are authorized using PolicyKit. + The default value is @NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT@. + + + + dhcp + This key sets up what DHCP client + NetworkManager will use. Allowed values are + dhclient, dhcpcd, and + internal. The dhclient + and dhcpcd options require the indicated + clients to be installed. The internal + option uses a built-in DHCP client which is not currently as + featureful as the external clients (and in particular, does + not yet support DHCPv6). + If this key is missing, available DHCP clients are + looked for in this order: dhclient, + dhcpcd, + internal. + + + no-auto-default + Comma-separated list of devices for which + NetworkManager shouldn't create default wired connection + (Auto eth0). By default, NetworkManager creates a temporary + wired connection for any Ethernet device that is managed and + doesn't have a connection configured. List a device in this + option to inhibit creating the default connection for the + device. May have the special value * to + apply to all devices. + When the default wired connection is deleted or saved + to a new persistent connection by a plugin, the device is + added to a list in the file + /var/run/NetworkManager/no-auto-default.state + to prevent creating the default connection for that device + again. + + + no-auto-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee + no-auto-default=eth0,eth1 + no-auto-default=* + + + + + + + ignore-carrier + + + Comma-separated list of devices for which NetworkManager + will (partially) ignore the carrier state. Normally, for + device types that support carrier-detect, such as Ethernet + and InfiniBand, NetworkManager will only allow a + connection to be activated on the device if carrier is + present (ie, a cable is plugged in), and it will + deactivate the device if carrier drops for more than a few + seconds. + + + Listing a device here will allow activating connections on + that device even when it does not have carrier, provided + that the connection uses only statically-configured IP + addresses. Additionally, it will allow any active + connection (whether static or dynamic) to remain active on + the device when carrier is lost. + + + May have the special value * to apply + to all devices. + + + Note that the "carrier" property of NMDevices and device D-Bus + interfaces will still reflect the actual device state; it's just + that NetworkManager will not make use of that information. + + + + + + configure-and-quit + + + When set to true, NetworkManager quits after + performing initial network configuration but spawns small helpers + to preserve DHCP leases and IPv6 addresses. This is useful in + environments where network setup is more or less static or it is + desirable to save process time but still handle some dynamic + configurations. When this option is true, + network configuration for WiFi, WWAN, Bluetooth, ADSL, and PPPoE + interfaces cannot be preserved due to their use of external + services, and these devices will be deconfigured when NetworkManager + quits even though other interface's configuration may be preserved. + The default value is false, meaning that + NetworkManager will continue running after initial network + configuration and continue responding to system and hardware events, + D-Bus requests, and user commands. + + + + + + dns + Set the DNS (resolv.conf) processing mode. + default: The default if the key is + not specified. NetworkManager will update + resolv.conf to reflect the nameservers + provided by currently active connections. + dnsmasq: NetworkManager will run + dnsmasq as a local caching nameserver, using a "split DNS" + configuration if you are connected to a VPN, and then update + resolv.conf to point to the local + nameserver. + unbound: NetworkManager will talk + to unbound and dnssec-triggerd, providing a "split DNS" + configuration with DNSSEC support. The /etc/resolv.conf + will be managed by dnssec-trigger daemon. + none: NetworkManager will not + modify resolv.conf. + + + + + debug + Comma separated list of options to aid + debugging. This value will be combined with the environment + variable NM_DEBUG. Currently the following + values are supported: + + RLIMIT_CORE: set ulimit -c unlimited + to write out core dumps. + + + + + + + + + <literal>keyfile</literal> section + This section contains keyfile-plugin-specific options, and + is normally only used when you are not using any other + distro-specific plugin. + + + + + hostname + Set a persistent hostname. + + + unmanaged-devices + Set devices that should be ignored by + NetworkManager when using the keyfile + plugin. Devices are specified in the following + format: + mac:<hwaddr> or + interface-name:<ifname>. Here + hwaddr is the MAC address of the device + to be ignored, in hex-digits-and-colons notation. + ifname is the interface name of the + ignored device. + Multiple entries are separated with semicolons. No + spaces are allowed in the value. + + Example: + +unmanaged-devices=interface-name:em4 +unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2 + + + + + + + + + + <literal>ifupdown</literal> section + This section contains ifupdown-specific options and thus only + has effect when using the ifupdown plugin. + + + + + managed + If set to true, then + interfaces listed in + /etc/network/interfaces are managed by + NetworkManager. If set to false, then + any interface listed in + /etc/network/interfaces will be ignored + by NetworkManager. Remember that NetworkManager controls the + default route, so because the interface is ignored, + NetworkManager may assign the default route to some other + interface. + + The default value is false. + + + + + + + + + <literal>logging</literal> section + This section controls NetworkManager's logging. Any + settings here are overridden by the + and command-line options. + + + + + level + The default logging verbosity level. + One of ERR, + WARN, INFO, + DEBUG, TRACE. The ERR + level logs only critical errors. WARN logs warnings that may + reflect operation. INFO logs various informational messages that + are useful for tracking state and operations. DEBUG enables + verbose logging for debugging purposes. TRACE enables even more + verbose logging then DEBUG level. Subsequent levels also log + all messages from earlier levels; thus setting the log level + to INFO also logs error and warning messages. + + + domains + The following log domains are available: + PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, + WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, + AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, + INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, + TEAM, CONCHECK, DCB, DISPATCH. + In addition, these special domains can be used: NONE, + ALL, DEFAULT, DHCP, IP. + You can specify per-domain log level overrides by + adding a colon and a log level to any domain. E.g., + "WIFI:DEBUG". + + + Domain descriptions: + + PLATFORM : OS (platform) operations + RFKILL : RFKill subsystem operations + ETHER : Ethernet device operations + WIFI : Wi-Fi device operations + BT : Bluetooth operations + MB : Mobile broadband operations + DHCP4 : DHCP for IPv4 + DHCP6 : DHCP for IPv6 + PPP : Point-to-point protocol operations + WIFI_SCAN : Wi-Fi scanning operations + IP4 : IPv4-related operations + IP6 : IPv6-related operations + AUTOIP4 : AutoIP (avahi) operations + DNS : Domain Name System related operations + VPN : Virtual Private Network connections and operations + SHARING : Connection sharing + SUPPLICANT : WPA supplicant related operations + AGENTS : Secret agents operations and communication + SETTINGS : Settings/config service operations + SUSPEND : Suspend/resume + CORE : Core daemon and policy operations + DEVICE : Activation and general interface operations + OLPC : OLPC Mesh device operations + WIMAX : WiMAX device operations + INFINIBAND : InfiniBand device operations + FIREWALL : FirewallD related operations + ADSL : ADSL device operations + BOND : Bonding operations + VLAN : VLAN operations + BRIDGE : Bridging operations + DBUS_PROPS : D-Bus property changes + TEAM : Teaming operations + CONCHECK : Connectivity check + DCB : Data Center Bridging (DCB) operations + DISPATCH : Dispatcher scripts + + NONE : when given by itself logging is disabled + ALL : all log domains + DEFAULT : default log domains + DHCP : shortcut for "DHCP4,DHCP6" + IP : shortcut for "IP4,IP6" + + HW : deprecated alias for "PLATFORM" + + + + + + + + + <literal>connectivity</literal> section + This section controls NetworkManager's optional connectivity + checking functionality. This allows NetworkManager to detect + whether or not the system can actually access the internet or + whether it is behind a captive portal. + + + + + uri + The URI of a web page to periodically + request when connectivity is being checked. This page + should return the header "X-NetworkManager-Status" with a + value of "online". Alternatively, it's body content should + be set to "NetworkManager is online". The body content + check can be controlled by the response + option. If this option is blank or missing, connectivity + checking is disabled. + + + + interval + Specified in seconds; controls how often + connectivity is checked when a network connection exists. If + set to 0 connectivity checking is disabled. If missing, the + default is 300 seconds. + + + response + If set controls what body content + NetworkManager checks for when requesting the URI for + connectivity checking. If missing, defaults to + "NetworkManager is online" + + + + + + + Plugins + + + + keyfile + + + The keyfile plugin is the generic + plugin that supports all the connection types and + capabilities that NetworkManager has. It writes files out + in an .ini-style format in + /etc/NetworkManager/system-connections. + + + The stored connection file may contain passwords and + private keys, so it will be made readable only to root, + and the plugin will ignore files that are readable or + writeable by any user or group other than root. + + + This plugin is always active, and will automatically be + used to store any connections that aren't supported by any + other active plugin. + + + + + ifcfg-rh + + + This plugin is used on the Fedora and Red Hat Enterprise + Linux distributions to read and write configuration from + the standard + /etc/sysconfig/network-scripts/ifcfg-* + files. It currently supports reading Ethernet, Wi-Fi, + InfiniBand, VLAN, Bond, Bridge, and Team connections. + + + + + + ifcfg-suse + + + This plugin is only provided for simple backward + compatibility with SUSE and OpenSUSE configuration. Most + setups should be using the keyfile + plugin instead. The ifcfg-suse plugin + supports reading Ethernet and Wi-Fi connections, but does + not support saving any connection types. + + + + + + ifupdown + + + This plugin is used on the Debian and Ubuntu + distributions, and reads Ethernet and Wi-Fi connections + from /etc/network/interfaces. + + + This plugin is read-only; any connections (of any type) + added from within NetworkManager when you are using this + plugin will be saved using the keyfile + plugin instead. + + + + + + ibft + + + This plugin allows to read iBFT configuration (iSCSI Boot Firmware Table). + The configuration is read using /sbin/iscsiadm. Users are expected to + configure iBFT connections via the firmware interfaces. + + + + + + + + + See Also + + NetworkManager8, + nmcli1, + nmcli-examples5, + nm-online1, + nm-settings5, + nm-applet1, + nm-connection-editor1 + + + -- cgit 1.3.0-6-gf8a5