man: Added documentation for the connectivity-change dispatcher hook

Also added documentation for the new CONNECTIVITY_STATE environment
variable, that will also be avaiblable in those hooks.

https://bugzilla.gnome.org/show_bug.cgi?id=768969
This commit is contained in:
Mario Sanchez Prada 2016-07-20 16:48:08 +01:00 committed by Beniamino Galvani
parent dfd9d85beb
commit 3359368f28

View file

@ -79,7 +79,8 @@
device an operation just happened on, and second the action. For device actions,
the interface is the name of the kernel interface suitable for IP configuration.
Thus it is either VPN_IP_IFACE, DEVICE_IP_IFACE, or DEVICE_IFACE, as applicable.
For the <varname>hostname</varname> action it is always "none".
For the <varname>hostname</varname> and <varname>connectivity-change</varname>
actions it is always "none".
</para>
<para>The actions are:</para>
<variablelist class="dispatcher-options">
@ -168,6 +169,12 @@
The DHCPv6 lease has changed (renewed, rebound, etc).
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>connectivity-change</varname></term>
<listitem><para>
The network connectivity state has changed (no connectivity, went online, etc).
</para></listitem>
</varlistentry>
</variablelist>
<para>
The environment contains more information about the interface and the connection.
@ -281,6 +288,15 @@
and DHCP6_ instead.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>CONNECTIVITY_STATE</varname></term>
<listitem><para> The network connectivity state, which can
take the values defined by the NMConnectivityState type,
from the org.freedesktop.NetworkManager D-Bus API: unknown,
none, portal, limited or full. Note: this variable will only
be set for connectivity-change actions.
</para></listitem>
</varlistentry>
</variablelist>
</para>
<para>