>From d6c878114d0088ff1a313b52f08e40c011bc1e2f Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Tue, 9 Apr 2013 16:41:00 -0400 Subject: [PATCH] man: Rewrite NetworkManager.8 and NetworkManager.conf.5 in DocBook DocBook is not my favorite thing in the world, but it's far saner than troff. Some style parts cribbed from systemd. This is preparatory work for actually improving the content of the man pages. --- configure.ac | 2 - man/Makefile.am | 16 ++ man/NetworkManager.8.in | 145 ----------------- man/NetworkManager.conf.5.in | 310 ------------------------------------ man/NetworkManager.conf.xml | 362 ++++++++++++++++++++++++++++++++++++++++++ man/NetworkManager.xml | 223 ++++++++++++++++++++++++++ 6 files changed, 601 insertions(+), 457 deletions(-) delete mode 100644 man/NetworkManager.8.in delete mode 100644 man/NetworkManager.conf.5.in create mode 100644 man/NetworkManager.conf.xml create mode 100644 man/NetworkManager.xml diff --git a/configure.ac b/configure.ac index 034bd68..fb2e118 100644 --- a/configure.ac +++ b/configure.ac @@ -706,8 +706,6 @@ initscript/linexa/networkmanager introspection/Makefile introspection/all.xml man/Makefile -man/NetworkManager.8 -man/NetworkManager.conf.5 man/nm-system-settings.conf.5 man/nm-online.1 man/nmcli.1 diff --git a/man/Makefile.am b/man/Makefile.am index 7db5623..fdf2041 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -14,6 +14,22 @@ nm-settings.xml: $(top_builddir)/tools/generate-settings-spec $(top_builddir)/li $(top_builddir)/tools/generate-settings-spec refentry $(builddir)/$@ CLEANFILES += nm-settings.xml +XSLTPROC_FLAGS = \ + --nonet \ + --stringparam man.output.quietly 1 \ + --stringparam funcsynopsis.style ansi \ + --stringparam man.th.extra1.suppress 1 \ + --stringparam man.authors.section.enabled 0 \ + --stringparam man.copyright.section.enabled 0 + +XSLTPROC_MAN_FLAGS = $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl + +%.8: %.xml + $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< + +%.5: %.xml + $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< + man_MANS += \ NetworkManager.8 \ NetworkManager.conf.5 \ diff --git a/man/NetworkManager.8.in b/man/NetworkManager.8.in deleted file mode 100644 index 38a195f..0000000 --- a/man/NetworkManager.8.in +++ /dev/null @@ -1,145 +0,0 @@ -.\" NetworkManager(8) manual page -.\" -.\" Copyright (C) 2005 - 2013 Red Hat, Inc. -.\" Copyright (C) 2005 - 2009 Novell, Inc. -.\" Copyright (C) 2005 Robert Love -.\" -.TH NETWORKMANAGER "8" "17 January 2012" -.SH NAME -NetworkManager \- network management daemon -.SH SYNOPSIS -.B NetworkManager [\-\-version] | [\-\-help] -.PP -.B NetworkManager [\-\-no\-daemon] [\-\-pid\-file=] [\-\-state\-file=] [\-\-config=] [\-\-config-dir=] [\-\-plugins=,plugin2>,...] [\-\-log\-level=] [\-\-log\-domains=,,...] -.SH DESCRIPTION -The \fINetworkManager\fP daemon attempts to make networking configuration and -operation as painless and automatic as possible by managing the primary network -connection and other network interfaces, like Ethernet, WiFi, and Mobile -Broadband devices. NetworkManager will connect any network device when a -connection for that device becomes available, unless that behavior is disabled. -Information about networking is exported via a D-Bus interface to any interested -application, providing a rich API with which to inspect and control network -settings and operation. -.P -NetworkManager will execute scripts in the /etc/NetworkManager/dispatcher.d -directory in alphabetical order in response to network events. Each script -should be: -.IP "(a)" 4 -a regular file -.IP "(b)" 4 -owned by root -.IP "(c)" 4 -not writable by group or other -.IP "(d)" 4 -not set-uid -.IP "(e)" 4 -and executable by the owner -.PP -Each script receives two arguments, the first being the interface name of the -device just activated, and second an action. -.PP -Actions: -.TP -.I "up" -The interface has been activated. The environment contains more information -about the interface; CONNECTION_UUID contains the UUID of the connection. Other -variables are IP4_ADDRESS_N where N is a number from 0 to (# IPv4 addresses \- 1), -in the format "address/prefix gateway". IP4_NUM_ADDRESSES contains the number -addresses the script may expect. IP4_NAMESERVERS contains a space-separated -list of the DNS servers, and IP4_DOMAINS contains a space-separated list of the -search domains. Routes use the format IP4_ROUTE_N where N is a number from 0 -to (# IPv4 routes \- 1), in the format "address/prefix next-hop metric", and -IP4_NUM_ROUTES contains the number of routes to expect. If the connection used -DHCP for address configuration, the received DHCP configuration is passed in the -environment using standard DHCP option names, prefixed with "DHCP4_", like -"DHCP4_HOST_NAME=foobar". -.TP -.I "down" -The interface has been deactivated. -.TP -.I "vpn\-up" -A VPN connection has been activated. The environment contains the connection -UUID in the variable CONNECTION_UUID. -.TP -.I "vpn\-down" -A VPN connection has been deactivated. -.TP -.I "hostname" -The system hostname has been updated. Use gethostname(2) to retrieve it. -.TP -.I "dhcp4\-change" -The DHCPv4 lease has changed (renewed, rebound, etc). -.TP -.I "dhcp6\-change" -The DHCPv6 lease has changed (renewed, rebound, etc). -.SH OPTIONS -The following options are supported: -.TP -.I "\-\-version" -Print the NetworkManager software version and exit. -.TP -.I "\-\-help" -Print NetworkManager's available options and exit. -.TP -.I "\-\-no\-daemon" -Do not daemonize. This is useful for debugging, and directs log output to the -controlling terminal in addition to syslog. -.TP -.I "\-\-pid\-file=" -Specify location of a PID file. The PID file is used for storing PID of the -running proccess and prevents running multiple instances. -.TP -.I "\-\-state\-file=" -Specify file for storing state of the NetworkManager persistently. If not specified, -the default value of '/lib/NetworkManager/NetworkManager.state' is -used; where is dependent on your distribution (usually it's /var). -.TP -.I "\-\-config=" -Specify configuration file to set up various settings for NetworkManager. If not -specified, the default value of '/NetworkManager/NetworkManager.conf' -is used with a fallback to the older 'nm\-system\-settings.conf' if located in -the same directory; where is dependent on your distribution (usually -it's /etc). See \fBNetworkManager.conf\fP(5) for more information on configuration -file. -.TP -.I "\-\-config-dir=" -Specify configuration directory for files that override NetworkManager.conf. If not -specified, the default value of '/NetworkManager/conf.d' -is used. See \fBNetworkManager.conf\fP(5) for more information on configuration -file. -.TP -.I "\-\-plugins=,, ... -List plugins used to manage system-wide connection settings. This list has -preference over plugins specified in the configuration file. Currently supported -plugins are: keyfile, ifcfg\-rh, ifcfg\-suse, ifupdown. -See \fBNetworkManager.conf\fP(5) for more information on the plugins. -.TP -.I "\-\-log\-level= -Sets how much information NetworkManager sends to the log destination (usually -syslog's "daemon" facility). By default, only informational, warning, and error -messages are logged. See \fBNetworkManager.conf\fP(5) for more information on -log levels and domains. -.TP -.I "\-\-log\-domains=,, ... -Sets which operations are logged to the log destination (usually syslog). By -default, most domains are logging-enabled. See \fBNetworkManager.conf\fP(5) for -more information on log levels and domains. - -.SH DEBUGGING -The following environment variables are supported to help debugging. When used -in conjunction with the "\-\-no\-daemon" option (thus echoing PPP and DHCP helper -output to stdout) these can quickly help pinpoint the source of connection -issues. Also see the \-\-log\-level and \-\-log\-domains to enable debug logging inside -NetworkManager itself. -.TP -.I "NM_PPP_DEBUG" -When set to anything, causes NetworkManager to turn on PPP debugging in pppd, -which logs all PPP and PPTP frames and client/server exchanges. -.SH SEE ALSO -.BR nm\-online (1), -.BR nmcli (1), -.BR NetworkManager.conf (5), -.BR nm\-settings (5), -.BR nm\-applet (1), -.BR nm\-connection\-editor (1). - diff --git a/man/NetworkManager.conf.5.in b/man/NetworkManager.conf.5.in deleted file mode 100644 index 368d776..0000000 --- a/man/NetworkManager.conf.5.in +++ /dev/null @@ -1,310 +0,0 @@ -.\" NetworkManager.conf(5) manual page -.\" -.\" Copyright (C) 2010 - 2013 Red Hat, Inc. -.\" -.TH "NetworkManager.conf" "5" "14 March 2013" "" -.SH NAME -NetworkManager.conf \- NetworkManager configuration file -.SH SYNOPSIS -/etc/NetworkManager/NetworkManager.conf -.br -/etc/NetworkManager/conf.d/*.conf -.br -or -.br -\fI\fP/NetworkManager/NetworkManager.conf -.br -\fI\fP/NetworkManager/conf.d/*.conf -.br -where depends on your distribution or build. -.SH DESCRIPTION -.P -.I NetworkManager.conf -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 "\-\-config=" argument for -\fBNetworkManager\fP (8). -.P -If a default -.I 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 -.I .conf -files to the -.I conf.d -directory. These will be read in order, with later files overriding -earlier ones. -.SH "FILE FORMAT" -.P -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. -.P -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. -.P -Minimal system settings configuration file looks like this: -.P -.nf -[main] -plugins=keyfile -.fi -.P -As an extension to the normal keyfile format, you can also append a -value to a previously-set list-valued key by doing: -.P -.nf -[main] -plugins+=another-plugin -.fi -.P -Description of sections and available keys follows: -.SS [main] -This section is the only mandatory section of the configuration file. -.TP -.B plugins=\fIplugin1\fP,\fIplugin2\fP, ... -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. -.P -.RS -.B "Available plugins:" -.br -.TP -.I keyfile -plugin is the generic plugin that supports all the connection types and -capabilities that NetworkManager has. It writes files out in a .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 -.I root -since private keys and passphrases may be stored in plaintext inside the file. -.TP -.I ifcfg\-rh -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 \fIkeyfile\fP plugin to your configuration as well. -.TP -.I ifupdown -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 \fIkeyfile\fP plugin to enable saving and editing of new connections. -The \fIifupdown\fP plugin supports basic wired and WiFi connections, including WPA-PSK. -.TP -.I ifcfg\-suse -plugin is only provided for simple backward compatibility with SUSE and OpenSUSE configuration. -Most setups should be using the \fIkeyfile\fP plugin instead. The \fIifcfg\-suse\fP plugin supports -reading wired and WiFi connections, but does not support saving any connection types. -.RE -.TP -.B dhcp=\fIdhclient\fP | \fIdhcpcd\fP -This key sets up what DHCP client NetworkManager will use. Presently -\fIdhclient\fP and \fIdhcpcd\fP are supported. The client configured here should -be available on your system too. If this key is missing, available DHCP clients -are looked for in this order: dhclient, dhcpcd. -.TP -.B no-auto-default=\fI\fP,\fI\fP,... | \fI*\fP -Set devices for which NetworkManager shouldn't create default wired connection -(Auto eth0). NetworkManager creates a default 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. -.br -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 -\fI\fP/run/NetworkManager/no-auto-default.state -to prevent creating the default connection for that device again. -.br -Examples: -.nf -no-auto-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee -no-auto-default=eth0,eth1 -no-auto-default=* -.fi -.TP -.B ignore-carrier=\fI\fP,\fI\fP,... | \fI*\fP -Set devices for which NetworkManager should ignore device carrier state when -deciding whether to activate or deactivate connections. -.TP -.B dns=\fImode\fP -Set the DNS/resolv.conf-processing mode. -.P -.RS -.B "Supported modes:" -.br -.TP -.I default -The default if the key is not specified. NetworkManager will update -resolv.conf to reflect the nameservers provided by currently active -connections. -.TP -.I 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. -.TP -.I none -NetworkManager will not modify resolv.conf. -.RE -.SS [keyfile] -This section contains keyfile-specific options and thus only has effect when using \fIkeyfile\fP plugin. -.TP -.B hostname=\fI\fP -Set a persistent hostname when using the \fIkeyfile\fP plugin. -.TP -.B unmanaged-devices=\fImac:\fP;\fIinterface\-name:\fP;... -Set devices that should be ignored by NetworkManager when using the \fIkeyfile\fP -plugin. Devices are specified in the following format: -.br -"mac:" or "interface\-name:" -.sp -\fI\fP is MAC address of the device to be ignored, in hex-digits-and-colons notation -.br -\fI\fP is the interface name of the ignored device -.br -Multiple entries are separated with semicolons. No spaces are allowed in the value. -.sp -Examples: -.nf -unmanaged-devices=interface-name:em4 -unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2 -.fi -.SS [ifupdown] -This section contains ifupdown-specific options and thus only has effect when using \fIifupdown\fP plugin. -.TP -.B managed=\fIfalse\fP | \fItrue\fP -Controls whether interfaces listed in the 'interfaces' file are managed by NetworkManager. -If set to \fItrue\fP, then interfaces listed in /etc/network/interfaces are managed by NetworkManager. -If set to \fIfalse\fP, 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. -When the option is missing, \fIfalse\fP value is taken as default. -.SS [logging] -This section controls NetworkManager's logging. Any settings here are -overridden by the \-\-log\-level and \-\-log\-domains command-line options. -.TP -.B level=\fI\fP -One of [ERR, WARN, INFO, DEBUG]. 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. Subsequent levels also log all messages -from earlier levels; thus setting the log level to INFO also logs error and -warning messages. -.TP -.B domains=\fI,, ...\fP -The following log domains are available: [HW, 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]. -.br -In addition to them, these special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. -.PP -.RS -NONE = when given by itself, logging is disabled -.br -ALL = all log domains will be switched on -.br -DEFAULT = default log domains -.br -DHCP = a shortcut for "DHCP4, DHCP6" -.br -IP = a shortcut for "IP4, IP6" -.br -.PP -HW = Hardware related operations -.br -RFKILL = RFKill subsystem operations -.br -ETHER = Ethernet device operations -.br -WIFI = Wi-Fi device operations -.br -BT = Bluetooth -.br -MB = Mobile Broadband -.br -DHCP4 = DHCP for IPv4 -.br -DHCP6 = DHCP for IPv6 -.br -PPP = Point-to-point protocol operations -.br -WIFI_SCAN = Wi-Fi scanning operations -.br -IP4 = Domain for IPv4 logging -.br -IP6 = Domain for IPv6 logging -.br -AUTOIP4 = AutoIP (avahi) operations -.br -DNS = Domain Name System related operations -.br -VPN = Virtual Private Network connections and operaions -.br -SHARING = Connection sharing -.br -SUPPLICANT = WPA supplicant related operations -.br -AGENTS = Secret agents operations and communication -.br -SETTINGS = Settings/config service operations -.br -SUSPEND = Suspend/resume -.br -CORE = Core daemon operations -.br -DEVICE = Activation and general interface operations -.br -OLPC = OLPC Mesh device operations -.br -WIMAX = Wimax device operations -.br -INFINIBAND = InfiniBand device operations -.br -FIREWALL = FirewallD related operations -.br -ADSL = ADSL device operations -.br -BOND = Bonding device operations -.br -VLAN = VLAN device operations -.br -BRIDGE = Bridging device operations -.br -.SS [connectivity] -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. -.TP -.B uri=\fI\fP -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 \fIresponse\fP -option. If this option is blank or missing, connectivity checking is disabled. -.TP -.B interval=\fI\fP -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. -.TP -.B response=\fI\fP -If set controls what body content NetworkManager checks for when requesting the -URI for connectivity checking. If missing, defaults to "NetworkManager is online" -.SH "SEE ALSO" -.BR http://live.gnome.org/NetworkManager/SystemSettings -.sp -.BR NetworkManager (8), -.BR nmcli (1), -.BR nm\-online (1), -.BR nm\-settings (5). diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml new file mode 100644 index 0000000..23f7244 --- /dev/null +++ b/man/NetworkManager.conf.xml @@ -0,0 +1,362 @@ + + + + + + + + NetworkManager.conf + + + + NetworkManager.conf + 5 + + + + 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 (mandatory) + + + 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. + + + dhcp + This key sets up what DHCP client + NetworkManager will use. Presently + dhclient and dhcpcd + are supported. The client configured here should be + available on your system too. If this key is missing, + available DHCP clients are looked for in this order: + dhclient, dhcpcd. + + + 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 + Set devices for which NetworkManager should + ignore device carrier state when deciding whether to + activate or deactivate connections. May have the special + value * to apply to all + devices. + + + + 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. + dnsmasqNetworkManager 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. + none: NetworkManager will not + modify resolv.conf. + + + + + + + <literal>keyfile</literal> section + This section contains keyfile-specific options and thus only has effect when using the keyfile 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 keyfile-specific options and thus only + has effect when using the ifdown 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 + One of ERR, + WARN, INFO, + DEBUG. 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. 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: + HW, 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. + In addition, these special domains can be used: NONE, + ALL, DEFAULT, DHCP, IP. + + + + + + + <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 + 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. + + + 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. + + + + 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. + + + + + + See Also + + nm-online1, + nmcli1, + NetworkManager.conf5, + nm-settings5, + nm-applet1, + nm-connection-editor1 + + + + diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml new file mode 100644 index 0000000..df1815a --- /dev/null +++ b/man/NetworkManager.xml @@ -0,0 +1,223 @@ + + + + + + + + + NetworkManager + + + NetworkManager + 8 + + + + NetworkManager + network management daemon + + + + + NetworkManager OPTIONS + + + + + Description + + The NetworkManager daemon attempts to make networking + configuration and operation as painless and automatic as + possible by managing the primary network connection and other + network interfaces, like Ethernet, WiFi, and Mobile Broadband + devices. NetworkManager will connect any network device when a + connection for that device becomes available, unless that + behavior is disabled. Information about networking is exported + via a D-Bus interface to any interested application, providing a + rich API with which to inspect and control network settings and + operation. + + + NetworkManager will execute scripts in the + /etc/NetworkManager/dispatcher.d directory in alphabetical order + in response to network events. Each script should be a regular + executable file, owned by root. Furthermore, it must not be + writable by group or other, and not setuid. + + + Each script receives two arguments, the first being the interface name of the + device just activated, and second an action. + + + + up + The interface has been activated. The + environment contains more information about the interface; + CONNECTION_UUID contains the UUID of the connection. Other + variables are IP4_ADDRESS_N where N is a number from 0 to (# + IPv4 addresses \- 1), in the format "address/prefix gateway". + IP4_NUM_ADDRESSES contains the number addresses the script may + expect. IP4_NAMESERVERS contains a space-separated list of + the DNS servers, and IP4_DOMAINS contains a space-separated + list of the search domains. Routes use the format IP4_ROUTE_N + where N is a number from 0 to (# IPv4 routes \- 1), in the + format "address/prefix next-hop metric", and IP4_NUM_ROUTES + contains the number of routes to expect. If the connection + used DHCP for address configuration, the received DHCP + configuration is passed in the environment using standard DHCP + option names, prefixed with "DHCP4_", like + "DHCP4_HOST_NAME=foobar". + + + down + + The interface has been deactivated. + + + + vpn-up + + A VPN connection has been activated. The environment contains the connection + UUID in the variable CONNECTION_UUID. + + + + vpn-down + + A VPN connection has been deactivated. + + + + hostname + + The system hostname has been updated. Use gethostname(2) to retrieve it. + + + + dhcp4-change + + The DHCPv4 lease has changed (renewed, rebound, etc). + + + + dhcp6-change + + The DHCPv6 lease has changed (renewed, rebound, etc). + + + + + + + + Options + + The following options are understood: + + + + + Print the NetworkManager software version and exit. + + + + + Print NetworkManager's available options and exit. + + + + + Do not daemonize. This is useful for + debugging, and directs log output to the controlling terminal + in addition to syslog. + + + + + Specify location of a PID file. The PID file + is used for storing PID of the running proccess and prevents + running multiple instances. + + + + + Specify file for storing state of the + NetworkManager persistently. If not specified, the default + value of /var/lib/NetworkManager/NetworkManager.state is used. + + + + + Specify configuration file to set up various + settings for NetworkManager. If not specified, the default + value of /etc/NetworkManager/NetworkManager.conf is used with + a fallback to the older 'nm\-system\-settings.conf' if located + in the same directory. See + NetworkManager.conf5 + for more information on configuration file. + + + + + List plugins used to manage system-wide + connection settings. This list has preference over plugins + specified in the configuration file. Currently supported + plugins are: keyfile, , + , . + + + + + + Sets how much information NetworkManager sends to the log destination (usually + syslog's "daemon" facility). By default, only informational, warning, and error + messages are logged. + + + + + A comma-separated list specifying which + operations are logged to the log destination (usually syslog). + By default, most domains are logging-enabled. + + + + + + + DEBUGGING + + The following environment variables are supported to help + debugging. When used in conjunction with the + option (thus echoing PPP and DHCP + helper output to stdout) these can quickly help pinpoint the + source of connection issues. Also see the + and + to enable debug logging inside NetworkManager itself. + + + : When set to anything, causes + NetworkManager to turn on PPP debugging in pppd, which logs + all PPP and PPTP frames and client/server exchanges. + + + + + See Also + + nm-online1, + nmcli1, + NetworkManager.conf5, + nm-settings5, + nm-applet1, + nm-connection-editor1 + + + -- 1.7.1