NetworkManager.8.in 6.59 KB
Newer Older
1
.\" NetworkManager(8) manual page
2
.\"
3
.\" Copyright (C) 2005 - 2013 Red Hat, Inc.
4
.\" Copyright (C) 2005 - 2009 Novell, Inc.
5 6
.\" Copyright (C) 2005 Robert Love
.\"
7
.TH NETWORKMANAGER "8" "17 January 2012"
8
.SH NAME
9 10
NetworkManager \- network management daemon
.SH SYNOPSIS
Jiří Klimeš's avatar
Jiří Klimeš committed
11 12
.B NetworkManager [\-\-version] | [\-\-help]
.PP
13
.B NetworkManager [\-\-no\-daemon] [\-\-pid\-file=<filename>] [\-\-state\-file=<filename>] [\-\-config=<filename>] [\-\-plugins=<plugin1>,plugin2>,...] [\-\-log\-level=<level>] [\-\-log\-domains=<domain1>,<domain2>,...] [\-\-connectivity\-uri=<uri>] [\-\-connectivity\-interval=<int>] [\-\-connectivity\-response=<resp>]
14
.SH DESCRIPTION
15 16 17 18 19 20 21 22
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.
23
.P
24 25
NetworkManager will execute scripts in the /etc/NetworkManager/dispatcher.d
directory in alphabetical order in response to network events.  Each script
Jiří Klimeš's avatar
Jiří Klimeš committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
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:
42 43 44 45
.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
46
variables are IP4_ADDRESS_N where N is a number from 0 to (# IPv4 addresses \- 1),
47 48 49 50
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
51
to (# IPv4 routes \- 1), in the format "address/prefix next-hop metric", and
52 53 54 55 56 57 58 59
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
60
.I "vpn\-up"
61 62 63
A VPN connection has been activated.  The environment contains the connection
UUID in the variable CONNECTION_UUID.
.TP
64
.I "vpn\-down"
65 66 67 68
A VPN connection has been deactivated.
.TP
.I "hostname"
The system hostname has been updated.  Use gethostname(2) to retrieve it.
69
.TP
70 71
.I "dhcp4\-change"
The DHCPv4 lease has changed (renewed, rebound, etc).
72
.TP
73 74
.I "dhcp6\-change"
The DHCPv6 lease has changed (renewed, rebound, etc).
75 76 77
.SH OPTIONS
The following options are supported:
.TP
78 79 80
.I "\-\-version"
Print the NetworkManager software version and exit.
.TP
Jiří Klimeš's avatar
Jiří Klimeš committed
81 82 83
.I "\-\-help"
Print NetworkManager's available options and exit.
.TP
84
.I "\-\-no\-daemon"
85 86
Do not daemonize.  This is useful for debugging, and directs log output to the
controlling terminal in addition to syslog.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
.TP
.I "\-\-pid\-file=<filename>"
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=<filename>"
Specify file for storing state of the NetworkManager persistently.  If not specified,
the default value of '<LOCALSTATEDIR>/lib/NetworkManager/NetworkManager.state' is
used; where <LOCALSTATEDIR> is dependent on your distribution (usually it's /var).
.TP
.I "\-\-config=<filename>"
Specify configuration file to set up various settings for NetworkManager.  If not
specified, the default value of '<SYSCONFDIR>/NetworkManager/NetworkManager.conf'
is used with a fallback to the older 'nm\-system\-settings.conf' if located in
the same directory; where <SYSCONFDIR> is dependent on your distribution (usually
it's /etc).  See \fBNetworkManager.conf\fP(5) for more information on configuration
file.
.TP
.I "\-\-plugins=<plugin1>,<plugin2>, ...
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.
110
.TP
111
.I "\-\-log\-level=<level>
112 113 114 115 116
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
117
.I "\-\-log\-domains=<domain1>,<domain2>, ...
118 119 120
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.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
.TP
.I "\-\-connectivity\-uri=<uri>
Sets the URI of a web page that will be used for connectivity checking. By
default connectivity checking is disabled.  See \fBNetworkManager.conf\fP(5)
[connectivity] section for more information on connectivity checking feature.
.TP
.I "\-\-connectivity\-interval=<int>
Sets the interval (in seconds) in which connection checks for the URI are done.
0 means no checks. The default value is 300 seconds. See
\fBNetworkManager.conf\fP(5) [connectivity] section for more information on
connectivity checking feature.
.TP
.I "\-\-connectivity\-response=<resp>
If set, it controls what body content NetworkManager checks for when requesting
the URI for connectivity checking.  If missing, defaults to "NetworkManager is online".
See \fBNetworkManager.conf\fP(5) [connectivity] section for more information on
connectivity checking feature.

139 140
.SH DEBUGGING
The following environment variables are supported to help debugging.  When used
141
in conjunction with the "\-\-no\-daemon" option (thus echoing PPP and DHCP helper
142
output to stdout) these can quickly help pinpoint the source of connection
143
issues.  Also see the \-\-log\-level and \-\-log\-domains to enable debug logging inside
144
NetworkManager itself.
145 146 147 148
.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.
149
.SH SEE ALSO
Jiří Klimeš's avatar
Jiří Klimeš committed
150 151
.BR nm\-online (1),
.BR nmcli (1),
152
.BR NetworkManager.conf (5),
153 154 155
.BR nm\-settings (5),
.BR nm\-applet (1),
.BR nm\-connection\-editor (1).
156