Files
NetworkManager/man/NetworkManager.xml
Jiří Klimeš 6993b5b2a1 man: add 'nmcli-examples' manual page with examples of nmcli usage
(and add a reference to 'nmcli-examples' to other man pages)
2013-07-22 13:43:54 +02:00

232 lines
8.9 KiB
XML

<?xml version='1.0'?> <!--*-nxml-*-->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright (C) 2005 - 2013 Red Hat, Inc.
Copyright (C) 2005 - 2009 Novell, Inc.
Copyright (C) 2005 Robert Love
-->
<refentry id="NetworkManager">
<refentryinfo>
<title>NetworkManager</title>
<author>NetworkManager developers</author>
</refentryinfo>
<refmeta>
<refentrytitle>NetworkManager</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Network management daemons</refmiscinfo>
<refmiscinfo class="version">0.9.10</refmiscinfo>
</refmeta>
<refnamediv>
<refname>NetworkManager</refname>
<refpurpose>network management daemon</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>NetworkManager <arg choice="opt" rep="repeat">OPTIONS</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
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.
</para>
<para>
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.
</para>
<para>
Each script receives two arguments, the first being the interface name of the
device just activated, and second an action.
</para>
<variablelist class="dispatcher-options">
<varlistentry>
<term><varname>up</varname></term>
<listitem><para>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".</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>down</varname></term>
<listitem><para>
The interface has been deactivated.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>vpn-up</varname></term>
<listitem><para>
A VPN connection has been activated. The environment contains the connection
UUID in the variable CONNECTION_UUID.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>vpn-down</varname></term>
<listitem><para>
A VPN connection has been deactivated.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>hostname</varname></term>
<listitem><para>
The system hostname has been updated. Use gethostname(2) to retrieve it.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>dhcp4-change</varname></term>
<listitem><para>
The DHCPv4 lease has changed (renewed, rebound, etc).
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>dhcp6-change</varname></term>
<listitem><para>
The DHCPv6 lease has changed (renewed, rebound, etc).
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--version</option> | <option>-V</option></term>
<listitem><para>Print the NetworkManager software version and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--help</option> | <option>-h</option></term>
<listitem><para>Print NetworkManager's available options and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-daemon</option> | <option>-n</option></term>
<listitem><para>Do not daemonize.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--debug</option> | <option>-d</option></term>
<listitem><para>Do not daemonize, and direct log output to the
controlling terminal in addition to syslog.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--pid-file</option> | <option>-p</option></term>
<listitem><para>Specify location of a PID file. The PID file
is used for storing PID of the running proccess and prevents
running multiple instances.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--state-file</option></term>
<listitem><para>Specify file for storing state of the
NetworkManager persistently. If not specified, the default
value of /var/lib/NetworkManager/NetworkManager.state is used.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--config</option></term>
<listitem><para> 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
<citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more information on configuration file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--plugins</option></term>
<listitem><para>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, <option>ifcfg-rh</option>,
<option>ifcfg-suse</option>, <option>ifupdown</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--log-level</option></term>
<listitem><para>
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.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--log-domains</option></term>
<listitem><para>A comma-separated list specifying which
operations are logged to the log destination (usually syslog).
By default, most domains are logging-enabled.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>DEBUGGING</title>
<para>
The following environment variables are supported to help
debugging. When used in conjunction with the
<option>--no-daemon</option> option (thus echoing PPP and DHCP
helper output to stdout) these can quickly help pinpoint the
source of connection issues. Also see the
<option>--log-level</option> and <option>--log-domains</option>
to enable debug logging inside NetworkManager itself.
</para>
<para>
<option>NM_PPP_DEBUG</option>: When set to anything, causes
NetworkManager to turn on PPP debugging in pppd, which logs
all PPP and PPTP frames and client/server exchanges.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>