From 736bc1c7db2f39dba83e4946b991168b1d679d28 Mon Sep 17 00:00:00 2001 From: Dan Winship Date: Mon, 23 Dec 2013 13:37:10 -0500 Subject: [PATCH] man: NetworkManager.conf.5 fixes and updates The [main] section is not mandatory. Clarify in several places that the keyfile plugin is always used for fallback, and that the [keyfile] section is normally only used if you aren't using any other plugin. Fix some erroneous references to "keyfile" and "ifdown" in the ifupdown section. Update the ifcfg-rh docs to list all currently-supported connection types. Swap the order of ifcfg-suse and ifupdown to make them alphabetical. (Note that ifnet is currently missing.) https://bugzilla.gnome.org/show_bug.cgi?id=720841 --- man/NetworkManager.conf.xml | 138 +++++++++++++++++++++++------------- 1 file changed, 88 insertions(+), 50 deletions(-) diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index b02c8474f..afff8ab89 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -81,20 +81,35 @@ Copyright (C) 2010 - 2013 Red Hat, Inc. - <literal>main</literal> section (mandatory) + <literal>main</literal> section plugins - List system settings plugin names separated - by ','. These plugins are used to read/write system-wide - connection. When more 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. If none of the plugins can save the - connection, the error is returned to the user. See below - for available 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 default to using + keyfile. + + monitor-connection-files @@ -197,7 +212,9 @@ Copyright (C) 2010 - 2013 Red Hat, Inc. <literal>keyfile</literal> section - This section contains keyfile-specific options and thus only has effect when using the keyfile plugin. + This section contains keyfile-plugin-specific options, and + is normally only used when you are not using any other + distro-specific plugin. @@ -234,8 +251,8 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth <literal>ifupdown</literal> section - This section contains keyfile-specific options and thus only - has effect when using the ifdown plugin. + This section contains ifupdown-specific options and thus only + has effect when using the ifupdown plugin. @@ -390,49 +407,70 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth 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. For - security, it will ignore files that are readable or - writeable by any user or group other than root since - private keys and passphrases may be stored in plaintext - inside the file. + + + 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 wired, WiFi, and - 802.1x connections, but does not yet support reading or - writing mobile broadband, PPPoE, or VPN connections. To - allow reading and writing of these add keyfile - plugin to your configuration as well. - - - - ifupdown - This plugin is used on the Debian and Ubuntu - distributions, and reads connections from - /etc/network/interfaces. Since it cannot - write connections out (that support isn't planned), it is - usually paired with the keyfile plugin to - enable saving and editing of new connections. The - ifupdown plugin supports basic wired and - WiFi connections, including WPA-PSK. + + + 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 - wired and WiFi connections, but does not support saving - any connection types. + + + 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. + +