diff options
| author | Michael Biebl <biebl@debian.org> | 2016-04-06 00:46:19 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2016-04-06 00:46:19 +0200 |
| commit | 2bfb3eb7d0323e69affca154395f51d8b577414d (patch) | |
| tree | e3130a5146441296df6d08a0f4ac7222a854c8f8 /introspection | |
| parent | d9c99a29a0d3384c9c3d2adce430f5cb1134ab6a (diff) | |
Imported Upstream version 1.1.93 upstream/1.1.93
Diffstat (limited to 'introspection')
71 files changed, 3212 insertions, 3885 deletions
diff --git a/introspection/Makefile.am b/introspection/Makefile.am index 4d2e1298..3a627930 100644 --- a/introspection/Makefile.am +++ b/introspection/Makefile.am @@ -136,10 +136,6 @@ BUILT_SOURCES = $(nodist_libnmdbus_la_SOURCES) $(DBUS_INTERFACE_DOCS) CLEANFILES = $(BUILT_SOURCES) EXTRA_DIST = \ - all.xml.in \ - generic-types.xml \ - errors.xml \ - vpn-errors.xml \ nm-access-point.xml \ nm-active-connection.xml \ nm-agent-manager.xml \ diff --git a/introspection/Makefile.in b/introspection/Makefile.in index ea43b442..c6f4ba26 100644 --- a/introspection/Makefile.in +++ b/introspection/Makefile.in @@ -108,7 +108,7 @@ am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ DIST_COMMON = $(srcdir)/Makefile.am $(am__DIST_COMMON) mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/config.h -CONFIG_CLEAN_FILES = all.xml +CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = LTLIBRARIES = $(noinst_LTLIBRARIES) libnmdbus_la_LIBADD = @@ -194,7 +194,7 @@ am__define_uniq_tagged_files = \ done | $(am__uniquify_input)` ETAGS = etags CTAGS = ctags -am__DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/all.xml.in \ +am__DIST_COMMON = $(srcdir)/Makefile.in \ $(top_srcdir)/build-aux/depcomp DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ @@ -578,10 +578,6 @@ DBUS_INTERFACE_DOCS = \ BUILT_SOURCES = $(nodist_libnmdbus_la_SOURCES) $(DBUS_INTERFACE_DOCS) CLEANFILES = $(BUILT_SOURCES) EXTRA_DIST = \ - all.xml.in \ - generic-types.xml \ - errors.xml \ - vpn-errors.xml \ nm-access-point.xml \ nm-active-connection.xml \ nm-agent-manager.xml \ @@ -651,8 +647,6 @@ $(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) $(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh $(am__aclocal_m4_deps): -all.xml: $(top_builddir)/config.status $(srcdir)/all.xml.in - cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ clean-noinstLTLIBRARIES: -test -z "$(noinst_LTLIBRARIES)" || rm -f $(noinst_LTLIBRARIES) diff --git a/introspection/all.xml.in b/introspection/all.xml.in deleted file mode 100644 index 273c0fda..00000000 --- a/introspection/all.xml.in +++ /dev/null @@ -1,74 +0,0 @@ -<tp:spec - xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" - xmlns:xi="http://www.w3.org/2001/XInclude"> - -<tp:title>NetworkManager D-Bus Interface Specification</tp:title> -<tp:version>@VERSION@</tp:version> - - -<tp:copyright>Copyright (C) 2008 - 2016 Red Hat, Inc.</tp:copyright> -<tp:copyright>Copyright (C) 2008 - 2009 Novell, Inc.</tp:copyright> - -<tp:license xmlns="http://www.w3.org/1999/xhtml"> -<p>This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or -(at your option) any later version.</p> - -<p>This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details.</p> - -<p>You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p> -</tp:license> - -<xi:include href="nm-manager.xml"/> -<xi:include href="nm-access-point.xml"/> -<xi:include href="nm-device.xml"/> -<xi:include href="nm-device-adsl.xml"/> -<xi:include href="nm-device-bond.xml"/> -<xi:include href="nm-device-bridge.xml"/> -<xi:include href="nm-device-bt.xml"/> -<xi:include href="nm-device-ethernet.xml"/> -<xi:include href="nm-device-generic.xml"/> -<xi:include href="nm-device-infiniband.xml"/> -<xi:include href="nm-device-ip-tunnel.xml"/> -<xi:include href="nm-device-macvlan.xml"/> -<xi:include href="nm-device-modem.xml"/> -<xi:include href="nm-device-olpc-mesh.xml"/> -<xi:include href="nm-device-team.xml"/> -<xi:include href="nm-device-tun.xml"/> -<xi:include href="nm-device-veth.xml"/> -<xi:include href="nm-device-vlan.xml"/> -<xi:include href="nm-device-vxlan.xml"/> -<xi:include href="nm-device-wifi.xml"/> -<xi:include href="nm-device-wimax.xml"/> -<xi:include href="nm-wimax-nsp.xml"/> -<xi:include href="nm-ip4-config.xml"/> -<xi:include href="nm-ip6-config.xml"/> -<xi:include href="nm-dhcp4-config.xml"/> -<xi:include href="nm-dhcp6-config.xml"/> -<xi:include href="nm-settings.xml"/> -<xi:include href="nm-settings-connection.xml"/> -<xi:include href="nm-active-connection.xml"/> -<xi:include href="nm-agent-manager.xml"/> -<xi:include href="nm-secret-agent.xml"/> -<xi:include href="nm-vpn-connection.xml"/> -<xi:include href="nm-vpn-plugin.xml"/> - -<xi:include href="errors.xml"/> -<xi:include href="vpn-errors.xml"/> -<xi:include href="generic-types.xml"/> - -<!-- -<xi:include href="extensions.xml"> - <xi:fallback> - <!- - absence of non-spec extensions is OK - -> - </xi:fallback> -</xi:include> ---> - -</tp:spec> diff --git a/introspection/errors.xml b/introspection/errors.xml deleted file mode 100644 index 34a0a7b9..00000000 --- a/introspection/errors.xml +++ /dev/null @@ -1,24 +0,0 @@ -<?xml version="1.0" ?> -<tp:errors xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" - namespace="org.freedesktop.NetworkManager.Error"> - <tp:copyright>Copyright (C) 2008 Novell, Inc.</tp:copyright> - - <tp:error name="Unknown Connection"> - <annotation name="org.gtk.GDBus.DocString" value=" - Connection was not provided by the settings service. - " /> - </tp:error> - - <tp:error name="Unknown Device"> - <annotation name="org.gtk.GDBus.DocString" value=" - Unknown device. - " /> - </tp:error> - - <tp:error name="Permission Denied"> - <annotation name="org.gtk.GDBus.DocString" value=" - User does not have the permission to activate this connection. - " /> - </tp:error> - -</tp:errors> diff --git a/introspection/generic-types.xml b/introspection/generic-types.xml deleted file mode 100644 index 2fb680af..00000000 --- a/introspection/generic-types.xml +++ /dev/null @@ -1,50 +0,0 @@ -<tp:generic-types - xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - <tp:mapping name="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value="A mapping from strings to variants representing extra - key-value pairs." /> - <tp:member type="s" name="Key"/> - <tp:member type="v" name="Value"/> - </tp:mapping> - - <tp:mapping name="String_String_Map"> - <annotation name="org.gtk.GDBus.DocString" value="A mapping from strings to strings representing extra - key-value pairs." /> - <tp:member type="s" name="Key"/> - <tp:member type="s" name="Value"/> - </tp:mapping> - - <tp:mapping name="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value="A mapping from strings to a map of string to variant." /> - <tp:member type="s" name="Key"/> - <tp:member type="a{sv}" name="Value" tp:type="String_Variant_Map"/> - </tp:mapping> - - <tp:enum name="NM_802_11_MODE" type="u"> - <annotation name="org.gtk.GDBus.DocString" value="" /> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value="Mode is unknown." /> - </tp:enumvalue> - <tp:enumvalue suffix="ADHOC" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - For both devices and access point objects, indicates the object is - part of an Ad-Hoc 802.11 network without a central coordinating access - point. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="INFRA" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The wireless device or access point is in infrastructure mode. For - devices, this indicates the device is an 802.11 client/station. For - access point objects, this indicates the object is an access point that - provides connectivity to clients. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="AP" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an access point/hotspot. Not valid for access point - objects themselves. - " /> - </tp:enumvalue> - </tp:enum> -</tp:generic-types> diff --git a/introspection/nm-access-point.xml b/introspection/nm-access-point.xml index 603be713..0c1ebf23 100644 --- a/introspection/nm-access-point.xml +++ b/introspection/nm-access-point.xml @@ -1,103 +1,101 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.AccessPoint"> - <property name="Flags" type="u" access="read" tp:type="NM_802_11_AP_FLAGS"> - <annotation name="org.gtk.GDBus.DocString" value="Flags describing the capabilities of the access point." /> - </property> - <property name="WpaFlags" type="u" access="read" tp:type="NM_802_11_AP_SEC"> - <annotation name="org.gtk.GDBus.DocString" value="Flags describing the access point's capabilities according to WPA (Wifi Protected Access)." /> - </property> - <property name="RsnFlags" type="u" access="read" tp:type="NM_802_11_AP_SEC"> - <annotation name="org.gtk.GDBus.DocString" value="Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol." /> - </property> + + <!-- + Flags: + + Flags describing the capabilities of the access point. + + Returns: <link linkend="NM80211ApFlags">NM80211ApFlags</link> + --> + <property name="Flags" type="u" access="read"/> + + <!-- + WpaFlags: + + Flags describing the access point's capabilities according to WPA (Wifi + Protected Access). + + Returns: <link linkend="NM80211ApSecurityFlags">NM80211ApSecurityFlags</link> + --> + <property name="WpaFlags" type="u" access="read"/> + + <!-- + RsnFlags: + + Flags describing the access point's capabilities according to the RSN + (Robust Secure Network) protocol. + + Returns: <link linkend="NM80211ApSecurityFlags">NM80211ApSecurityFlags</link> + --> + <property name="RsnFlags" type="u" access="read"/> + + <!-- + Ssid: + + The Service Set Identifier identifying the access point. + --> <property name="Ssid" type="ay" access="read"> <!-- gdbus-codegen assumes that "ay" means "non-UTF-8 string" and won't deal with '\0' bytes correctly. --> <annotation name="org.gtk.GDBus.C.ForceGVariant" value="1"/> - <annotation name="org.gtk.GDBus.DocString" value="The Service Set Identifier identifying the access point." /> - </property> - <property name="Frequency" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The radio channel frequency in use by the access point, in MHz." /> - </property> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The hardware address (BSSID) of the access point." /> </property> - <property name="Mode" type="u" access="read" tp:type="NM_802_11_MODE"> - <annotation name="org.gtk.GDBus.DocString" value="Describes the operating mode of the access point." /> - </property> - <property name="MaxBitrate" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The maximum bitrate this access point is capable of, in kilobits/second (Kb/s)." /> - </property> - <property name="Strength" type="y" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The current signal quality of the access point, in percent." /> - </property> - <property name="LastSeen" type="i" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Frequency: + + The radio channel frequency in use by the access point, in MHz. + --> + <property name="Frequency" type="u" access="read"/> + + <!-- + HwAddress: + + The hardware address (BSSID) of the access point. + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Mode: + + Describes the operating mode of the access point. + + Returns: <link linkend="NM80211Mode">NM80211Mode</link> + --> + <property name="Mode" type="u" access="read"/> + + <!-- + MaxBitrate: + + The maximum bitrate this access point is capable of, in kilobits/second + (Kb/s). + --> + <property name="MaxBitrate" type="u" access="read"/> + + <!-- + Strength: + + The current signal quality of the access point, in percent. + --> + <property name="Strength" type="y" access="read"/> + + <!-- + LastSeen: + The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access - point was found in scan results. A value of -1 means the access point - has never been found in scan results. - " /> - </property> + point was found in scan results. A value of -1 means the access point has + never been found in scan results. + --> + <property name="LastSeen" type="i" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - <tp:flags name="NM_802_11_AP_FLAGS" value-prefix="NM_802_11_AP_FLAGS" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags describing the general capabilities of the access point. - " /> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Null capability - says nothing about the access point." /> - </tp:flag> - <tp:flag suffix="PRIVACY" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports privacy measures." /> - </tp:flag> - </tp:flags> - <tp:flags name="NM_802_11_AP_SEC" value-prefix="NM_802_11_AP_SEC" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags describing the security capabilities of the access point. - " /> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Null flag." /> - </tp:flag> - <tp:flag suffix="PAIR_WEP40" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 40-bit WEP encryption." /> - </tp:flag> - <tp:flag suffix="PAIR_WEP104" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 104-bit WEP encryption." /> - </tp:flag> - <tp:flag suffix="PAIR_TKIP" value="0x4"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise TKIP encryption." /> - </tp:flag> - <tp:flag suffix="PAIR_CCMP" value="0x8"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise CCMP encryption." /> - </tp:flag> - <tp:flag suffix="GROUP_WEP40" value="0x10"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group 40-bit WEP cipher." /> - </tp:flag> - <tp:flag suffix="GROUP_WEP104" value="0x20"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group 104-bit WEP cipher." /> - </tp:flag> - <tp:flag suffix="GROUP_TKIP" value="0x40"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group TKIP cipher." /> - </tp:flag> - <tp:flag suffix="GROUP_CCMP" value="0x80"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group CCMP cipher." /> - </tp:flag> - <tp:flag suffix="KEY_MGMT_PSK" value="0x100"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports PSK key management." /> - </tp:flag> - <tp:flag suffix="KEY_MGMT_802_1X" value="0x200"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports 802.1x key management." /> - </tp:flag> - </tp:flags> </interface> </node> - diff --git a/introspection/nm-active-connection.xml b/introspection/nm-active-connection.xml index 59bf78f4..a4e94170 100644 --- a/introspection/nm-active-connection.xml +++ b/introspection/nm-active-connection.xml @@ -1,154 +1,156 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <!-- + org.freedesktop.NetworkManager.Connection.Active: + + Objects that implement the Connection.Active interface represent an + attempt to connect to a network using the details provided by a Connection + object. The Connection.Active object tracks the life-cycle of the + connection attempt and if successful indicates whether the connected + network is the "default" or preferred network for access. NetworkManager + has the concept of connections, which can be thought of as settings, a + profile or a configuration that can be applied on a networking device. + Such settings-connections are exposed as D-Bus object and the + active-connection expresses this relationship between device and + settings-connection. At any time a settings-connection can only be + activated on one device and vice versa. However, during activation and + deactivation multiple active-connections can reference the same device or + settings-connection as they are waiting to be activated or to be + deactivated. + --> <interface name="org.freedesktop.NetworkManager.Connection.Active"> <annotation name="org.gtk.GDBus.C.Name" value="ActiveConnection"/> - <annotation name="org.gtk.GDBus.DocString" value=" - Objects that implement the Connection.Active interface represent an attempt - to connect to a network using the details provided by a Connection object. - The Connection.Active object tracks the life-cycle of the connection - attempt and if successful indicates whether the connected network is the - "default" or preferred network for access. - NetworkManager has the concept of connections, which can be thought of as - settings, a profile or a configuration that can be applied on a networking - device. - Such settings-connections are exposed as D-Bus object and the active-connection - expresses this relationship between device and settings-connection. - At any time a settings-connection can only be activated on one device and vice - versa. However, during activation and deactivation multiple active-connections - can reference the same device or settings-connection as they are waiting to - be activated or to be deactivated. - " /> - - <property name="Connection" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + + <!-- + Connection: + The path of the connection. - " /> - </property> - <property name="SpecificObject" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - A specific object associated with the active connection. This property + --> + <property name="Connection" type="o" access="read"/> + + <!-- + SpecificObject: + + A specific object associated with the active connection. This property reflects the specific object used during connection activation, and will not change over the lifetime of the ActiveConnection once set. - " /> - </property> - <property name="Id" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The ID of the connection, provided as a convenience so that clients - do not have to retrieve all connection details. - " /> - </property> - <property name="Uuid" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The UUID of the connection, provided as a convenience so that clients - do not have to retrieve all connection details. - " /> - </property> - <property name="Type" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The type of the connection, provided as a convenience so that clients - do not have to retrieve all connection details. - " /> - </property> - <property name="Devices" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="SpecificObject" type="o" access="read"/> + + <!-- + Id: + + The ID of the connection, provided as a convenience so that clients do not + have to retrieve all connection details. + --> + <property name="Id" type="s" access="read"/> + + <!-- + Uuid: + + The UUID of the connection, provided as a convenience so that clients do + not have to retrieve all connection details. + --> + <property name="Uuid" type="s" access="read"/> + + <!-- + Type: + + The type of the connection, provided as a convenience so that clients do + not have to retrieve all connection details. + --> + <property name="Type" type="s" access="read"/> + + <!-- + Devices: + Array of object paths representing devices which are part of this active connection. - " /> - </property> - <property name="State" type="u" access="read" tp:type="NM_ACTIVE_CONNECTION_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Devices" type="ao" access="read"/> + + <!-- + State: + The state of this active connection. - " /> - </property> - <property name="Default" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + + Returns: <link linkend="NMActiveConnectionState">NMActiveConnectionState</link> + --> + <property name="State" type="u" access="read"/> + + <!-- + Default: + Whether this active connection is the default IPv4 connection, i.e. whether it currently owns the default IPv4 route. - " /> - </property> - <property name="Ip4Config" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Default" type="b" access="read"/> + + <!-- + Ip4Config: + Object path of the Ip4Config object describing the configuration of the connection. Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. - " /> - </property> - <property name="Dhcp4Config" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the Dhcp4Config object describing the DHCP options - returned by the DHCP server (assuming the connection used DHCP). Only - valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED - state. - " /> - </property> - <property name="Default6" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Ip4Config" type="o" access="read"/> + + <!-- + Dhcp4Config: + + Object path of the Dhcp4Config object describing the DHCP options returned + by the DHCP server (assuming the connection used DHCP). Only valid when + the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. + --> + <property name="Dhcp4Config" type="o" access="read"/> + + <!-- + Default6: + Whether this active connection is the default IPv6 connection, i.e. whether it currently owns the default IPv6 route. - " /> - </property> - <property name="Ip6Config" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Default6" type="b" access="read"/> + + <!-- + Ip6Config: + Object path of the Ip6Config object describing the configuration of the connection. Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. - " /> - </property> - <property name="Dhcp6Config" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the Dhcp6Config object describing the DHCP options - returned by the DHCP server (assuming the connection used DHCP). Only - valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED - state. - " /> - </property> - <property name="Vpn" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Ip6Config" type="o" access="read"/> + + <!-- + Dhcp6Config: + + Object path of the Dhcp6Config object describing the DHCP options returned + by the DHCP server (assuming the connection used DHCP). Only valid when + the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. + --> + <property name="Dhcp6Config" type="o" access="read"/> + + <!-- + Vpn: + Whether this active connection is also a VPN connection. - " /> - </property> - <property name="Master" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Vpn" type="b" access="read"/> + + <!-- + Master: + The path to the master device if the connection is a slave. - " /> - </property> + --> + <property name="Master" type="o" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - - <tp:enum name="NM_ACTIVE_CONNECTION_STATE" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The active connection is in an unknown state. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ACTIVATING" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection is activating. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ACTIVATED" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection is activated. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DEACTIVATING" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection is being torn down and cleaned up. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DEACTIVATED" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection is no longer active. - " /> - </tp:enumvalue> - </tp:enum> </interface> </node> - diff --git a/introspection/nm-agent-manager.xml b/introspection/nm-agent-manager.xml index 52460eee..86b4404a 100644 --- a/introspection/nm-agent-manager.xml +++ b/introspection/nm-agent-manager.xml @@ -1,50 +1,37 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/org/freedesktop/NetworkManager/AgentManager" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/org/freedesktop/NetworkManager/AgentManager"> <interface name="org.freedesktop.NetworkManager.AgentManager"> - <method name="Register"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Register: + @identifier: Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes). + Called by secret Agents to register their ability to provide and save network secrets. - " /> - <arg name="identifier" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Identifies this agent; only one agent in each user session may use the - same identifier. Identifier formatting follows the same rules as - D-Bus bus names with the exception that the ':' character is not - allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the - identifier is limited in length to 255 characters with a minimum - of 3 characters. An example valid identifier is 'org.gnome.nm-applet' - (without quotes). - " /> - </arg> + --> + <method name="Register"> + <arg name="identifier" type="s" direction="in"/> </method> - <method name="RegisterWithCapabilities"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + RegisterWithCapabilities: + @identifier: See the Register() method's identifier argument. + @capabilities: (<link linkend="NMSecretAgentCapabilities">NMSecretAgentCapabilities</link>) Indicates various agent capabilities to NetworkManager. + Like Register() but indicates agent capabilities to NetworkManager. - " /> - <arg name="identifier" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - See the Register() method's identifier argument. - " /> - </arg> - <arg name="capabilities" type="u" direction="in" tp:type="NM_SECRET_AGENT_CAPABILITIES"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates various agent capabilities to NetworkManager. - " /> - </arg> + --> + <method name="RegisterWithCapabilities"> + <arg name="identifier" type="s" direction="in"/> + <arg name="capabilities" type="u" direction="in"/> </method> - <method name="Unregister"> - <annotation name="org.gtk.GDBus.DocString" value=" - Called by secret Agents to notify NetworkManager that they will no - longer handle requests for network secrets. Agents are automatically - unregistered when they disconnect from D-Bus. - " /> - </method> + <!-- + Unregister: + Called by secret Agents to notify NetworkManager that they will no longer + handle requests for network secrets. Agents are automatically unregistered + when they disconnect from D-Bus. + --> + <method name="Unregister"/> </interface> </node> - diff --git a/introspection/nm-device-adsl.xml b/introspection/nm-device-adsl.xml index 68859d3b..5ad397e6 100644 --- a/introspection/nm-device-adsl.xml +++ b/introspection/nm-device-adsl.xml @@ -1,21 +1,20 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Adsl"> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found. - " /> - </property> + <!-- + Carrier: + Indicates whether the physical carrier is found. + --> + <property name="Carrier" type="b" access="read"/> </interface> </node> diff --git a/introspection/nm-device-bond.xml b/introspection/nm-device-bond.xml index 9bc21225..fc0249d9 100644 --- a/introspection/nm-device-bond.xml +++ b/introspection/nm-device-bond.xml @@ -1,34 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Bond"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Carrier: - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> - <property name="Slaves" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of object paths representing devices which are currently - slaved to this device. - " /> - </property> + <!-- + Slaves: + Array of object paths representing devices which are currently slaved to + this device. + --> + <property name="Slaves" type="ao" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-bridge.xml b/introspection/nm-device-bridge.xml index 6cf99a10..c2e8ffd3 100644 --- a/introspection/nm-device-bridge.xml +++ b/introspection/nm-device-bridge.xml @@ -1,34 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Bridge"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Carrier: - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> - <property name="Slaves" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of object paths representing devices which are currently - slaved to this device. - " /> - </property> + <!-- + Slaves: + Array of object paths representing devices which are currently slaved to + this device. + --> + <property name="Slaves" type="ao" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-bt.xml b/introspection/nm-device-bt.xml index 3b487158..6249085b 100644 --- a/introspection/nm-device-bt.xml +++ b/introspection/nm-device-bt.xml @@ -1,48 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Bluetooth"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Bluetooth hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Name: - <property name="Name" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Bluetooth name of the device. - " /> - </property> + --> + <property name="Name" type="s" access="read"/> + + <!-- + BtCapabilities: - <property name="BtCapabilities" type="u" access="read" tp:type="NM_BT_CAPABILITIES"> - <annotation name="org.gtk.GDBus.DocString" value=" Bluetooth capabilities of the device (either DUN or NAP). - " /> - </property> + Returns: <link linkend="NMBluetoothCapabilities">NMBluetoothCapabilities</link> + --> + <property name="BtCapabilities" type="u" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - - <tp:flags name="NM_BT_CAPABILITIES" value-prefix="NM_BT_CAPABILITY" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags describing the capabilities of a Bluetooth device. - " /> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="The device has no recognized capabilities." /> - </tp:flag> - <tp:flag suffix="DUN" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports Bluetooth Dial-Up Networking." /> - </tp:flag> - <tp:flag suffix="PAN" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports Bluetooth Personal Area Networking." /> - </tp:flag> - </tp:flags> - </interface> </node> diff --git a/introspection/nm-device-ethernet.xml b/introspection/nm-device-ethernet.xml index 87b7f755..ddfa74bb 100644 --- a/introspection/nm-device-ethernet.xml +++ b/introspection/nm-device-ethernet.xml @@ -1,46 +1,50 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Wired"> <annotation name="org.gtk.GDBus.C.Name" value="DeviceEthernet"/> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Active hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + PermHwAddress: - <property name="PermHwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Permanent hardware address of the device. - " /> - </property> + --> + <property name="PermHwAddress" type="s" access="read"/> + + <!-- + Speed: - <property name="Speed" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Design speed of the device, in megabits/second (Mb/s). - " /> - </property> + --> + <property name="Speed" type="u" access="read"/> + + <!-- + S390Subchannels: - <property name="S390Subchannels" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Array of S/390 subchannels for S/390 or z/Architecture devices. - " /> - </property> + --> + <property name="S390Subchannels" type="as" access="read"/> + + <!-- + Carrier: - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-generic.xml b/introspection/nm-device-generic.xml index 2f8fc7ee..e79ff700 100644 --- a/introspection/nm-device-generic.xml +++ b/introspection/nm-device-generic.xml @@ -1,27 +1,27 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Generic"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + TypeDescription: - <property name="TypeDescription" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" A (non-localized) description of the interface type, if known. - " /> - </property> + --> + <property name="TypeDescription" type="s" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-infiniband.xml b/introspection/nm-device-infiniband.xml index 169c2c66..9848a074 100644 --- a/introspection/nm-device-infiniband.xml +++ b/introspection/nm-device-infiniband.xml @@ -1,27 +1,28 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Infiniband"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + <!-- + Carrier: + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-ip-tunnel.xml b/introspection/nm-device-ip-tunnel.xml index 3ca04ee6..45f3a3f7 100644 --- a/introspection/nm-device-ip-tunnel.xml +++ b/introspection/nm-device-ip-tunnel.xml @@ -1,86 +1,94 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.IPTunnel"> - <property name="Mode" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Mode: + The tunneling mode. - " /> - </property> + --> + <property name="Mode" type="u" access="read"/> + + <!-- + Parent: - <property name="Parent" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The object path of the parent device. - " /> - </property> + --> + <property name="Parent" type="o" access="read"/> + + <!-- + Local: - <property name="Local" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The local endpoint of the tunnel. - " /> - </property> + --> + <property name="Local" type="s" access="read"/> + + <!-- + Remote: - <property name="Remote" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The remote endpoint of the tunnel. - " /> - </property> - - <property name="Ttl" type="y" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The TTL assigned to tunneled packets. 0 is a special value - meaning that packets inherit the TTL value - " /> - </property> - - <property name="Tos" type="y" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The type of service (IPv4) or traffic class (IPv6) assigned to - tunneled packets. - " /> - </property> - - <property name="PathMtuDiscovery" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Remote" type="s" access="read"/> + + <!-- + Ttl: + + The TTL assigned to tunneled packets. 0 is a special value meaning that + packets inherit the TTL value + --> + <property name="Ttl" type="y" access="read"/> + + <!-- + Tos: + + The type of service (IPv4) or traffic class (IPv6) assigned to tunneled + packets. + --> + <property name="Tos" type="y" access="read"/> + + <!-- + PathMtuDiscovery: + Whether path MTU discovery is enabled on this tunnel. - " /> - </property> + --> + <property name="PathMtuDiscovery" type="b" access="read"/> + + <!-- + InputKey: - <property name="InputKey" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The key used for incoming packets. - " /> - </property> + --> + <property name="InputKey" type="s" access="read"/> + + <!-- + OutputKey: - <property name="OutputKey" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The key used for outgoing packets. - " /> - </property> - - <property name="EncapsulationLimit" type="y" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - How many additional levels of encapsulation are permitted to - be prepended to packets. This property applies only to IPv6 - tunnels. - " /> - </property> - - <property name="FlowLabel" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The flow label to assign to tunnel packets. This property - applies only to IPv6 tunnels. - " /> - </property> + --> + <property name="OutputKey" type="s" access="read"/> + + <!-- + EncapsulationLimit: + How many additional levels of encapsulation are permitted to be prepended + to packets. This property applies only to IPv6 tunnels. + --> + <property name="EncapsulationLimit" type="y" access="read"/> + + <!-- + FlowLabel: + + The flow label to assign to tunnel packets. This property applies only to + IPv6 tunnels. + --> + <property name="FlowLabel" type="u" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-macvlan.xml b/introspection/nm-device-macvlan.xml index d5d66068..876b685c 100644 --- a/introspection/nm-device-macvlan.xml +++ b/introspection/nm-device-macvlan.xml @@ -1,39 +1,41 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Macvlan"> - <property name="Parent" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Parent: + The object path of the parent device. - " /> - </property> + --> + <property name="Parent" type="o" access="read"/> + + <!-- + Mode: - <property name="Mode" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The macvlan mode, one of "private", "vepa", "bridge", or "passthru". - " /> - </property> + The macvlan mode, one of "private", "vepa", "bridge", or "passthru". + --> + <property name="Mode" type="s" access="read"/> + + <!-- + NoPromisc: - <property name="NoPromisc" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Whether the device is blocked from going into promiscuous mode. - " /> - </property> + --> + <property name="NoPromisc" type="b" access="read"/> + + <!-- + Tap: - <property name="Tap" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Whether the device is a macvtap. - " /> - </property> + --> + <property name="Tap" type="b" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-modem.xml b/introspection/nm-device-modem.xml index 67742c46..1d4bd65e 100644 --- a/introspection/nm-device-modem.xml +++ b/introspection/nm-device-modem.xml @@ -1,64 +1,35 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Modem"> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - <property name="ModemCapabilities" type="u" access="read" tp:type="NM_DEVICE_MODEM_CAPABILITIES"> - <annotation name="org.gtk.GDBus.DocString" value=" - The generic family of access technologies the modem supports. Not all - capabilities are available at the same time however; some modems require - a firmware reload or other reinitialization to switch between eg CDMA/EVDO + <!-- + ModemCapabilities: + + The generic family of access technologies the modem supports. Not all + capabilities are available at the same time however; some modems require a + firmware reload or other reinitialization to switch between eg CDMA/EVDO and GSM/UMTS. - " /> - </property> - <property name="CurrentCapabilities" type="u" access="read" tp:type="NM_DEVICE_MODEM_CAPABILITIES"> - <annotation name="org.gtk.GDBus.DocString" value=" + Returns: <link linkend="NMDeviceModemCapabilities">NMDeviceModemCapabilities</link> + --> + <property name="ModemCapabilities" type="u" access="read"/> + + <!-- + CurrentCapabilities: + The generic family of access technologies the modem currently supports without a firmware reload or reinitialization. - " /> - </property> - - <tp:flags name="NM_DEVICE_MODEM_CAPABILITIES" value-prefix="NM_DEVICE_MODEM_CAPABILITY" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags describing one or more of the general access technology families - that a modem device supports. - " /> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Modem has no capabilties." /> - </tp:flag> - <tp:flag suffix="POTS" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem supports the analog wired telephone network (ie 56k dialup) and - does not have wireless/cellular capabilities. - " /> - </tp:flag> - <tp:flag suffix="CDMA_EVDO" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem supports at least one of CDMA 1xRTT, EVDO revision 0, EVDO - revision A, or EVDO revision B. - " /> - </tp:flag> - <tp:flag suffix="GSM_UMTS" value="0x4"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem supports at least one of GSM, GPRS, EDGE, UMTS, HSDPA, HSUPA, or - HSPA+ packet switched data capability. - " /> - </tp:flag> - <tp:flag suffix="LTE" value="0x8"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem has at LTE data capability. - " /> - </tp:flag> - </tp:flags> + Returns: <link linkend="NMDeviceModemCapabilities">NMDeviceModemCapabilities</link> + --> + <property name="CurrentCapabilities" type="u" access="read"/> </interface> </node> diff --git a/introspection/nm-device-olpc-mesh.xml b/introspection/nm-device-olpc-mesh.xml index a92e7370..b2ab126e 100644 --- a/introspection/nm-device-olpc-mesh.xml +++ b/introspection/nm-device-olpc-mesh.xml @@ -1,34 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.OlpcMesh"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + + <!-- + HwAddress: + The hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Companion: - <property name="Companion" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The object path of the companion device. - " /> - </property> + --> + <property name="Companion" type="o" access="read"/> + + <!-- + ActiveChannel: - <property name="ActiveChannel" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The currently active channel. - " /> - </property> + --> + <property name="ActiveChannel" type="u" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary containing the FIXME: check changed parameters. + Emitted when the wireless device's properties changed. + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary containing the FIXME: check changed parameters. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when the wireless device's properties changed. - " /> + <arg name="properties" type="a{sv}"/> </signal> </interface> </node> diff --git a/introspection/nm-device-team.xml b/introspection/nm-device-team.xml index 982b7670..05bbbafe 100644 --- a/introspection/nm-device-team.xml +++ b/introspection/nm-device-team.xml @@ -1,34 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Team"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Carrier: - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> - <property name="Slaves" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of object paths representing devices which are currently - slaved to this device. - " /> - </property> + <!-- + Slaves: + Array of object paths representing devices which are currently slaved to + this device. + --> + <property name="Slaves" type="ao" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-tun.xml b/introspection/nm-device-tun.xml index 0f74cf8c..a11461c1 100644 --- a/introspection/nm-device-tun.xml +++ b/introspection/nm-device-tun.xml @@ -1,61 +1,65 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Tun"> - <property name="Owner" type="x" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Owner: + The uid of the tunnel owner, or -1 if it has no owner. - " /> - </property> + --> + <property name="Owner" type="x" access="read"/> + + <!-- + Group: - <property name="Group" type="x" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The gid of the tunnel group, or -1 if it has no owner. - " /> - </property> - - <property name="Mode" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The tunnel mode, either "tun" or "tap". - " /> - </property> - - <property name="NoPi" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The tunnel's "TUN_NO_PI" flag; true if no protocol info is - prepended to the tunnel packets. - " /> - </property> - - <property name="VnetHdr" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets - include a virtio network header. - " /> - </property> - - <property name="MultiQueue" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to - the tap device multiple times, for multiple send/receive - queues. - " /> - </property> - - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Group" type="x" access="read"/> + + <!-- + Mode: + + The tunnel mode, either "tun" or "tap". + --> + <property name="Mode" type="s" access="read"/> + + <!-- + NoPi: + + The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to + the tunnel packets. + --> + <property name="NoPi" type="b" access="read"/> + + <!-- + VnetHdr: + + The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a + virtio network header. + --> + <property name="VnetHdr" type="b" access="read"/> + + <!-- + MultiQueue: + + The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap + device multiple times, for multiple send/receive queues. + --> + <property name="MultiQueue" type="b" access="read"/> + + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-veth.xml b/introspection/nm-device-veth.xml index a3cff6da..b064874e 100644 --- a/introspection/nm-device-veth.xml +++ b/introspection/nm-device-veth.xml @@ -1,21 +1,20 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Veth"> - <property name="Peer" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Peer: + The object path of the device's peer. - " /> - </property> + --> + <property name="Peer" type="o" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-vlan.xml b/introspection/nm-device-vlan.xml index bac220e8..7d8fbdce 100644 --- a/introspection/nm-device-vlan.xml +++ b/introspection/nm-device-vlan.xml @@ -1,39 +1,42 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Vlan"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Carrier: - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> + + <!-- + Parent: - <property name="Parent" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Object path of the parent device of this VLAN device. - " /> - </property> + --> + <property name="Parent" type="o" access="read"/> + + <!-- + VlanId: - <property name="VlanId" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The VLAN ID of this VLAN interface. - " /> - </property> + --> + <property name="VlanId" type="u" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-vxlan.xml b/introspection/nm-device-vxlan.xml index de23020d..ec17717d 100644 --- a/introspection/nm-device-vxlan.xml +++ b/introspection/nm-device-vxlan.xml @@ -1,128 +1,139 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Vxlan"> - <property name="Parent" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the parent device (if the VXLAN is not - purely internal to this host). - " /> - </property> + <!-- + Parent: + + The object path of the parent device (if the VXLAN is not purely internal + to this host). + --> + <property name="Parent" type="o" access="read"/> + + <!-- + HwAddress: - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Id: - <property name="Id" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The VXLAN Network Identifier (VNI). - " /> - </property> + --> + <property name="Id" type="u" access="read"/> + + <!-- + Group: - <property name="Group" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The IP (v4 or v6) multicast group used to communicate with other physical - hosts on this VXLAN. - " /> - </property> + hosts on this VXLAN. + --> + <property name="Group" type="s" access="read"/> + + <!-- + Local: - <property name="Local" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The local IPv4 or IPv6 address to use when sending VXLAN packets to other - physical hosts. - " /> - </property> - - <property name="Tos" type="y" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The value to use in the IP ToS field for VXLAN packets sent to - other physical hosts. - " /> - </property> - - <property name="Ttl" type="y" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The value to use in the IP TTL field for VXLAN packets sent to - other physical hosts. - " /> - </property> - - <property name="Learning" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + physical hosts. + --> + <property name="Local" type="s" access="read"/> + + <!-- + Tos: + + The value to use in the IP ToS field for VXLAN packets sent to other + physical hosts. + --> + <property name="Tos" type="y" access="read"/> + + <!-- + Ttl: + + The value to use in the IP TTL field for VXLAN packets sent to other + physical hosts. + --> + <property name="Ttl" type="y" access="read"/> + + <!-- + Learning: + True if the VXLAN dynamically learns remote IP addresses. - " /> - </property> - - <property name="Ageing" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The interval in seconds at which the kernel purges stale - cached addresses. - " /> - </property> - - <property name="Limit" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The maximum number of entries that can be added to the VXLAN's - forwarding table. - " /> - </property> - - <property name="DstPort" type="q" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Learning" type="b" access="read"/> + + <!-- + Ageing: + + The interval in seconds at which the kernel purges stale cached addresses. + --> + <property name="Ageing" type="u" access="read"/> + + <!-- + Limit: + + The maximum number of entries that can be added to the VXLAN's forwarding + table. + --> + <property name="Limit" type="u" access="read"/> + + <!-- + DstPort: + Destination port for outgoing VXLAN packets. - " /> - </property> + --> + <property name="DstPort" type="q" access="read"/> + + <!-- + SrcPortMin: - <property name="SrcPortMin" type="q" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The lowest source port number to use for outgoing VXLAN packets. - " /> - </property> + --> + <property name="SrcPortMin" type="q" access="read"/> + + <!-- + SrcPortMax: - <property name="SrcPortMax" type="q" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The highest source port number to use for outgoing VXLAN packets. - " /> - </property> - - <property name="Proxy" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - True if the VXLAN is implementing DOVE ARP proxying for remote - clients. - " /> - </property> - - <property name="Rsc" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - True if the VXLAN is implementing DOVE route short-circuiting - of known remote IP addresses. - " /> - </property> - - <property name="L2miss" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - True if the VXLAN will emit netlink notifications of L2 switch - misses. - " /> - </property> - - <property name="L3miss" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - True if the VXLAN will emit netlink notifications of L3 switch - misses. - " /> - </property> + --> + <property name="SrcPortMax" type="q" access="read"/> + + <!-- + Proxy: + + True if the VXLAN is implementing DOVE ARP proxying for remote clients. + --> + <property name="Proxy" type="b" access="read"/> + <!-- + Rsc: + + True if the VXLAN is implementing DOVE route short-circuiting of known + remote IP addresses. + --> + <property name="Rsc" type="b" access="read"/> + + <!-- + L2miss: + + True if the VXLAN will emit netlink notifications of L2 switch misses. + --> + <property name="L2miss" type="b" access="read"/> + + <!-- + L3miss: + + True if the VXLAN will emit netlink notifications of L3 switch misses. + --> + <property name="L3miss" type="b" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-wifi.xml b/introspection/nm-device-wifi.xml index 2ece0ef0..c1f378d8 100644 --- a/introspection/nm-device-wifi.xml +++ b/introspection/nm-device-wifi.xml @@ -1,170 +1,124 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Wireless"> <annotation name="org.gtk.GDBus.C.Name" value="DeviceWifi"/> - <method name="GetAccessPoints"> - <arg name="access_points" type="ao" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - List of access point object paths. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - DEPRECATED. Get the list of access points visible to this device. Note - that this list does not include access points which hide their SSID. To + <!-- + GetAccessPoints: + @access_points: List of access point object paths. + + DEPRECATED. Get the list of access points visible to this device. Note + that this list does not include access points which hide their SSID. To retrieve a list of all access points (including hidden ones) use the GetAllAccessPoints() method. - " /> - </method> + --> + <method name="GetAccessPoints"> + <arg name="access_points" type="ao" direction="out"/> + </method> + + <!-- + GetAllAccessPoints: + @access_points: List of access point object paths. + Get the list of all access points visible to this device, including hidden + ones for which the SSID is not yet known. + --> <method name="GetAllAccessPoints"> - <arg name="access_points" type="ao" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - List of access point object paths. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Get the list of all access points visible to this device, including - hidden ones for which the SSID is not yet known. - " /> - </method> + <arg name="access_points" type="ao" direction="out"/> + </method> + + <!-- + RequestScan: + @options: Options of scan. Currently 'ssids' option with value of "aay" type is supported. - <method name="RequestScan"> - <arg name="options" type="a{sv}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Options of scan. - Currently 'ssids' option with value of "aay" type is supported. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" Request the device to scan - " /> - </method> + --> + <method name="RequestScan"> + <arg name="options" type="a{sv}" direction="in"/> + </method> + + <!-- + HwAddress: - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The active hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + PermHwAddress: - <property name="PermHwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The permanent hardware address of the device. - " /> - </property> + --> + <property name="PermHwAddress" type="s" access="read"/> + + <!-- + Mode: - <property name="Mode" type="u" access="read" tp:type="NM_802_11_MODE"> - <annotation name="org.gtk.GDBus.DocString" value=" The operating mode of the wireless device. - " /> - </property> - <property name="Bitrate" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The bit rate currently used by the wireless device, in kilobits/second (Kb/s). - " /> - </property> + Returns: <link linkend="NM80211Mode">NM80211Mode</link> + --> + <property name="Mode" type="u" access="read"/> + + <!-- + Bitrate: + + The bit rate currently used by the wireless device, in kilobits/second + (Kb/s). + --> + <property name="Bitrate" type="u" access="read"/> + + <!-- + AccessPoints: - <property name="AccessPoints" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" List of object paths of access point visible to this wireless device. - " /> - </property> + --> + <property name="AccessPoints" type="ao" access="read"/> + + <!-- + ActiveAccessPoint: - <property name="ActiveAccessPoint" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Object path of the access point currently used by the wireless device. - " /> - </property> + --> + <property name="ActiveAccessPoint" type="o" access="read"/> + + <!-- + WirelessCapabilities: - <property name="WirelessCapabilities" type="u" access="read" tp:type="NM_802_11_DEVICE_CAP"> - <annotation name="org.gtk.GDBus.DocString" value=" The capabilities of the wireless device. - " /> - </property> + Returns: <link linkend="NMDeviceWifiCapabilities">NMDeviceWifiCapabilities</link> + --> + <property name="WirelessCapabilities" type="u" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary containing the FIXME: check changed parameters. + + Emitted when the wireless device's properties changed. + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary containing the FIXME: check changed parameters. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when the wireless device's properties changed. - " /> - </signal> + <arg name="properties" type="a{sv}"/> + </signal> + + <!-- + AccessPointAdded: + @access_point: The object path of the newly found access point. + Emitted when a new access point is found by the device. + --> <signal name="AccessPointAdded"> - <arg name="access_point" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the newly found access point. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when a new access point is found by the device. - " /> - </signal> + <arg name="access_point" type="o"/> + </signal> + <!-- + AccessPointRemoved: + @access_point: The object path of the access point that has disappeared. + + Emitted when an access point disappears from view of the device. + --> <signal name="AccessPointRemoved"> - <arg name="access_point" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the access point that has disappeared. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when an access point disappears from view of the device. - " /> + <arg name="access_point" type="o"/> </signal> - - <tp:flags name="NM_802_11_DEVICE_CAP" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags describing the capabilities of a wireless device. - " /> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Null capability - syntactic sugar for no capabilities supported. Do not AND this with other capabilities!" /> - </tp:flag> - <tp:flag suffix="CIPHER_WEP40" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the 40-bit WEP cipher." /> - </tp:flag> - <tp:flag suffix="CIPHER_WEP104" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the 104-bit WEP cipher." /> - </tp:flag> - <tp:flag suffix="CIPHER_TKIP" value="0x4"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the TKIP cipher." /> - </tp:flag> - <tp:flag suffix="CIPHER_CCMP" value="0x8"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the CCMP cipher." /> - </tp:flag> - <tp:flag suffix="WPA" value="0x10"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the WPA encryption/authentication protocol." /> - </tp:flag> - <tp:flag suffix="RSN" value="0x20"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the RSN encryption/authentication protocol." /> - </tp:flag> - <tp:flag suffix="AP" value="0x40"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports Access Point mode." /> - </tp:flag> - <tp:flag suffix="ADHOC" value="0x80"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports Ad-Hoc mode." /> - </tp:flag> - <tp:flag suffix="FREQ_VALID" value="0x100"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device properly reports information about supported - frequencies and thus both NM_802_11_DEVICE_CAP_FREQ_2GHZ and - NM_802_11_DEVICE_CAP_FREQ_5GHZ are valid. - " /> - </tp:flag> - <tp:flag suffix="FREQ_2GHZ" value="0x200"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device supports 2.4GHz frequencies. - " /> - </tp:flag> - <tp:flag suffix="FREQ_5GHZ" value="0x400"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device supports 5GHz frequencies. - " /> - </tp:flag> - </tp:flags> </interface> </node> diff --git a/introspection/nm-device-wimax.xml b/introspection/nm-device-wimax.xml index e790e4fc..02539dbb 100644 --- a/introspection/nm-device-wimax.xml +++ b/introspection/nm-device-wimax.xml @@ -1,109 +1,112 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.WiMax"> - <method name="GetNspList"> - <arg name="nsps" type="ao" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - List of NSP object paths - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" + + <!-- + GetNspList: + @nsps: List of NSP object paths + Get the list of NSPs visible to this device. - " /> - </method> + --> + <method name="GetNspList"> + <arg name="nsps" type="ao" direction="out"/> + </method> + + <!-- + Nsps: - <property name="Nsps" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" List of object paths of Network Service Providers (NSPs) visible to this WiMAX device. - " /> - </property> + --> + <property name="Nsps" type="ao" access="read"/> + + <!-- + HwAddress: - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + CenterFrequency: - <property name="CenterFrequency" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Center frequency (in KHz) of the radio channel the device is using to - communicate with the network when connected. Has no meaning when the - device is not connected. - " /> - </property> - - <property name="Rssi" type="i" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - RSSI of the current radio link in dBm. This value indicates how strong - the raw received RF signal from the base station is, but does not - indicate the overall quality of the radio link. Has no meaning when the + communicate with the network when connected. Has no meaning when the device is not connected. - " /> - </property> + --> + <property name="CenterFrequency" type="u" access="read"/> + + <!-- + Rssi: + + RSSI of the current radio link in dBm. This value indicates how strong the + raw received RF signal from the base station is, but does not indicate the + overall quality of the radio link. Has no meaning when the device is not + connected. + --> + <property name="Rssi" type="i" access="read"/> + + <!-- + Cinr: - <property name="Cinr" type="i" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - CINR (Carrier to Interference + Noise Ratio) of the current radio link - in dB. CINR is a more accurate measure of radio link quality. Has no + CINR (Carrier to Interference + Noise Ratio) of the current radio link in + dB. CINR is a more accurate measure of radio link quality. Has no meaning + when the device is not connected. + --> + <property name="Cinr" type="i" access="read"/> + + <!-- + TxPower: + + Average power of the last burst transmitted by the device, in units of 0.5 + dBm. i.e. a TxPower of -11 represents an actual device TX power of -5.5 + dBm. Has no meaning when the device is not connected. + --> + <property name="TxPower" type="i" access="read"/> + + <!-- + Bsid: + + The ID of the serving base station as received from the network. Has no meaning when the device is not connected. - " /> - </property> - - <property name="TxPower" type="i" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Average power of the last burst transmitted by the device, in units of - 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of - -5.5 dBm. Has no meaning when the device is not connected. - " /> - </property> - - <property name="Bsid" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The ID of the serving base station as received from the network. Has - no meaning when the device is not connected. - " /> - </property> - - <property name="ActiveNsp" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Bsid" type="s" access="read"/> + + <!-- + ActiveNsp: + Object path of the NSP currently used by the WiMax device. - " /> - </property> + --> + <property name="ActiveNsp" type="o" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values. + + Emitted when the WiMax device's properties changed. + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when the WiMax device's properties changed. - " /> - </signal> + <arg name="properties" type="a{sv}"/> + </signal> + + <!-- + NspAdded: + @nsp: The object path of the newly found NSP. + Emitted when a new NSP is found by the device. + --> <signal name="NspAdded"> - <arg name="nsp" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the newly found NSP. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when a new NSP is found by the device. - " /> - </signal> + <arg name="nsp" type="o"/> + </signal> + + <!-- + NspRemoved: + @nsp: The object path of the NSP that has disappeared. + Emitted when an NSP disappears from view of the device. + --> <signal name="NspRemoved"> - <arg name="nsp" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the NSP that has disappeared. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when an NSP disappears from view of the device. - " /> + <arg name="nsp" type="o"/> </signal> - </interface> </node> diff --git a/introspection/nm-device.xml b/introspection/nm-device.xml index 321cace1..d4535a84 100644 --- a/introspection/nm-device.xml +++ b/introspection/nm-device.xml @@ -1,798 +1,321 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device"> - <property name="Udi" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Operating-system specific transient device hardware identifier. This - is an opaque string representing the underlying hardware for the device, - and shouldn't be used to keep track of individual devices. For some - device types (Bluetooth, Modems) it is an identifier used by the - hardware service (ie bluez or ModemManager) to refer to that device, - and client programs use it get additional information from those - services which NM does not provide. The Udi is not guaranteed to be - consistent across reboots or hotplugs of the hardware. If you're looking - for a way to uniquely track each device in your application, use the - object path. If you're looking for a way to track a specific piece of - hardware across reboot or hotplug, use a MAC address or USB serial - number. - " /> - </property> - <property name="Interface" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + + <!-- + Udi: + + Operating-system specific transient device hardware identifier. This is an + opaque string representing the underlying hardware for the device, and + shouldn't be used to keep track of individual devices. For some device + types (Bluetooth, Modems) it is an identifier used by the hardware service + (ie bluez or ModemManager) to refer to that device, and client programs + use it get additional information from those services which NM does not + provide. The Udi is not guaranteed to be consistent across reboots or + hotplugs of the hardware. If you're looking for a way to uniquely track + each device in your application, use the object path. If you're looking + for a way to track a specific piece of hardware across reboot or hotplug, + use a MAC address or USB serial number. + --> + <property name="Udi" type="s" access="read"/> + + <!-- + Interface: + The name of the device's control (and often data) interface. - " /> - </property> - <property name="IpInterface" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The name of the device's data interface when available. This property - may not refer to the actual data interface until the device has - successfully established a data connection, indicated by the device's - State becoming ACTIVATED. - " /> - </property> - <property name="Driver" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Interface" type="s" access="read"/> + + <!-- + IpInterface: + + The name of the device's data interface when available. This property may + not refer to the actual data interface until the device has successfully + established a data connection, indicated by the device's State becoming + ACTIVATED. + --> + <property name="IpInterface" type="s" access="read"/> + + <!-- + Driver: + The driver handling the device. - " /> - </property> - <property name="DriverVersion" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Driver" type="s" access="read"/> + + <!-- + DriverVersion: + The version of the driver handling the device. - " /> - </property> - <property name="FirmwareVersion" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="DriverVersion" type="s" access="read"/> + + <!-- + FirmwareVersion: + The firmware version for the device. - " /> - </property> - <property name="Capabilities" type="u" access="read" tp:type="NM_DEVICE_CAP"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="FirmwareVersion" type="s" access="read"/> + + <!-- + Capabilities: + Flags describing the capabilities of the device. - " /> - </property> - <property name="Ip4Address" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object instead. - " /> - </property> - <property name="State" type="u" access="read" tp:type="NM_DEVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" + + Returns: <link linkend="NMDeviceCapabilities">NMDeviceCapabilities</link> + --> + <property name="Capabilities" type="u" access="read"/> + + <!-- + Ip4Address: + + DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object + instead. + --> + <property name="Ip4Address" type="u" access="read"/> + + <!-- + State: + The current state of the device. - " /> - </property> - <property name="StateReason" type="(uu)" access="read" tp:type="NM_DEVICE_STATE_REASON_STRUCT"> - <annotation name="org.gtk.GDBus.DocString" value=" + + Returns: <link linkend="NMDeviceState">NMDeviceState</link> + --> + <property name="State" type="u" access="read"/> + + <!-- + StateReason: + The current state and reason for changing to that state. - " /> - </property> - <property name="ActiveConnection" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of an ActiveConnection object that "owns" this device during - activation. The ActiveConnection object tracks the life-cycle of a + + Returns: A tuple of <link linkend="NMDeviceState">NMDeviceState</link> and <link linkend="NMDeviceStateReason">NMDeviceStateReason</link>. + --> + <property name="StateReason" type="(uu)" access="read"/> + + <!-- + ActiveConnection: + + Object path of an ActiveConnection object that "owns" this device during + activation. The ActiveConnection object tracks the life-cycle of a connection to a specific network and implements the org.freedesktop.NetworkManager.Connection.Active D-Bus interface. - " /> - </property> - <property name="Ip4Config" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the Ip4Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state. - " /> - </property> - <property name="Dhcp4Config" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state. - " /> - </property> - <property name="Ip6Config" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the Ip6Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state. - " /> - </property> - <property name="Dhcp6Config" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the Dhcp6Config object describing the DHCP options - returned by the DHCP server. Only valid when the device is in the + --> + <property name="ActiveConnection" type="o" access="read"/> + + <!-- + Ip4Config: + + Object path of the Ip4Config object describing the configuration of the + device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED + state. + --> + <property name="Ip4Config" type="o" access="read"/> + + <!-- + Dhcp4Config: + + Object path of the Dhcp4Config object describing the DHCP options returned + by the DHCP server. Only valid when the device is in the + NM_DEVICE_STATE_ACTIVATED state. + --> + <property name="Dhcp4Config" type="o" access="read"/> + + <!-- + Ip6Config: + + Object path of the Ip6Config object describing the configuration of the + device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED + state. + --> + <property name="Ip6Config" type="o" access="read"/> + + <!-- + Dhcp6Config: + + Object path of the Dhcp6Config object describing the DHCP options returned + by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state. - " /> - </property> - <property name="Managed" type="b" access="readwrite"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Dhcp6Config" type="o" access="read"/> + + <!-- + Managed: + Whether or not this device is managed by NetworkManager. Setting this - property has a similar effect to configuring the device as unmanaged - via the keyfile.unmanaged-devices setting in NetworkManager.conf. - Changes to this value are not persistent and lost after NetworkManager - restart. - " /> - </property> - <property name="Autoconnect" type="b" access="readwrite"> - <annotation name="org.gtk.GDBus.DocString" value=" - If TRUE, indicates the device is allowed to autoconnect. If FALSE, - manual intervention is required before the device will automatically - connect to a known network, such as activating a connection using the - device, or setting this property to TRUE. This property cannot be - set to TRUE for default-unmanaged devices, since they never autoconnect. - " /> - </property> - <property name="FirmwareMissing" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - If TRUE, indicates the device is likely missing firmware necessary for - its operation. - " /> - </property> - <property name="NmPluginMissing" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + property has a similar effect to configuring the device as unmanaged via + the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to + this value are not persistent and lost after NetworkManager restart. + --> + <property name="Managed" type="b" access="readwrite"/> + + <!-- + Autoconnect: + + If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual + intervention is required before the device will automatically connect to a + known network, such as activating a connection using the device, or + setting this property to TRUE. This property cannot be set to TRUE for + default-unmanaged devices, since they never autoconnect. + --> + <property name="Autoconnect" type="b" access="readwrite"/> + + <!-- + FirmwareMissing: + + If TRUE, indicates the device is likely missing firmware necessary for its + operation. + --> + <property name="FirmwareMissing" type="b" access="read"/> + + <!-- + NmPluginMissing: + If TRUE, indicates the NetworkManager plugin for the device is likely missing or misconfigured. - " /> - </property> - <property name="DeviceType" type="u" access="read" tp:type="NM_DEVICE_TYPE"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="NmPluginMissing" type="b" access="read"/> + + <!-- + DeviceType: + The general type of the network device; ie Ethernet, WiFi, etc. - " /> - </property> - <property name="AvailableConnections" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - An array of object paths of every configured connection that is currently 'available' through this device. - " /> - </property> - <property name="PhysicalPortId" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - If non-empty, an (opaque) indicator of the physical network - port associated with the device. This can be used to recognize - when two seemingly-separate hardware devices are actually just - different virtual interfaces to the same physical port. - " /> - </property> - <property name="Mtu" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + + Returns: <link linkend="NMDeviceType">NMDeviceType</link> + --> + <property name="DeviceType" type="u" access="read"/> + + <!-- + AvailableConnections: + + An array of object paths of every configured connection that is currently + 'available' through this device. + --> + <property name="AvailableConnections" type="ao" access="read"/> + + <!-- + PhysicalPortId: + + If non-empty, an (opaque) indicator of the physical network port + associated with the device. This can be used to recognize when two + seemingly-separate hardware devices are actually just different virtual + interfaces to the same physical port. + --> + <property name="PhysicalPortId" type="s" access="read"/> + + <!-- + Mtu: + The device MTU (maximum transmission unit). - " /> - </property> - <property name="Metered" type="u" access="read" tp:type="NM_METERED"> - <annotation name="org.gtk.GDBus.DocString" value=" - Whether the amount of traffic flowing through the device is - subject to limitations, for example set by service providers. - " /> - </property> - <property name="LldpNeighbors" type="aa{sv}" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of LLDP neighbors; each element is a dictionary mapping - LLDP TLV names to variant boxed values. - " /> - </property> - <property name="Real" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - True if the device exists, or False for placeholder devices that - do not yet exist but could be automatically created by NetworkManager - if one of their AvailableConnections was activated. - " /> - </property> + --> + <property name="Mtu" type="u" access="read"/> + + <!-- + Metered: + + Whether the amount of traffic flowing through the device is subject to + limitations, for example set by service providers. + + Returns: <link linkend="NMMetered">NMMetered</link> + --> + <property name="Metered" type="u" access="read"/> + + <!-- + LldpNeighbors: + + Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV + names to variant boxed values. + --> + <property name="LldpNeighbors" type="aa{sv}" access="read"/> + + <!-- + Real: + True if the device exists, or False for placeholder devices that do not + yet exist but could be automatically created by NetworkManager if one of + their AvailableConnections was activated. + --> + <property name="Real" type="b" access="read"/> + + <!-- + Reapply: + @connection: The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarly differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses. + @version_id: If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply. + @flags: Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0. + + Attempts to update the configuration of a device without deactivating it. + NetworkManager has the concept of connections, which are profiles that + contain the configuration for a networking device. Those connections are + exposed via D-Bus as individual objects that can be created, modified and + deleted. When activating such a settings-connection on a device, the + settings-connection is cloned to become an applied-connection and used to + configure the device (see GetAppliedConnection). Subsequent modification + of the settings-connection don't propagate automatically to the device's + applied-connection (with exception of the firewall-zone and the metered + property). For the changes to take effect, you can either re-activate the + settings-connection, or call Reapply. The Reapply call allows you to + directly update the applied-connection and reconfigure the device. Reapply + can also be useful if the currently applied-connection is equal to the + connection that is about to be reapplied. This allows to reconfigure the + device and revert external changes like removing or adding an IP address + (which NetworkManager doesn't revert automatically because it is assumed + that the user made these changes intentionally outside of NetworkManager). + Reapply can make the applied-connection different from the + settings-connection, just like updating the settings-connection can make + them different. + --> <method name="Reapply"> - <arg name="connection" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The optional connection settings that will be reapplied on the device. If empty, the - currently active settings-connection will be used. The connection cannot arbitrarly - differ from the current applied-connection otherwise the call will fail. - Only certain changes are supported, like adding or removing IP addresses. - " /> - </arg> - <arg name="version_id" type="t" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - If non-zero, the current version id of the applied-connection must match. - The current version id can be retrieved via GetAppliedConnection. - This optional argument allows to catch concurrent modifications between - the GetAppliedConnection call and Reapply. - " /> - </arg> - <arg name="flags" type="u" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags which would modify the behavior of the Reapply call. - There are no flags defined currently and the users should use the value of 0. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Attempts to update the configuration of a device without deactivating it. NetworkManager - has the concept of connections, which are profiles that contain the configuration for - a networking device. Those connections are exposed via D-Bus as individual objects - that can be created, modified and deleted. When activating such a settings-connection - on a device, the settings-connection is cloned to become an applied-connection and used to - configure the device (see GetAppliedConnection). Subsequent modification of the - settings-connection don't propagate automatically to the device's applied-connection - (with exception of the firewall-zone and the metered property). For the changes to take - effect, you can either re-activate the settings-connection, or call Reapply. - The Reapply call allows you to directly update the applied-connection and reconfigure - the device. - Reapply can also be useful if the currently applied-connection is equal to the connection - that is about to be reapplied. This allows to reconfigure the device and revert external - changes like removing or adding an IP address (which NetworkManager doesn't revert - automatically because it is assumed that the user made these changes intentionally outside - of NetworkManager). - Reapply can make the applied-connection different from the settings-connection, - just like updating the settings-connection can make them different. - " /> - </method> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="version_id" type="t" direction="in"/> + <arg name="flags" type="u" direction="in"/> + </method> + <!-- + GetAppliedConnection: + @flags: Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0. + @connection: The effective connection settings that the connection has currently applied. + @version_id: The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail. + + Get the currently applied connection on the device. This is a snapshot of + the last activated connection on the device, that is the configuration + that is currently applied on the device. Usually this is the same as + GetSettings of the referenced settings connection. However, it can differ + if the settings connection was subsequently modified or the applied + connection was modified by Reapply. The applied connection is set when + activating a device or when calling Reapply. + --> <method name="GetAppliedConnection"> - <arg name="flags" type="u" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags which would modify the behavior of the GetAppliedConnection call. - There are no flags defined currently and the users should use the value of 0. - " /> - </arg> - <arg name="connection" type="a{sa{sv}}" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The effective connection settings that the connection has currently applied. - " /> - </arg> - <arg name="version_id" type="t" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The version-id of the currently applied connection. This can be specified during - Reapply to avoid races where you first fetch the applied connection, modify it - and try to reapply it. If the applied connection is modified in the meantime, the - version_id gets incremented and Reapply will fail. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Get the currently applied connection on the device. This is a snapshot of the last activated - connection on the device, that is the configuration that is currently applied on the device. - Usually this is the same as GetSettings of the referenced settings connection. However, it - can differ if the settings connection was subsequently modified or the applied connection was - modified by Reapply. The applied connection is set when activating a device or when calling - Reapply. - " /> - </method> - - <method name="Disconnect"> - <annotation name="org.gtk.GDBus.DocString" value=" - Disconnects a device and prevents the device from automatically activating further connections without user intervention. - " /> - </method> - - <method name="Delete"> - <annotation name="org.gtk.GDBus.DocString" value=" - Deletes a software device from NetworkManager and removes the interface from the system. - The method returns an error when called for a hardware device. - " /> - </method> + <arg name="flags" type="u" direction="in"/> + <arg name="connection" type="a{sa{sv}}" direction="out"/> + <arg name="version_id" type="t" direction="out"/> + </method> + + <!-- + Disconnect: + Disconnects a device and prevents the device from automatically activating + further connections without user intervention. + --> + <method name="Disconnect"/> + + <!-- + Delete: + + Deletes a software device from NetworkManager and removes the interface + from the system. The method returns an error when called for a hardware + device. + --> + <method name="Delete"/> + + <!-- + StateChanged: + @new_state: (<link linkend="NMDeviceState">NMDeviceState</link>) The new state of the device. + @old_state: (<link linkend="NMDeviceState">NMDeviceState</link>) The previous state of the device. + @reason: (<link linkend="NMDeviceStateReason">NMDeviceStateReason</link>) A reason for the state transition. + --> <signal name="StateChanged"> - <arg name="new_state" type="u" tp:type="NM_DEVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The new state of the device. - " /> - </arg> - <arg name="old_state" type="u" tp:type="NM_DEVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The previous state of the device. - " /> - </arg> - <arg name="reason" type="u" tp:type="NM_DEVICE_STATE_REASON"> - <annotation name="org.gtk.GDBus.DocString" value=" - A reason for the state transition. - " /> - </arg> + <arg name="new_state" type="u"/> + <arg name="old_state" type="u"/> + <arg name="reason" type="u"/> </signal> - - <tp:enum name="NM_DEVICE_STATE" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is in an unknown state. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="UNMANAGED" value="10"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is recognized but not managed by NetworkManager. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="UNAVAILABLE" value="20"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device cannot be used (carrier off, rfkill, etc). - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DISCONNECTED" value="30"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is not connected. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PREPARE" value="40"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is preparing to connect. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONFIG" value="50"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is being configured. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NEED_AUTH" value="60"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is awaiting secrets necessary to continue connection. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="IP_CONFIG" value="70"> - <annotation name="org.gtk.GDBus.DocString" value=" - The IP settings of the device are being requested and configured. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="IP_CHECK" value="80"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's IP connectivity ability is being determined. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SECONDARIES" value="90"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is waiting for secondary connections to be activated. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ACTIVATED" value="100"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is active. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DEACTIVATING" value="110"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's network connection is being torn down. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="FAILED" value="120"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is in a failure state following an attempt to activate it. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:enum name="NM_DEVICE_TYPE" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device type is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ETHERNET" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is wired Ethernet device. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="WIFI" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an 802.11 WiFi device. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="UNUSED1" value="3"> - <annotation name="org.gtk.GDBus.DocString" value="Unused" /> - </tp:enumvalue> - <tp:enumvalue suffix="UNUSED2" value="4"> - <annotation name="org.gtk.GDBus.DocString" value="Unused" /> - </tp:enumvalue> - <tp:enumvalue suffix="BT" value="5"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is Bluetooth device that provides PAN or DUN capabilities. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="OLPC_MESH" value="6"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an OLPC mesh networking device. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="WIMAX" value="7"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an 802.16e Mobile WiMAX device. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM" value="8"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a modem supporting one or more of analog telephone, - CDMA/EVDO, GSM/UMTS/HSPA, or LTE standards to access a cellular or - wireline data network. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="INFINIBAND" value="9"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an IP-capable InfiniBand interface. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="BOND" value="10"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a bond master interface. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="VLAN" value="11"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a VLAN interface. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ADSL" value="12"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an ADSL device supporting PPPoE and PPPoATM protocols. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="BRIDGE" value="13"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a bridge interface. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GENERIC" value="14"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a generic interface type unrecognized by NetworkManager. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="TEAM" value="15"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a team master interface. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:flags name="NM_DEVICE_CAP" value-prefix="NM_DEVICE_CAP" type="u"> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Null capability." /> - </tp:flag> - <tp:flag suffix="NM_SUPPORTED" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value="The device is supported by NetworkManager." /> - </tp:flag> - <tp:flag suffix="CARRIER_DETECT" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports carrier detection." /> - </tp:flag> - </tp:flags> - - <tp:enum name="NM_DEVICE_STATE_REASON" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The reason for the device state change is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NONE" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The state change is normal. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NOW_MANAGED" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is now managed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NOW_UNMANAGED" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is no longer managed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONFIG_FAILED" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device could not be readied for configuration. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONFIG_UNAVAILABLE" value="5"> - <annotation name="org.gtk.GDBus.DocString" value=" - IP configuration could not be reserved (no available address, timeout, etc). - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONFIG_EXPIRED" value="6"> - <annotation name="org.gtk.GDBus.DocString" value=" - The IP configuration is no longer valid. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NO_SECRETS" value="7"> - <annotation name="org.gtk.GDBus.DocString" value=" - Secrets were required, but not provided. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SUPPLICANT_DISCONNECT" value="8"> - <annotation name="org.gtk.GDBus.DocString" value=" - The 802.1X supplicant disconnected from the access point or authentication server. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SUPPLICANT_CONFIG_FAILED" value="9"> - <annotation name="org.gtk.GDBus.DocString" value=" - Configuration of the 802.1X supplicant failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SUPPLICANT_FAILED" value="10"> - <annotation name="org.gtk.GDBus.DocString" value=" - The 802.1X supplicant quit or failed unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SUPPLICANT_TIMEOUT" value="11"> - <annotation name="org.gtk.GDBus.DocString" value=" - The 802.1X supplicant took too long to authenticate. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PPP_START_FAILED" value="12"> - <annotation name="org.gtk.GDBus.DocString" value=" - The PPP service failed to start within the allowed time. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PPP_DISCONNECT" value="13"> - <annotation name="org.gtk.GDBus.DocString" value=" - The PPP service disconnected unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PPP_FAILED" value="14"> - <annotation name="org.gtk.GDBus.DocString" value=" - The PPP service quit or failed unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DHCP_START_FAILED" value="15"> - <annotation name="org.gtk.GDBus.DocString" value=" - The DHCP service failed to start within the allowed time. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DHCP_ERROR" value="16"> - <annotation name="org.gtk.GDBus.DocString" value=" - The DHCP service reported an unexpected error. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DHCP_FAILED" value="17"> - <annotation name="org.gtk.GDBus.DocString" value=" - The DHCP service quit or failed unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SHARED_START_FAILED" value="18"> - <annotation name="org.gtk.GDBus.DocString" value=" - The shared connection service failed to start. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SHARED_FAILED" value="19"> - <annotation name="org.gtk.GDBus.DocString" value=" - The shared connection service quit or failed unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="AUTOIP_START_FAILED" value="20"> - <annotation name="org.gtk.GDBus.DocString" value=" - The AutoIP service failed to start. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="AUTOIP_ERROR" value="21"> - <annotation name="org.gtk.GDBus.DocString" value=" - The AutoIP service reported an unexpected error. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="AUTOIP_FAILED" value="22"> - <annotation name="org.gtk.GDBus.DocString" value=" - The AutoIP service quit or failed unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_BUSY" value="23"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dialing failed because the line was busy. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_NO_DIAL_TONE" value="24"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dialing failed because there was no dial tone. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_NO_CARRIER" value="25"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dialing failed because there was carrier. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_DIAL_TIMEOUT" value="26"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dialing timed out. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_DIAL_FAILED" value="27"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dialing failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_INIT_FAILED" value="28"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem initialization failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_APN_FAILED" value="29"> - <annotation name="org.gtk.GDBus.DocString" value=" - Failed to select the specified GSM APN. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_REGISTRATION_NOT_SEARCHING" value="30"> - <annotation name="org.gtk.GDBus.DocString" value=" - Not searching for networks. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_REGISTRATION_DENIED" value="31"> - <annotation name="org.gtk.GDBus.DocString" value=" - Network registration was denied. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_REGISTRATION_TIMEOUT" value="32"> - <annotation name="org.gtk.GDBus.DocString" value=" - Network registration timed out. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_REGISTRATION_FAILED" value="33"> - <annotation name="org.gtk.GDBus.DocString" value=" - Failed to register with the requested GSM network. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_PIN_CHECK_FAILED" value="34"> - <annotation name="org.gtk.GDBus.DocString" value=" - PIN check failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="FIRMWARE_MISSING" value="35"> - <annotation name="org.gtk.GDBus.DocString" value=" - Necessary firmware for the device may be missing. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="REMOVED" value="36"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device was removed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SLEEPING" value="37"> - <annotation name="org.gtk.GDBus.DocString" value=" - NetworkManager went to sleep. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTION_REMOVED" value="38"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's active connection was removed or disappeared. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="USER_REQUESTED" value="39"> - <annotation name="org.gtk.GDBus.DocString" value=" - A user or client requested the disconnection. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CARRIER" value="40"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's carrier/link changed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTION_ASSUMED" value="41"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's existing connection was assumed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SUPPLICANT_AVAILABLE" value="42"> - <annotation name="org.gtk.GDBus.DocString" value=" - The 802.1x supplicant is now available. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_NOT_FOUND" value="43"> - <annotation name="org.gtk.GDBus.DocString" value=" - The modem could not be found. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="BT_FAILED" value="44"> - <annotation name="org.gtk.GDBus.DocString" value=" - The Bluetooth connection timed out or failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_SIM_NOT_INSERTED" value="45"> - <annotation name="org.gtk.GDBus.DocString" value=" - GSM Modem's SIM Card not inserted. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_SIM_PIN_REQUIRED" value="46"> - <annotation name="org.gtk.GDBus.DocString" value=" - GSM Modem's SIM Pin required. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_SIM_PUK_REQUIRED" value="47"> - <annotation name="org.gtk.GDBus.DocString" value=" - GSM Modem's SIM Puk required. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_SIM_WRONG" value="48"> - <annotation name="org.gtk.GDBus.DocString" value=" - GSM Modem's SIM wrong - " /> - </tp:enumvalue> - <tp:enumvalue suffix="INFINIBAND_MODE" value="49"> - <annotation name="org.gtk.GDBus.DocString" value=" - InfiniBand device does not support connected mode. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DEPENDENCY_FAILED" value="50"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dependency of the connection failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="BR2684_FAILED" value="51"> - <annotation name="org.gtk.GDBus.DocString" value=" - Problem with the RFC 2684 Ethernet over ADSL bridge. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_MANAGER_UNAVAILABLE" value="52"> - <annotation name="org.gtk.GDBus.DocString" value=" - ModemManager was not running or quit unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SSID_NOT_FOUND" value="53"> - <annotation name="org.gtk.GDBus.DocString" value=" - The 802.11 Wi-Fi network could not be found. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SECONDARY_CONNECTION_FAILED" value="54"> - <annotation name="org.gtk.GDBus.DocString" value=" - A secondary connection of the base connection failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DCB_FCOE_FAILED" value="55"> - <annotation name="org.gtk.GDBus.DocString" value=" - DCB or FCoE setup failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="TEAMD_CONTROL_FAILED" value="56"> - <annotation name="org.gtk.GDBus.DocString" value=" - teamd control failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_FAILED" value="57"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem failed or no longer available. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_AVAILABLE" value="58"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem now ready and available. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SIM_PIN_INCORRECT" value="59"> - <annotation name="org.gtk.GDBus.DocString" value=" - The SIM PIN was incorrect. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NEW_ACTIVATION" value="60"> - <annotation name="org.gtk.GDBus.DocString" value=" - A new connection activation was enqueued. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PARENT_CHANGED" value="61"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's parent changed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PARENT_MANAGED_CHANGED" value="62"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device parent's management changed. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:enum name="NM_METERED" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device metered status is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="YES" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is metered and the value was statically set. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NO" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is not metered and the value was statically set. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GUESS_YES" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is metered and the value was guessed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GUESS_NO" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is not metered and the value was guessed. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:struct name="NM_DEVICE_STATE_REASON_STRUCT"> - <tp:member type="u" name="state" tp:type="NM_DEVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device state. - " /> - </tp:member> - <tp:member type="u" name="reason" tp:type="NM_DEVICE_STATE_REASON"> - <annotation name="org.gtk.GDBus.DocString" value=" - The reason for originally changing to the device state. - " /> - </tp:member> - </tp:struct> </interface> </node> diff --git a/introspection/nm-dhcp4-config.xml b/introspection/nm-dhcp4-config.xml index bca34fc5..e9363f9e 100644 --- a/introspection/nm-dhcp4-config.xml +++ b/introspection/nm-dhcp4-config.xml @@ -1,21 +1,27 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - <interface name="org.freedesktop.NetworkManager.DHCP4Config"> - <annotation name="org.gtk.GDBus.C.Name" value="Dhcp4Config"/> - <annotation name="org.gtk.GDBus.DocString" value=" - Options and configuration returned by the IPv4 DHCP server. - " /> - <property name="Options" type="a{sv}" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="Configuration options returned by a DHCP server, if any." /> - </property> + <!-- + org.freedesktop.NetworkManager.DHCP4Config: - <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> - </signal> - </interface> + Options and configuration returned by the IPv4 DHCP server. + --> + <interface name="org.freedesktop.NetworkManager.DHCP4Config"> + <annotation name="org.gtk.GDBus.C.Name" value="Dhcp4Config"/> + + <!-- + Options: + + Configuration options returned by a DHCP server, if any. + --> + <property name="Options" type="a{sv}" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> + </signal> + </interface> </node> diff --git a/introspection/nm-dhcp6-config.xml b/introspection/nm-dhcp6-config.xml index 84e13b77..7ecdf35c 100644 --- a/introspection/nm-dhcp6-config.xml +++ b/introspection/nm-dhcp6-config.xml @@ -1,21 +1,27 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - <interface name="org.freedesktop.NetworkManager.DHCP6Config"> - <annotation name="org.gtk.GDBus.C.Name" value="Dhcp6Config"/> - <annotation name="org.gtk.GDBus.DocString" value=" - Options and configuration returned by the IPv6 DHCP server. - " /> - <property name="Options" type="a{sv}" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="Configuration options returned by a DHCP server, if any." /> - </property> + <!-- + org.freedesktop.NetworkManager.DHCP6Config: - <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> - </signal> - </interface> + Options and configuration returned by the IPv6 DHCP server. + --> + <interface name="org.freedesktop.NetworkManager.DHCP6Config"> + <annotation name="org.gtk.GDBus.C.Name" value="Dhcp6Config"/> + + <!-- + Options: + + Configuration options returned by a DHCP server, if any. + --> + <property name="Options" type="a{sv}" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> + </signal> + </interface> </node> diff --git a/introspection/nm-ip4-config.xml b/introspection/nm-ip4-config.xml index 111e1acf..c2a0f068 100644 --- a/introspection/nm-ip4-config.xml +++ b/introspection/nm-ip4-config.xml @@ -1,72 +1,95 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.IP4Config"> - <property name="Addresses" type="aau" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of arrays of IPv4 address/prefix/gateway. All 3 - elements of each array are in network byte order. Essentially: - [(addr, prefix, gateway), (addr, prefix, gateway), ...] - - Deprecated: use AddressData and Gateway - " /> - </property> - <property name="AddressData" type="aa{sv}" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of IP address data objects. All addresses will include - "address" (an IP address string), and "prefix" (a uint). Some - addresses may include additional attributes. - " /> - </property> - <property name="Gateway" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The gateway in use." /> - </property> - <property name="Routes" type="aau" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of - each tuple are in network byte order. 'route' and 'next hop' - are IPv4 addresses, while prefix and metric are simple - unsigned integers. Essentially: [(route, prefix, next-hop, - metric), (route, prefix, next-hop, metric), ...] - - Deprecated: use RouteData - " /> - </property> - <property name="RouteData" type="aa{sv}" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of IP route data objects. All routes will include "dest" - (an IP address string) and "prefix" (a uint). Some routes may - include "next-hop" (an IP address string), "metric" (a uint), - and additional attributes. - " /> - </property> - <property name="Nameservers" type="au" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The nameservers in use." /> - </property> - <property name="Domains" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="A list of domains this address belongs to." /> - </property> - <property name="Searches" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="A list of dns searches." /> - </property> - <property name="DnsOptions" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - A list of DNS options that modify the behavior of the DNS - resolver. See resolv.conf(5) manual page for the list of - supported options. - " /> - </property> - <property name="WinsServers" type="au" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The Windows Internet Name Service servers associated with the connection. Each address is in network byte order." /> - </property> + <!-- + Addresses: + + Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each + array are in network byte order. Essentially: [(addr, prefix, gateway), + (addr, prefix, gateway), ...] Deprecated: use AddressData and Gateway + --> + <property name="Addresses" type="aau" access="read"/> + + <!-- + AddressData: + + Array of IP address data objects. All addresses will include "address" (an + IP address string), and "prefix" (a uint). Some addresses may include + additional attributes. + --> + <property name="AddressData" type="aa{sv}" access="read"/> + + <!-- + Gateway: + + The gateway in use. + --> + <property name="Gateway" type="s" access="read"/> + + <!-- + Routes: + + Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of each tuple + are in network byte order. 'route' and 'next hop' are IPv4 addresses, + while prefix and metric are simple unsigned integers. Essentially: + [(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), + ...] Deprecated: use RouteData + --> + <property name="Routes" type="aau" access="read"/> + + <!-- + RouteData: + + Array of IP route data objects. All routes will include "dest" (an IP + address string) and "prefix" (a uint). Some routes may include "next-hop" + (an IP address string), "metric" (a uint), and additional attributes. + --> + <property name="RouteData" type="aa{sv}" access="read"/> + + <!-- + Nameservers: + + The nameservers in use. + --> + <property name="Nameservers" type="au" access="read"/> + + <!-- + Domains: + + A list of domains this address belongs to. + --> + <property name="Domains" type="as" access="read"/> + + <!-- + Searches: + + A list of dns searches. + --> + <property name="Searches" type="as" access="read"/> + + <!-- + DnsOptions: + + A list of DNS options that modify the behavior of the DNS resolver. See + resolv.conf(5) manual page for the list of supported options. + --> + <property name="DnsOptions" type="as" access="read"/> + + <!-- + WinsServers: + + The Windows Internet Name Service servers associated with the connection. + Each address is in network byte order. + --> + <property name="WinsServers" type="au" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> </interface> </node> - diff --git a/introspection/nm-ip6-config.xml b/introspection/nm-ip6-config.xml index 0cca33c4..606761dd 100644 --- a/introspection/nm-ip6-config.xml +++ b/introspection/nm-ip6-config.xml @@ -1,67 +1,87 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.IP6Config"> - <property name="Addresses" type="a(ayuay)" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of tuples of IPv6 address/prefix/gateway. - - Deprecated: use AddressData and Gateway. - " /> - </property> - <property name="AddressData" type="aa{sv}" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of IP address data objects. All addresses will include - "address" (an IP address string), and "prefix" (a uint). Some - addresses may include additional attributes. - " /> - </property> - <property name="Gateway" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The gateway in use." /> - </property> - <property name="Routes" type="a(ayuayu)" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Tuples of IPv6 route/prefix/next-hop/metric. - - Deprecated: use RouteData - " /> - </property> - <property name="RouteData" type="aa{sv}" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of IP route data objects. All routes will include "dest" - (an IP address string) and "prefix" (a uint). Some routes may - include "next-hop" (an IP address string), "metric" (a uint), - and additional attributes. - " /> - </property> + + <!-- + Addresses: + + Array of tuples of IPv6 address/prefix/gateway. Deprecated: use + AddressData and Gateway. + --> + <property name="Addresses" type="a(ayuay)" access="read"/> + + <!-- + AddressData: + + Array of IP address data objects. All addresses will include "address" (an + IP address string), and "prefix" (a uint). Some addresses may include + additional attributes. + --> + <property name="AddressData" type="aa{sv}" access="read"/> + + <!-- + Gateway: + + The gateway in use. + --> + <property name="Gateway" type="s" access="read"/> + + <!-- + Routes: + + Tuples of IPv6 route/prefix/next-hop/metric. Deprecated: use RouteData + --> + <property name="Routes" type="a(ayuayu)" access="read"/> + + <!-- + RouteData: + + Array of IP route data objects. All routes will include "dest" (an IP + address string) and "prefix" (a uint). Some routes may include "next-hop" + (an IP address string), "metric" (a uint), and additional attributes. + --> + <property name="RouteData" type="aa{sv}" access="read"/> + + <!-- + Nameservers: + + The nameservers in use. + --> <property name="Nameservers" type="aay" access="read"> <!-- gdbus-codegen assumes that "aay" means "array of non-UTF-8 string" and so would make this a char **. --> <annotation name="org.gtk.GDBus.C.ForceGVariant" value="1"/> - <annotation name="org.gtk.GDBus.DocString" value="The nameservers in use." /> - </property> - <property name="Domains" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="A list of domains this address belongs to." /> - </property> - <property name="Searches" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="A list of dns searches." /> - </property> - <property name="DnsOptions" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - A list of DNS options that modify the behavior of the DNS - resolver. See resolv.conf(5) manual page for the list of - supported options. - " /> - </property> + </property> + + <!-- + Domains: + + A list of domains this address belongs to. + --> + <property name="Domains" type="as" access="read"/> + <!-- + Searches: + + A list of dns searches. + --> + <property name="Searches" type="as" access="read"/> + + <!-- + DnsOptions: + + A list of DNS options that modify the behavior of the DNS resolver. See + resolv.conf(5) manual page for the list of supported options. + --> + <property name="DnsOptions" type="as" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> </interface> </node> - diff --git a/introspection/nm-manager.xml b/introspection/nm-manager.xml index 8203020b..e5cb23a5 100644 --- a/introspection/nm-manager.xml +++ b/introspection/nm-manager.xml @@ -1,533 +1,385 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/org/freedesktop/NetworkManager" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/org/freedesktop/NetworkManager"> <interface name="org.freedesktop.NetworkManager"> <annotation name="org.gtk.GDBus.C.Name" value="Manager"/> - <method name="GetDevices"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetDevices: + @devices: List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()). + Get the list of realized network devices. - " /> - <arg name="devices" type="ao" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - List of object paths of network devices known to the system. This - list does not include device placeholders (see GetAllDevices()). - " /> - </arg> + --> + <method name="GetDevices"> + <arg name="devices" type="ao" direction="out"/> </method> - <method name="GetAllDevices"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetAllDevices: + @devices: List of object paths of network devices and device placeholders (eg, devices that do not yet exist but which can be automatically created by NetworkManager if one of their AvailableConnections was activated). + Get the list of all network devices. - " /> + --> + <method name="GetAllDevices"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_get_all_devices"/> - <arg name="devices" type="ao" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - List of object paths of network devices and device placeholders - (eg, devices that do not yet exist but which can be automatically - created by NetworkManager if one of their AvailableConnections - was activated). - " /> - </arg> + <arg name="devices" type="ao" direction="out"/> </method> - <method name="GetDeviceByIpIface"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetDeviceByIpIface: + @iface: Interface name of the device to find. + @device: Object path of the network device. + Return the object path of the network device referenced by its IP - interface name. Note that some devices (usually modems) only have an - IP interface name when they are connected. - " /> - <arg name="iface" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Interface name of the device to find. - " /> - </arg> - <arg name="device" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the network device. - " /> - </arg> + interface name. Note that some devices (usually modems) only have an IP + interface name when they are connected. + --> + <method name="GetDeviceByIpIface"> + <arg name="iface" type="s" direction="in"/> + <arg name="device" type="o" direction="out"/> </method> - <method name="ActivateConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + ActivateConnection: + @connection: The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path. + @device: The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use. + @specific_object: The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device. + @active_connection: The path of the active connection object representing this active connection. + Activate a connection using the supplied device. - " /> - <arg name="connection" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection to activate. If "/" is given, a valid device path must - be given, and NetworkManager picks the best connection to activate for - the given device. VPN connections must always pass a valid connection - path. - " /> - </arg> - <arg name="device" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of device to be activated for physical connections. - This parameter is ignored for VPN connections, because the - specific_object (if provided) specifies the device to use. - " /> - </arg> - <arg name="specific_object" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The path of a connection-type-specific object this activation should use. - This parameter is currently ignored for wired and mobile broadband connections, - and the value of "/" should be used (ie, no specific object). For WiFi - connections, pass the object path of a specific AP from the card's scan - list, or "/" to pick an AP automatically. For VPN connections, pass - the object path of an ActiveConnection object that should serve as the - "base" connection (to which the VPN connections lifetime will be tied), - or pass "/" and NM will automatically use the current default device. - " /> - </arg> - <arg name="active_connection" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The path of the active connection object representing this active connection. - " /> - </arg> + --> + <method name="ActivateConnection"> + <arg name="connection" type="o" direction="in"/> + <arg name="device" type="o" direction="in"/> + <arg name="specific_object" type="o" direction="in"/> + <arg name="active_connection" type="o" direction="out"/> </method> - <method name="AddAndActivateConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + AddAndActivateConnection: + @connection: Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object. + @device: The object path of device to be activated using the given connection. + @specific_object: The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection. + @path: Object path of the new connection that was just added. + @active_connection: The path of the active connection object representing this active connection. + Adds a new connection using the given details (if any) as a template (automatically filling in missing settings with the capabilities of the given device and specific object), then activate the new connection. Cannot be used for VPN connections at this time. - " /> - <arg name="connection" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Connection settings and properties; if incomplete missing settings will - be automatically completed using the given device and specific object. - " /> - </arg> - <arg name="device" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of device to be activated using the given connection. - " /> - </arg> - <arg name="specific_object" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The path of a connection-type-specific object this activation should use. - This parameter is currently ignored for wired and mobile broadband connections, - and the value of "/" should be used (ie, no specific object). For WiFi - connections, pass the object path of a specific AP from the card's scan - list, which will be used to complete the details of the newly added - connection. - " /> - </arg> - <arg name="path" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the new connection that was just added. - " /> - </arg> - <arg name="active_connection" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The path of the active connection object representing this active connection. - " /> - </arg> + --> + <method name="AddAndActivateConnection"> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="device" type="o" direction="in"/> + <arg name="specific_object" type="o" direction="in"/> + <arg name="path" type="o" direction="out"/> + <arg name="active_connection" type="o" direction="out"/> </method> - <method name="DeactivateConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + DeactivateConnection: + @active_connection: The currently active connection to deactivate. + Deactivate an active connection. - " /> - <arg name="active_connection" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The currently active connection to deactivate. - " /> - </arg> + --> + <method name="DeactivateConnection"> + <arg name="active_connection" type="o" direction="in"/> </method> + <!-- + Sleep: + @sleep: Indicates whether the NetworkManager daemon should sleep or wake. + + Control the NetworkManager daemon's sleep state. When asleep, all + interfaces that it manages are deactivated. When awake, devices are + available to be activated. This command should not be called directly by + users or clients; it is intended for system suspend/resume tracking. + --> <method name="Sleep"> - <annotation name="org.gtk.GDBus.DocString" value=" - Control the NetworkManager daemon's sleep state. When asleep, all - interfaces that it manages are deactivated. When awake, devices are - available to be activated. This command should not be called directly - by users or clients; it is intended for system suspend/resume tracking. - " /> - <arg name="sleep" type="b" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the NetworkManager daemon should sleep or wake. - " /> - </arg> + <arg name="sleep" type="b" direction="in"/> </method> + <!-- + Enable: + @enable: If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices. + + Control whether overall networking is enabled or disabled. When disabled, + all interfaces that NM manages are deactivated. When enabled, all managed + interfaces are re-enabled and available to be activated. This command + should be used by clients that provide to users the ability to + enable/disable all networking. + --> <method name="Enable"> - <annotation name="org.gtk.GDBus.DocString" value=" - Control whether overall networking is enabled or disabled. When - disabled, all interfaces that NM manages are deactivated. When enabled, - all managed interfaces are re-enabled and available to be activated. - This command should be used by clients that provide to users the ability - to enable/disable all networking. - " /> - <arg name="enable" type="b" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - If FALSE, indicates that all networking should be disabled. If TRUE, - indicates that NetworkManager should begin managing network devices. - " /> - </arg> + <arg name="enable" type="b" direction="in"/> </method> - <method name="GetPermissions"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetPermissions: + @permissions: Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations. + Returns the permissions a caller has for various authenticated operations that NetworkManager provides, like Enable/Disable networking, changing WiFi, WWAN, and WiMAX state, etc. - " /> - <arg name="permissions" type="a{ss}" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dictionary of available permissions and results. Each permission - is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") - and each result is one of the following values: "yes" (the permission - is available), "auth" (the permission is available after a successful - authentication), or "no" (the permission is denied). Clients may use - these values in the UI to indicate the ability to perform certain - operations. - " /> - </arg> + --> + <method name="GetPermissions"> + <arg name="permissions" type="a{ss}" direction="out"/> </method> - <signal name="CheckPermissions"> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when system authorization details change, indicating that - clients may wish to recheck permissions with GetPermissions. - " /> - </signal> + <!-- + CheckPermissions: + + Emitted when system authorization details change, indicating that clients + may wish to recheck permissions with GetPermissions. + --> + <signal name="CheckPermissions"/> + + <!-- + SetLogging: + @level: One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain. + @domains: A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, 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, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged. - <method name="SetLogging"> - <annotation name="org.gtk.GDBus.DocString" value=" Set logging verbosity and which operations are logged. - " /> - <arg name="level" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. - This level is applied to the domains as specified in the domains - argument. Except for the special level "KEEP", all unmentioned - domains are disabled entirely. "KEEP" is special and allows - not to change the current setting except for the specified - domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only - touch the platform domain. - " /> - </arg> - <arg name="domains" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - A combination of logging domains separated by commas (','), or "NONE" - to disable logging. Each domain enables logging for operations - related to that domain. Available domains are: [PLATFORM, 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, DBUS_PROPS, - TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. - In addition to these domains, the following special domains can be used: - [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains - should log at a different level from the default by appending a colon (':') - and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the - log level is changed but the current set of log domains remains - unchanged. - " /> - </arg> + --> + <method name="SetLogging"> + <arg name="level" type="s" direction="in"/> + <arg name="domains" type="s" direction="in"/> </method> - <method name="GetLogging"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetLogging: + @level: One of [ERR, WARN, INFO, DEBUG, TRACE]. + @domains: For available domains see SetLogging() call. + Get current logging verbosity level and operations domains. - " /> - <arg name="level" type="s" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - One of [ERR, WARN, INFO, DEBUG, TRACE]. - " /> - </arg> - <arg name="domains" type="s" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - For available domains see SetLogging() call. - " /> - </arg> + --> + <method name="GetLogging"> + <arg name="level" type="s" direction="out"/> + <arg name="domains" type="s" direction="out"/> </method> + <!-- + CheckConnectivity: + @connectivity: (<link linkend="NMConnectivityState">NMConnectivityState</link>) The current connectivity state. + + Re-check the network connectivity state. + --> <method name="CheckConnectivity"> - <annotation name="org.gtk.GDBus.DocString" value=" - Re-check the network connectivity state. - " /> - <arg name="connectivity" type="u" tp:type="NM_CONNECTIVITY" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The current connectivity state. - " /> - </arg> + <arg name="connectivity" type="u" direction="out"/> </method> - <method name="state"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + state: + @state: <link linkend="NMState">NMState</link> + The overall networking state as determined by the NetworkManager daemon, based on the state of network devices under it's management. - " /> - <arg name="state" type="u" direction="out" tp:type="NM_STATE"/> + --> + <method name="state"> + <arg name="state" type="u" direction="out"/> </method> - <property name="Devices" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Devices: + The list of realized network devices. Realized devices are those which have backing resources (eg from the kernel or a management daemon like ModemManager, teamd, etc). - " /> - </property> + --> + <property name="Devices" type="ao" access="read"/> + + <!-- + AllDevices: - <property name="AllDevices" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The list of both realized and un-realized network devices. Un-realized - devices are software devices which do not yet have backing resources, - but for which backing resources can be created if the device is - activated. - " /> - </property> - - <property name="NetworkingEnabled" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates if overall networking is currently enabled or not. See the + devices are software devices which do not yet have backing resources, but + for which backing resources can be created if the device is activated. + --> + <property name="AllDevices" type="ao" access="read"/> + + <!-- + NetworkingEnabled: + + Indicates if overall networking is currently enabled or not. See the Enable() method. - " /> - </property> + --> + <property name="NetworkingEnabled" type="b" access="read"/> + + <!-- + WirelessEnabled: - <property name="WirelessEnabled" type="b" access="readwrite"> - <annotation name="org.gtk.GDBus.DocString" value=" Indicates if wireless is currently enabled or not. - " /> - </property> + --> + <property name="WirelessEnabled" type="b" access="readwrite"/> + + <!-- + WirelessHardwareEnabled: + + Indicates if the wireless hardware is currently enabled, i.e. the state of + the RF kill switch. + --> + <property name="WirelessHardwareEnabled" type="b" access="read"/> - <property name="WirelessHardwareEnabled" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch. - " /> - </property> + <!-- + WwanEnabled: - <property name="WwanEnabled" type="b" access="readwrite"> - <annotation name="org.gtk.GDBus.DocString" value=" Indicates if mobile broadband devices are currently enabled or not. - " /> - </property> + --> + <property name="WwanEnabled" type="b" access="readwrite"/> + + <!-- + WwanHardwareEnabled: + + Indicates if the mobile broadband hardware is currently enabled, i.e. the + state of the RF kill switch. + --> + <property name="WwanHardwareEnabled" type="b" access="read"/> - <property name="WwanHardwareEnabled" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates if the mobile broadband hardware is currently enabled, i.e. the state of the RF kill switch. - " /> - </property> + <!-- + WimaxEnabled: - <property name="WimaxEnabled" type="b" access="readwrite"> - <annotation name="org.gtk.GDBus.DocString" value=" Indicates if WiMAX devices are currently enabled or not. - " /> - </property> + --> + <property name="WimaxEnabled" type="b" access="readwrite"/> - <property name="WimaxHardwareEnabled" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates if the WiMAX hardware is currently enabled, i.e. the state of the RF kill switch. - " /> - </property> + <!-- + WimaxHardwareEnabled: + + Indicates if the WiMAX hardware is currently enabled, i.e. the state of + the RF kill switch. + --> + <property name="WimaxHardwareEnabled" type="b" access="read"/> + + <!-- + ActiveConnections: - <property name="ActiveConnections" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" List of active connection object paths. - " /> - </property> - - <property name="PrimaryConnection" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the "primary" active connection being used - to access the network. In particular, if there is no VPN - active, or the VPN does not have the default route, then this - indicates the connection that has the default route. If there - is a VPN active with the default route, then this indicates - the connection that contains the route to the VPN endpoint. - " /> - </property> - - <property name="PrimaryConnectionType" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection type of the "primary" active connection being - used to access the network. This is the same as the Type - property on the object indicated by PrimaryConnection. - " /> - </property> - - <property name="Metered" type="u" access="read" tp:type="NM_METERED"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the connectivity is metered. This is equivalent - to the metered property of the device associated with the primary - connection. - " /> - </property> - - <property name="ActivatingConnection" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of an active connection that is currently - being activated and which is expected to become the new - PrimaryConnection when it finishes activating. - " /> - </property> - - <property name="Startup" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether NM is still starting up; this becomes FALSE - when NM has finished attempting to activate every connection - that it might be able to activate at startup. - " /> - </property> - - <property name="Version" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="ActiveConnections" type="ao" access="read"/> + + <!-- + PrimaryConnection: + + The object path of the "primary" active connection being used to access + the network. In particular, if there is no VPN active, or the VPN does not + have the default route, then this indicates the connection that has the + default route. If there is a VPN active with the default route, then this + indicates the connection that contains the route to the VPN endpoint. + --> + <property name="PrimaryConnection" type="o" access="read"/> + + <!-- + PrimaryConnectionType: + + The connection type of the "primary" active connection being used to + access the network. This is the same as the Type property on the object + indicated by PrimaryConnection. + --> + <property name="PrimaryConnectionType" type="s" access="read"/> + + <!-- + Metered: + + Indicates whether the connectivity is metered. This is equivalent to the + metered property of the device associated with the primary connection. + + Returns: <link linkend="NMMetered">NMMetered</link> + --> + <property name="Metered" type="u" access="read"/> + + <!-- + ActivatingConnection: + + The object path of an active connection that is currently being activated + and which is expected to become the new PrimaryConnection when it finishes + activating. + --> + <property name="ActivatingConnection" type="o" access="read"/> + + <!-- + Startup: + + Indicates whether NM is still starting up; this becomes FALSE when NM has + finished attempting to activate every connection that it might be able to + activate at startup. + --> + <property name="Startup" type="b" access="read"/> + + <!-- + Version: + NetworkManager version. - " /> - </property> + --> + <property name="Version" type="s" access="read"/> + + <!-- + State: - <property name="State" type="u" access="read" tp:type="NM_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" The overall state of the NetworkManager daemon. - " /> - </property> - <signal name="StateChanged"> - <annotation name="org.gtk.GDBus.DocString" value=" + Returns: <link linkend="NMState">NMState</link> + --> + <property name="State" type="u" access="read"/> + + <!-- + StateChanged: + @state: (<link linkend="NMState">NMState</link>) The new state of NetworkManager. + NetworkManager's state changed. - " /> - <arg name="state" type="u" tp:type="NM_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The new state of NetworkManager. - " /> - </arg> + --> + <signal name="StateChanged"> + <arg name="state" type="u"/> </signal> - <property name="Connectivity" type="u" access="read" tp:type="NM_CONNECTIVITY"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Connectivity: + The network connectivity state. - " /> - </property> - - <property name="GlobalDnsConfiguration" type="a{sv}" access="readwrite"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dictionary of global DNS settings where the key is one of - "searches", "options" and "domains". The values for the - "searches" and "options" keys are string arrays describing the - list of search domains and resolver options, respectively. - The value of the "domains" key is a second-level dictionary, - where each key is a domain name, and each key's value is a - third-level dictionary with the keys "servers" and - "options". "servers" is a string array of DNS servers, - "options" is a string array of domain-specific options. - " /> - </property> - <signal name="PropertiesChanged"> - <annotation name="org.gtk.GDBus.DocString" value=" + Returns: <link linkend="NMConnectivityState">NMConnectivityState</link> + --> + <property name="Connectivity" type="u" access="read"/> + + <!-- + GlobalDnsConfiguration: + + Dictionary of global DNS settings where the key is one of "searches", + "options" and "domains". The values for the "searches" and "options" keys + are string arrays describing the list of search domains and resolver + options, respectively. The value of the "domains" key is a second-level + dictionary, where each key is a domain name, and each key's value is a + third-level dictionary with the keys "servers" and "options". "servers" is + a string array of DNS servers, "options" is a string array of + domain-specific options. + --> + <property name="GlobalDnsConfiguration" type="a{sv}" access="readwrite"/> + + <!-- + PropertiesChanged: + @properties: The changed properties. + NetworkManager's properties changed. - " /> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The changed properties. - " /> - </arg> + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> </signal> - <signal name="DeviceAdded"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + DeviceAdded: + @device_path: The object path of the newly added device. + A device was added to the system - " /> - <arg name="device_path" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the newly added device. - " /> - </arg> + --> + <signal name="DeviceAdded"> + <arg name="device_path" type="o"/> </signal> - <signal name="DeviceRemoved"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + DeviceRemoved: + @device_path: The object path of the device that was just removed. + A device was removed from the system, and is no longer available. - " /> - <arg name="device_path" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the device that was just removed. - " /> - </arg> + --> + <signal name="DeviceRemoved"> + <arg name="device_path" type="o"/> </signal> - - <tp:enum name="NM_STATE" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the overall state of the daemon. - " /> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - Networking state is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ASLEEP" value="10"> - <annotation name="org.gtk.GDBus.DocString" value=" - Networking is inactive and all devices are disabled. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DISCONNECTED" value="20"> - <annotation name="org.gtk.GDBus.DocString" value=" - There is no active network connection. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DISCONNECTING" value="30"> - <annotation name="org.gtk.GDBus.DocString" value=" - Network connections are being cleaned up. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTING" value="40"> - <annotation name="org.gtk.GDBus.DocString" value=" - A network device is connecting to a network and there is no other - available network connection. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTED_LOCAL" value="50"> - <annotation name="org.gtk.GDBus.DocString" value=" - A network device is connected, but there is only link-local connectivity. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTED_SITE" value="60"> - <annotation name="org.gtk.GDBus.DocString" value=" - A network device is connected, but there is only site-local connectivity. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTED_GLOBAL" value="70"> - <annotation name="org.gtk.GDBus.DocString" value=" - A network device is connected, with global network connectivity. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:enum name="NM_CONNECTIVITY" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the network-connectivity state. - " /> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - Network connectivity is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NONE" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The host is not connected to any network. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PORTAL" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The host is behind a captive portal and cannot reach the - full Internet. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="LIMITED" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The host is connected to a network, but does not appear to - be able to reach the full Internet. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="FULL" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The host is connected to a network, and appears to be able - to reach the full Internet - " /> - </tp:enumvalue> - </tp:enum> - </interface> </node> diff --git a/introspection/nm-secret-agent.xml b/introspection/nm-secret-agent.xml index ec7ede09..33296fb0 100644 --- a/introspection/nm-secret-agent.xml +++ b/introspection/nm-secret-agent.xml @@ -1,243 +1,92 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <!-- + org.freedesktop.NetworkManager.SecretAgent: - <interface name="org.freedesktop.NetworkManager.SecretAgent"> - <annotation name="org.gtk.GDBus.DocString" value=" - Private D-Bus interface used by secret agents that store and provide - secrets to NetworkManager. If an agent provides secrets to - NetworkManager as part of connection creation, and the some of those - secrets are "agent owned" the agent should store those secrets - itself and should not expect its SaveSecrets() method to be called. - SaveSecrets() will be called eg if some program other than the - agent itself (like a connection editor) changes the secrets out of - band. The agent should implement this D-Bus interface on an object - with the path /org/freedesktop/NetworkManager/SecretAgent. - " /> + Private D-Bus interface used by secret agents that store and provide + secrets to NetworkManager. If an agent provides secrets to NetworkManager + as part of connection creation, and the some of those secrets are "agent + owned" the agent should store those secrets itself and should not expect + its SaveSecrets() method to be called. SaveSecrets() will be called eg if + some program other than the agent itself (like a connection editor) + changes the secrets out of band. The agent should implement this D-Bus + interface on an object with the path + /org/freedesktop/NetworkManager/SecretAgent. + --> + <interface name="org.freedesktop.NetworkManager.SecretAgent"> - <method name="GetSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Retrieve and return stored secrets, if any, or request new - secrets from the agent's user. If user interaction is allowed - and the user enters new secrets, the agent is expected to save - the new secrets to persistent storage (if the secret's flags - include AGENT_OWNED) as NetworkManager will not send these - secrets back to the same agent via a SaveSecrets() call. If - the user canceled any interaction, the agent should return the - UserCanceled error (see below). - " /> - <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_get_secrets"/> - <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> - <arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Nested settings maps containing the connection for which - secrets are being requested. This may contain system-owned - secrets if the agent has successfully authenticated to - modify system network settings and the GetSecrets request - flags allow user interaction. - " /> - </arg> - <arg name="connection_path" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the connection for which secrets are being - requested. - " /> - </arg> - <arg name="setting_name" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Setting name for which secrets are being requested. - " /> - </arg> - <arg name="hints" type="as" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of strings of key names in the requested setting for - which NetworkManager thinks a secrets may be required, - and/or well-known identifiers and data that may be useful - to the client in processing the secrets request. Note that - it's not always possible to determine which secret is - required, so in some cases no hints may be given. The Agent - should return any secrets it has, or that it thinks are - required, regardless of what hints NetworkManager sends - in this request. Some hints have special prefixes that - provide information to the agent; for example, VPN requests - may send server-specific messages prefixed with - "x-vpn-message:". - " /> - </arg> - <arg name="flags" type="u" direction="in" tp:type="NM_SECRET_AGENT_GET_SECRETS_FLAGS"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags which modify the behavior of the secrets request. - If true, new secrets are assumed to be invalid or incorrect, - and the agent should ask the user for new secrets. If false, - existing secrets should be retrieved from storage and - returned without interrupting the user. - " /> - </arg> + <!-- + GetSecrets: + @connection: Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction. + @connection_path: Object path of the connection for which secrets are being requested. + @setting_name: Setting name for which secrets are being requested. + @hints: Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:". + @flags: (<link linkend="NMSecretAgentGetSecretsFlags">NMSecretAgentGetSecretsFlags</link>) Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user. + @secrets: Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets. - <arg name="secrets" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Nested settings maps containing secrets. Each setting MUST - contain at least the 'name' field, containing the name of - the setting, and one or more secrets. - " /> - </arg> + Retrieve and return stored secrets, if any, or request new secrets from + the agent's user. If user interaction is allowed and the user enters new + secrets, the agent is expected to save the new secrets to persistent + storage (if the secret's flags include AGENT_OWNED) as NetworkManager will + not send these secrets back to the same agent via a SaveSecrets() call. If + the user canceled any interaction, the agent should return the + UserCanceled error (see below). + --> + <method name="GetSecrets"> + <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_get_secrets"/> + <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="connection_path" type="o" direction="in"/> + <arg name="setting_name" type="s" direction="in"/> + <arg name="hints" type="as" direction="in"/> + <arg name="flags" type="u" direction="in"/> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.NotAuthorized"> - <annotation name="org.gtk.GDBus.DocString" value=" - Should be returned when the process requesting secrets is - not authorized to do so (like if the caller is not root - or not NetworkManager). - " /> - </tp:error> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.InvalidConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" - Should be returned if the 'connection' argument is invalid. - " /> - </tp:error> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.UserCanceled"> - <annotation name="org.gtk.GDBus.DocString" value=" - Should be returned when the user has canceled the request. - " /> - </tp:error> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.AgentCanceled"> - <annotation name="org.gtk.GDBus.DocString" value=" - Should be returned when NetworkManager has requested that - the agent cancel the request. - " /> - </tp:error> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.InternalError"> - <annotation name="org.gtk.GDBus.DocString" value=" - Should be returned if the agent has encountered some internal - error processing the request. - " /> - </tp:error> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.NoSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Should be returned if there are no available secrets, for - example if user interaction is not allowed and there are - no secrets stored by the agent for this connection. - " /> - </tp:error> - </tp:possible-errors> - </method> + <arg name="secrets" type="a{sa{sv}}" direction="out"/> + </method> - <tp:flags name="NM_SECRET_AGENT_GET_SECRETS_FLAGS" value-prefix="NM_SECRET_AGENT_GET_SECRETS_FLAG" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags modifying the behavior of GetSecrets request. - " /> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value=" - No special behavior; by default no user interaction is allowed and - requests for secrets are fulfilled from persistent storage, or - if no secrets are available an error is returned. - " /> - </tp:flag> - <tp:flag suffix="ALLOW_INTERACTION" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value=" - Allows the request to interact with the user, possibly prompting - via UI for secrets if any are required, or if none are found in - persistent storage. - " /> - </tp:flag> - <tp:flag suffix="REQUEST_NEW" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value=" - Explicitly prompt for new secrets from the user. This flag - signals that NetworkManager thinks any existing secrets are - invalid or wrong. This flag implies that interaction is allowed. - " /> - </tp:flag> - <tp:flag suffix="USER_REQUESTED" value="0x4"> - <annotation name="org.gtk.GDBus.DocString" value=" - Set if the request was initiated by user-requested action via the - D-Bus interface, as opposed to automatically initiated by - NetworkManager in response to (for example) scan results or - carrier changes. - " /> - </tp:flag> - </tp:flags> + <!-- + CancelGetSecrets: + @connection_path: Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled. + @setting_name: Setting name for which secrets for this connection were originally being requested. - <method name="CancelGetSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Cancel a pending GetSecrets request for secrets of the given - connection. Any GetSecrets request with the same - 'connection_path' and 'setting_name' that are given in a - CancelGetSecrets request should be canceled. - " /> - <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_cancel_get_secrets"/> - <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> - <arg name="connection_path" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the connection for which, if secrets for - the given 'setting_name' are being requested, the request - should be canceled. - " /> - </arg> - <arg name="setting_name" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Setting name for which secrets for this connection were - originally being requested. - " /> - </arg> - </method> + Cancel a pending GetSecrets request for secrets of the given connection. + Any GetSecrets request with the same 'connection_path' and 'setting_name' + that are given in a CancelGetSecrets request should be canceled. + --> + <method name="CancelGetSecrets"> + <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_cancel_get_secrets"/> + <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> + <arg name="connection_path" type="o" direction="in"/> + <arg name="setting_name" type="s" direction="in"/> + </method> - <method name="SaveSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Save given secrets to backing storage. - " /> - <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_save_secrets"/> - <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> - <arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Nested settings maps containing the entire connection - (including secrets), for which the agent should save the - secrets to backing storage. This method will not be called - when the agent itself is the process creating or updating - a connection; in that case the agent is assumed to have - already saved those secrets since it had them already. - " /> - </arg> - <arg name="connection_path" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the connection for which the agent should - save secrets to backing storage. - " /> - </arg> - </method> + <!-- + SaveSecrets: + @connection: Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already. + @connection_path: Object path of the connection for which the agent should save secrets to backing storage. - <method name="DeleteSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Delete secrets from backing storage. - " /> - <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_delete_secrets"/> - <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> - <arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Nested settings maps containing the connection properties - (sans secrets), for which the agent should delete the - secrets from backing storage. - " /> - </arg> - <arg name="connection_path" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the connection for which the agent should - delete secrets from backing storage. - " /> - </arg> - </method> + Save given secrets to backing storage. + --> + <method name="SaveSecrets"> + <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_save_secrets"/> + <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="connection_path" type="o" direction="in"/> + </method> - <tp:flags name="NM_SECRET_AGENT_CAPABILITIES" value-prefix="NM_SECRET_AGENT_CAPABILITY" type="u"> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="No special capabilities." /> - </tp:flag> - <tp:flag suffix="VPN_HINTS" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The agent supports passing hints to VPN plugin authentication - dialogs. - " /> - </tp:flag> - </tp:flags> - - </interface> + <!-- + DeleteSecrets: + @connection: Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage. + @connection_path: Object path of the connection for which the agent should delete secrets from backing storage. + Delete secrets from backing storage. + --> + <method name="DeleteSecrets"> + <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_delete_secrets"/> + <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="connection_path" type="o" direction="in"/> + </method> + </interface> </node> diff --git a/introspection/nm-settings-connection.xml b/introspection/nm-settings-connection.xml index fc62046c..15b38034 100644 --- a/introspection/nm-settings-connection.xml +++ b/introspection/nm-settings-connection.xml @@ -1,138 +1,131 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - - <interface name="org.freedesktop.NetworkManager.Settings.Connection"> - <annotation name="org.gtk.GDBus.DocString" value=" - Represents a single network connection configuration. - " /> - - <method name="Update"> - <annotation name="org.gtk.GDBus.DocString" value=" - Update the connection with new settings and properties (replacing - all previous settings and properties) and save the connection to - disk. Secrets may be part of the update request, and will be either - stored in persistent storage or sent to a Secret Agent for storage, - depending on the flags associated with each secret. - " /> - <arg name="properties" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - New connection settings, properties, and (optionally) secrets. - " /> - </arg> - </method> - - <method name="UpdateUnsaved"> - <annotation name="org.gtk.GDBus.DocString" value=" - Update the connection with new settings and properties (replacing - all previous settings and properties) but do not immediately save - the connection to disk. Secrets may be part of the update request - and may sent to a Secret Agent for storage, depending on the - flags associated with each secret. - - Use the 'Save' method to save these changes to disk. Note - that unsaved changes will be lost if the connection is - reloaded from disk (either automatically on file change or - due to an explicit ReloadConnections call). - " /> - <arg name="properties" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - New connection settings, properties, and (optionally) secrets. - " /> - </arg> - </method> - - <method name="Delete"> - <annotation name="org.gtk.GDBus.DocString" value=" - Delete the connection. - " /> - </method> - - <method name="GetSettings"> - <annotation name="org.gtk.GDBus.DocString" value=" - Get the settings maps describing this network configuration. - This will never include any secrets required for connection - to the network, as those are often protected. Secrets must - be requested separately using the GetSecrets() call. - " /> - <arg name="settings" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The nested settings maps describing this object. - " /> - </arg> - </method> - - <method name="GetSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Get the secrets belonging to this network configuration. Only - secrets from persistent storage or a Secret Agent running in - the requestor's session will be returned. The user will never - be prompted for secrets as a result of this request. - " /> - <arg name="setting_name" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Name of the setting to return secrets for. If empty, all - all secrets will be returned. - " /> - </arg> - - <arg name="secrets" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Nested settings maps containing secrets. - " /> - </arg> - </method> - - <method name="ClearSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Clear the secrets belonging to this network connection profile. - " /> - </method> - - <method name="Save"> - <annotation name="org.gtk.GDBus.DocString" value=" - Saves a "dirty" connection (that had previously been - updated with UpdateUnsaved) to persistent storage. - " /> - </method> - - <signal name="Updated"> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when any settings or permissions change. When handling - this signal, clients should re-read the connection using the - GetSettings method to get the changes and to ensure the client - still has permission to access the connection. - " /> - </signal> - - <signal name="Removed"> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when this connection is no longer available. This - happens when the connection is deleted or if it is no longer - accessible by any of the system's logged-in users. After - receipt of this signal, the object no longer exists. Also - see the Settings.ConnectionRemoved signal. - " /> - </signal> - - <property name="Unsaved" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - If set, indicates that the in-memory state of the - connection does not match the on-disk state. This flag - will be set when UpdateUnsaved() is called or when any - connection details change, and cleared when the connection - is saved to disk via Save() or from internal operations. - " /> - </property> - - <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values. - " /> - </arg> - </signal> - - </interface> - +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> + + <!-- + org.freedesktop.NetworkManager.Settings.Connection: + + Represents a single network connection configuration. + --> + <interface name="org.freedesktop.NetworkManager.Settings.Connection"> + + <!-- + Update: + @properties: New connection settings, properties, and (optionally) secrets. + + Update the connection with new settings and properties (replacing all + previous settings and properties) and save the connection to disk. Secrets + may be part of the update request, and will be either stored in persistent + storage or sent to a Secret Agent for storage, depending on the flags + associated with each secret. + --> + <method name="Update"> + <arg name="properties" type="a{sa{sv}}" direction="in"/> + </method> + + <!-- + UpdateUnsaved: + @properties: New connection settings, properties, and (optionally) secrets. + + Update the connection with new settings and properties (replacing all + previous settings and properties) but do not immediately save the + connection to disk. Secrets may be part of the update request and may sent + to a Secret Agent for storage, depending on the flags associated with each + secret. Use the 'Save' method to save these changes to disk. Note that + unsaved changes will be lost if the connection is reloaded from disk + (either automatically on file change or due to an explicit + ReloadConnections call). + --> + <method name="UpdateUnsaved"> + <arg name="properties" type="a{sa{sv}}" direction="in"/> + </method> + + <!-- + Delete: + + Delete the connection. + --> + <method name="Delete"/> + + <!-- + GetSettings: + @settings: The nested settings maps describing this object. + + Get the settings maps describing this network configuration. This will + never include any secrets required for connection to the network, as those + are often protected. Secrets must be requested separately using the + GetSecrets() call. + --> + <method name="GetSettings"> + <arg name="settings" type="a{sa{sv}}" direction="out"/> + </method> + + <!-- + GetSecrets: + @setting_name: Name of the setting to return secrets for. If empty, all all secrets will be returned. + @secrets: Nested settings maps containing secrets. + + Get the secrets belonging to this network configuration. Only secrets from + persistent storage or a Secret Agent running in the requestor's session + will be returned. The user will never be prompted for secrets as a result + of this request. + --> + <method name="GetSecrets"> + <arg name="setting_name" type="s" direction="in"/> + + <arg name="secrets" type="a{sa{sv}}" direction="out"/> + </method> + + <!-- + ClearSecrets: + + Clear the secrets belonging to this network connection profile. + --> + <method name="ClearSecrets"/> + + <!-- + Save: + + Saves a "dirty" connection (that had previously been updated with + UpdateUnsaved) to persistent storage. + --> + <method name="Save"/> + + <!-- + Updated: + + Emitted when any settings or permissions change. When handling this + signal, clients should re-read the connection using the GetSettings method + to get the changes and to ensure the client still has permission to access + the connection. + --> + <signal name="Updated"/> + + <!-- + Removed: + + Emitted when this connection is no longer available. This happens when the + connection is deleted or if it is no longer accessible by any of the + system's logged-in users. After receipt of this signal, the object no + longer exists. Also see the Settings.ConnectionRemoved signal. + --> + <signal name="Removed"/> + + <!-- + Unsaved: + + If set, indicates that the in-memory state of the connection does not + match the on-disk state. This flag will be set when UpdateUnsaved() is + called or when any connection details change, and cleared when the + connection is saved to disk via Save() or from internal operations. + --> + <property name="Unsaved" type="b" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values. + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> + </signal> + </interface> </node> diff --git a/introspection/nm-settings.xml b/introspection/nm-settings.xml index 62892025..7f5b546c 100644 --- a/introspection/nm-settings.xml +++ b/introspection/nm-settings.xml @@ -1,198 +1,170 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/org/freedesktop/NetworkManager/Settings"> -<node name="/org/freedesktop/NetworkManager/Settings" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <!-- + org.freedesktop.NetworkManager.Settings: + + The Settings interface allows clients to view and administrate the + connections stored and used by NetworkManager. + --> <interface name="org.freedesktop.NetworkManager.Settings"> - <annotation name="org.gtk.GDBus.DocString" value=" - The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager. - " /> - <method name="ListConnections"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + ListConnections: + @connections: List of connections. + List the saved network connections known to NetworkManager. - " /> - <arg name="connections" type="ao" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - List of connections. - " /> - </arg> + --> + <method name="ListConnections"> + <arg name="connections" type="ao" direction="out"/> </method> - <method name="GetConnectionByUuid"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetConnectionByUuid: + @uuid: The UUID to find the connection object path for. + @connection: The connection's object path. + Retrieve the object path of a connection, given that connection's UUID. - " /> - <arg name="uuid" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The UUID to find the connection object path for. - " /> - </arg> - <arg name="connection" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection's object path. - " /> - </arg> + --> + <method name="GetConnectionByUuid"> + <arg name="uuid" type="s" direction="in"/> + <arg name="connection" type="o" direction="out"/> </method> + <!-- + AddConnection: + @connection: Connection settings and properties. + @path: Object path of the new connection that was just added. + + Add new connection and save it to disk. This operation does not start the + network connection unless (1) device is idle and able to connect to the + network described by the new connection, and (2) the connection is allowed + to be started automatically. + --> <method name="AddConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" - Add new connection and save it to disk. This operation does not start - the network connection unless (1) device is idle and able to connect to - the network described by the new connection, and (2) the connection - is allowed to be started automatically. - " /> - <arg name="connection" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Connection settings and properties. - " /> - </arg> - <arg name="path" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the new connection that was just added. - " /> - </arg> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="path" type="o" direction="out"/> </method> + <!-- + AddConnectionUnsaved: + @connection: Connection settings and properties. + @path: Object path of the new connection that was just added. + + Add new connection but do not save it to disk immediately. This operation + does not start the network connection unless (1) device is idle and able + to connect to the network described by the new connection, and (2) the + connection is allowed to be started automatically. Use the 'Save' method + on the connection to save these changes to disk. Note that unsaved changes + will be lost if the connection is reloaded from disk (either automatically + on file change or due to an explicit ReloadConnections call). + --> <method name="AddConnectionUnsaved"> - <annotation name="org.gtk.GDBus.DocString" value=" - Add new connection but do not save it to disk immediately. This - operation does not start the network connection unless (1) device is - idle and able to connect to the network described by the new connection, - and (2) the connection is allowed to be started automatically. - - Use the 'Save' method on the connection to save these changes - to disk. Note that unsaved changes will be lost if the - connection is reloaded from disk (either automatically on file - change or due to an explicit ReloadConnections call). - " /> - <arg name="connection" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Connection settings and properties. - " /> - </arg> - <arg name="path" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the new connection that was just added. - " /> - </arg> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="path" type="o" direction="out"/> </method> + <!-- + LoadConnections: + @filenames: Array of paths to on-disk connection profiles in directories monitored by NetworkManager. + @status: Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied). + @failures: Paths of connection files that could not be loaded. + + Loads or reloads the indicated connections from disk. You should call this + after making changes directly to an on-disk connection file to make sure + that NetworkManager sees the changes. (If "monitor-connection-files" in + NetworkManager.conf is "true", then this will have no real effect, but is + harmless.) As with AddConnection(), this operation does not necessarily + start the network connection. + --> <method name="LoadConnections"> - <annotation name="org.gtk.GDBus.DocString" value=" - Loads or reloads the indicated connections from disk. You - should call this after making changes directly to an on-disk - connection file to make sure that NetworkManager sees the - changes. (If "monitor-connection-files" in NetworkManager.conf - is "true", then this will have no real effect, but is - harmless.) As with AddConnection(), this operation does not - necessarily start the network connection. - " /> - <arg name="filenames" type="as" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of paths to on-disk connection profiles in directories - monitored by NetworkManager. - " /> - </arg> - <arg name="status" type="b" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Success or failure of the operation as a whole. True if - NetworkManager at least tried to load the indicated - connections, even if it did not succeed. False if an error - occurred before trying to load the connections (eg, - permission denied). - " /> - </arg> - <arg name="failures" type="as" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Paths of connection files that could not be loaded. - " /> - </arg> + <arg name="filenames" type="as" direction="in"/> + <arg name="status" type="b" direction="out"/> + <arg name="failures" type="as" direction="out"/> </method> + <!-- + ReloadConnections: + @status: Success or failure. + + Tells NetworkManager to reload all connection files from disk, including + noticing any added or deleted connection files. By default, connections + are re-read automatically any time they change, so you only need to use + this command if you have set "monitor-connection-files=false" in + NetworkManager.conf. + --> <method name="ReloadConnections"> - <annotation name="org.gtk.GDBus.DocString" value=" - Tells NetworkManager to reload all connection files from disk, - including noticing any added or deleted connection files. By - default, connections are re-read automatically any time they - change, so you only need to use this command if you have set - "monitor-connection-files=false" in NetworkManager.conf. - " /> - <arg name="status" type="b" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Success or failure. - " /> - </arg> + <arg name="status" type="b" direction="out"/> </method> - <method name="SaveHostname"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + SaveHostname: + @hostname: The hostname to save to persistent configuration. If blank, the persistent hostname is cleared. + Save the hostname to persistent configuration. - " /> - <arg name="hostname" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The hostname to save to persistent configuration. If blank, the persistent hostname is cleared. - " /> - </arg> + --> + <method name="SaveHostname"> + <arg name="hostname" type="s" direction="in"/> </method> - <property name="Connections" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Connections: + List of object paths of available network connection profiles. - " /> - </property> + --> + <property name="Connections" type="ao" access="read"/> + + <!-- + Hostname: - <property name="Hostname" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The machine hostname stored in persistent configuration. - " /> - </property> + --> + <property name="Hostname" type="s" access="read"/> + + <!-- + CanModify: - <property name="CanModify" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" If true, adding and modifying connections is supported. - " /> - </property> + --> + <property name="CanModify" type="b" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - <signal name="NewConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + NewConnection: + @connection: Object path of the new connection. + Emitted when a new connection has been added after NetworkManager has - started up and initialized. This signal is not emitted for connections + started up and initialized. This signal is not emitted for connections read while starting up, because NetworkManager's D-Bus service is only available after all connections have been read, and to prevent spamming - listeners with too many signals at one time. To retrieve the initial + listeners with too many signals at one time. To retrieve the initial connection list, call the ListConnections() method once, and then listen for individual Settings.NewConnection and Settings.Connection.Deleted signals for further updates. - " /> - <arg name="connection" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the new connection. - " /> - </arg> + --> + <signal name="NewConnection"> + <arg name="connection" type="o"/> </signal> + <!-- + ConnectionRemoved: + @connection: Object path of the removed connection. + + Emitted when a connection is no longer available. This happens when the + connection is deleted or if it is no longer accessible by any of the + system's logged-in users. After receipt of this signal, the connection no + longer exists and cannot be used. Also see the Settings.Connection.Removed + signal. + --> <signal name="ConnectionRemoved"> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when a connection is no longer available. This happens when - the connection is deleted or if it is no longer accessible by any of - the system's logged-in users. After receipt of this signal, the - connection no longer exists and cannot be used. Also see the - Settings.Connection.Removed signal. - " /> - <arg name="connection" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the removed connection. - " /> - </arg> + <arg name="connection" type="o"/> </signal> - </interface> </node> - diff --git a/introspection/nm-vpn-connection.xml b/introspection/nm-vpn-connection.xml index 6a4fb37d..430998f3 100644 --- a/introspection/nm-vpn-connection.xml +++ b/introspection/nm-vpn-connection.xml @@ -1,148 +1,48 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - <interface name="org.freedesktop.NetworkManager.VPN.Connection"> - <annotation name="org.gtk.GDBus.C.Name" value="VpnConnection"/> + <!-- + org.freedesktop.NetworkManager.VPN.Connection: - <annotation name="org.gtk.GDBus.DocString" value=" Represents an active connection to a Virtual Private Network. - " /> + --> + <interface name="org.freedesktop.NetworkManager.VPN.Connection"> + <annotation name="org.gtk.GDBus.C.Name" value="VpnConnection"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - <property name="VpnState" type="u" access="read" tp:type="NM_VPN_CONNECTION_STATE"> - <annotation name="org.gtk.GDBus.DocString" value="The VPN-specific state of the connection." /> - </property> - <property name="Banner" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The banner string of the VPN connection." /> - </property> + <!-- + VpnState: + + The VPN-specific state of the connection. + + Returns: <link linkend="NMVpnConnectionState">NMVpnConnectionState</link> + --> + <property name="VpnState" type="u" access="read"/> + + <!-- + Banner: + + The banner string of the VPN connection. + --> + <property name="Banner" type="s" access="read"/> + + <!-- + VpnStateChanged: + @state: (<link linkend="NMVpnConnectionState">NMVpnConnectionState</link>) The new state of the VPN connection. + @reason: (<link linkend="NMVpnConnectionStateReason">NMVpnConnectionStateReason</link>) Reason code describing the change to the new state. - <signal name="VpnStateChanged"> - <annotation name="org.gtk.GDBus.DocString" value=" Emitted when the state of the VPN connection has changed. - " /> - <arg name="state" type="u" tp:type="NM_VPN_CONNECTION_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The new state of the VPN connection. - " /> - </arg> - <arg name="reason" type="u" tp:type="NM_VPN_CONNECTION_STATE_REASON"> - <annotation name="org.gtk.GDBus.DocString" value=" - Reason code describing the change to the new state. - " /> - </arg> + --> + <signal name="VpnStateChanged"> + <arg name="state" type="u"/> + <arg name="reason" type="u"/> </signal> - - <tp:enum name="NM_VPN_CONNECTION_STATE" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The state of the VPN connection is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PREPARE" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection is preparing to connect. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NEED_AUTH" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection needs authorization credentials. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECT" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection is being established. FIXME: Should be CONNECTING or CONNECTED. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="IP_CONFIG_GET" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection is getting an IP address. FIXME: Should be an -ING - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ACTIVATED" value="5"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection is active. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="FAILED" value="6"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DISCONNECTED" value="7"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection is disconnected. - " /> - </tp:enumvalue> - </tp:enum> - <tp:enum name="NM_VPN_CONNECTION_STATE_REASON" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The reason for the VPN connection state change is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NONE" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - No reason was given for the VPN connection state change. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="USER_DISCONNECTED" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection changed state because the user disconnected it. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DEVICE_DISCONNECTED" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection changed state because the device it was using was disconnected. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SERVICE_STOPPED" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The service providing the VPN connection was stopped. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="IP_CONFIG_INVALID" value="5"> - <annotation name="org.gtk.GDBus.DocString" value=" - The IP config of the VPN connection was invalid. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECT_TIMEOUT" value="6"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection attempt to the VPN service timed out. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SERVICE_START_TIMEOUT" value="7"> - <annotation name="org.gtk.GDBus.DocString" value=" - A timeout occurred while starting the service providing the VPN connection. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SERVICE_START_FAILED" value="8"> - <annotation name="org.gtk.GDBus.DocString" value=" - Starting the service starting the service providing the VPN connection failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NO_SECRETS" value="9"> - <annotation name="org.gtk.GDBus.DocString" value=" - Necessary secrets for the VPN connection were not provided. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="LOGIN_FAILED" value="10"> - <annotation name="org.gtk.GDBus.DocString" value=" - Authentication to the VPN server failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTION_REMOVED" value="11"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection was deleted from settings. - " /> - </tp:enumvalue> - </tp:enum> </interface> </node> - diff --git a/introspection/nm-vpn-plugin.xml b/introspection/nm-vpn-plugin.xml index ee8c69f8..7eed9721 100644 --- a/introspection/nm-vpn-plugin.xml +++ b/introspection/nm-vpn-plugin.xml @@ -1,313 +1,202 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <!-- + org.freedesktop.NetworkManager.VPN.Plugin: + + This interface is provided by plugins providing VPN services to the + NetworkManager daemon. + --> <interface name="org.freedesktop.NetworkManager.VPN.Plugin"> <annotation name="org.gtk.GDBus.C.Name" value="VpnPlugin"/> - <annotation name="org.gtk.GDBus.DocString" value=" - This interface is provided by plugins providing VPN services to the NetworkManager daemon. - " /> + <!-- + Connect: + @connection: Describes the connection to be established. - <method name="Connect"> - <annotation name="org.gtk.GDBus.DocString" value=" - Tells the plugin to connect. Interactive secrets requests (eg, emitting + Tells the plugin to connect. Interactive secrets requests (eg, emitting the SecretsRequired signal) are not allowed. - " /> + --> + <method name="Connect"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect"/> - <arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the connection to be established. - " /> - </arg> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.BadArguments"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/> - </tp:possible-errors> + <arg name="connection" type="a{sa{sv}}" direction="in"/> </method> + <!-- + ConnectInteractive: + @connection: Describes the connection to be established. + @details: Additional details about the Connect process. + + Tells the plugin to connect, allowing interactive secrets requests (eg the + plugin is allowed to emit the SecretsRequired signal if the VPN service + indicates that it needs additional secrets during the connect process). + --> <method name="ConnectInteractive"> - <annotation name="org.gtk.GDBus.DocString" value=" - Tells the plugin to connect, allowing interactive secrets requests (eg - the plugin is allowed to emit the SecretsRequired signal if the VPN - service indicates that it needs additional secrets during the connect - process). - " /> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect_interactive"/> - <arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the connection to be established. - " /> - </arg> - <arg name="details" type="a{sv}" direction="in" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Additional details about the Connect process. - " /> - </arg> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.BadArguments"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported"/> - </tp:possible-errors> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="details" type="a{sv}" direction="in"/> </method> + <!-- + NeedSecrets: + @settings: Describes the connection that may need secrets. + @setting_name: The setting name within the provided connection that requires secrets, if any. + + Asks the plugin whether the provided connection will require secrets to + connect successfully. + --> <method name="NeedSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Asks the plugin whether the provided connection will require secrets to connect successfully. - " /> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_need_secrets"/> - <arg name="settings" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the connection that may need secrets. - " /> - </arg> - <arg name="setting_name" type="s" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The setting name within the provided connection that requires secrets, if any. - " /> - </arg> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"/> - </tp:possible-errors> + <arg name="settings" type="a{sa{sv}}" direction="in"/> + <arg name="setting_name" type="s" direction="out"/> </method> - <method name="Disconnect"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Disconnect: + Disconnect the plugin. - " /> + --> + <method name="Disconnect"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_disconnect"/> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped"/> - </tp:possible-errors> </method> - <method name="SetConfig"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + SetConfig: + @config: Generic configuration details for the connection. + Set generic connection details on the connection. - " /> + --> + <method name="SetConfig"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_config"/> - <arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Generic configuration details for the connection. - " /> - </arg> + <arg name="config" type="a{sv}" direction="in"/> </method> - <method name="SetIp4Config"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + SetIp4Config: + @config: Ip4Config details for the connection. You must call SetConfig() before calling this. + Set IPv4 details on the connection. - " /> + --> + <method name="SetIp4Config"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip4_config"/> - <arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Ip4Config details for the connection. You must call - SetConfig() before calling this. - " /> - </arg> + <arg name="config" type="a{sv}" direction="in"/> </method> - <method name="SetIp6Config"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + SetIp6Config: + @config: Ip6Config details for the connection. You must call SetConfig() before calling this. + Set IPv6 details on the connection. - " /> + --> + <method name="SetIp6Config"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip6_config"/> - <arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Ip6Config details for the connection. You must call - SetConfig() before calling this. - " /> - </arg> + <arg name="config" type="a{sv}" direction="in"/> </method> - <method name="SetFailure"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + SetFailure: + @reason: The reason for the failure. + Indicate a failure to the plugin. - " /> + --> + <method name="SetFailure"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_failure"/> - <arg name="reason" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The reason for the failure. - " /> - </arg> + <arg name="reason" type="s" direction="in"/> </method> - <property name="State" type="u" access="read" tp:type="NM_VPN_SERVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + State: + The state of the plugin. - " /> - </property> - <signal name="StateChanged"> - <annotation name="org.gtk.GDBus.DocString" value=" + Returns: <link linkend="NMVpnServiceState">NMVpnServiceState</link> + --> + <property name="State" type="u" access="read"/> + + <!-- + StateChanged: + @state: (<link linkend="NMVpnServiceState">NMVpnServiceState</link>) The new state of the plugin. + Emitted when the plugin state changes. - " /> - <arg name="state" type="u" tp:type="NM_VPN_SERVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The new state of the plugin. - " /> - </arg> + --> + <signal name="StateChanged"> + <arg name="state" type="u"/> </signal> + <!-- + SecretsRequired: + @message: Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN. + @secrets: Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end. + + Emitted during an ongoing ConnectInteractive() request when the plugin has + determined that new secrets are required. NetworkManager will then call + the NewSecrets() method with a connection hash including the new secrets. + --> <signal name="SecretsRequired"> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted during an ongoing ConnectInteractive() request when the plugin - has determined that new secrets are required. NetworkManager will then - call the NewSecrets() method with a connection hash including the new - secrets. - " /> - <arg name="message" type="s" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Informational message, if any, about the request. For example, if - a second PIN is required, could indicate to the user to wait for - the token code to change until entering the next PIN. - " /> - </arg> - <arg name="secrets" type="as" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of strings of VPN secret names which the plugin thinks - secrets may be required for, or other VPN-specific data to be - processed by the VPN's front-end. - " /> - </arg> + <arg name="message" type="s" direction="out"/> + <arg name="secrets" type="as" direction="out"/> </signal> - <method name="NewSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + NewSecrets: + @connection: Describes the connection including the new secrets. + Called in response to a SecretsRequired signal to deliver updated secrets or other information to the plugin. - " /> + --> + <method name="NewSecrets"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_new_secrets"/> - <arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the connection including the new secrets. - " /> - </arg> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.BadArguments"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported"/> - </tp:possible-errors> + <arg name="connection" type="a{sa{sv}}" direction="in"/> </method> - <signal name="Config"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Config: + @config: The configuration information. + The plugin obtained generic configuration information. - " /> - <arg name="config" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The configuration information. - " /> - </arg> + --> + <signal name="Config"> + <arg name="config" type="a{sv}"/> </signal> - <signal name="Ip4Config"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Ip4Config: + @ip4config: The IPv4 configuration. + The plugin obtained an IPv4 configuration. - " /> - <arg name="ip4config" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The IPv4 configuration. - " /> - </arg> + --> + <signal name="Ip4Config"> + <arg name="ip4config" type="a{sv}"/> </signal> - <signal name="Ip6Config"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Ip6Config: + @ip6config: The IPv6 configuration. + The plugin obtained an IPv6 configuration. - " /> - <arg name="ip6config" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The IPv6 configuration. - " /> - </arg> + --> + <signal name="Ip6Config"> + <arg name="ip6config" type="a{sv}"/> </signal> - <signal name="LoginBanner"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + LoginBanner: + @banner: The login banner string. + Emitted when the plugin receives a login banner from the VPN service. - " /> - <arg name="banner" type="s"> - <annotation name="org.gtk.GDBus.DocString" value=" - The login banner string. - " /> - </arg> + --> + <signal name="LoginBanner"> + <arg name="banner" type="s"/> </signal> - <signal name="Failure"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Failure: + @reason: (<link linkend="NMVpnPluginFailure">NMVpnPluginFailure</link>) Reason code for the failure. + Emitted when a failure in the VPN plugin occurs. - " /> - <arg name="reason" type="u" tp:type="NM_VPN_PLUGIN_FAILURE"> - <annotation name="org.gtk.GDBus.DocString" value=" - Reason code for the failure. - " /> - </arg> + --> + <signal name="Failure"> + <arg name="reason" type="u"/> </signal> - - <tp:enum name="NM_VPN_SERVICE_STATE" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The state of the VPN plugin is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="INIT" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN plugin is initialized. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SHUTDOWN" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - (Not used.) - " /> - </tp:enumvalue> - <tp:enumvalue suffix="STARTING" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is attempting to connect to a VPN server. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="STARTED" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin has connected to a VPN server. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="STOPPING" value="5"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is disconnecting from the VPN server. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="STOPPED" value="6"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin has disconnected from the VPN server. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:enum name="NM_VPN_PLUGIN_FAILURE" type="u"> - <tp:enumvalue suffix="LOGIN_FAILED" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - Login failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECT_FAILED" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - Connect failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="BAD_IP_CONFIG" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - Invalid IP configuration returned from the VPN plugin. - " /> - </tp:enumvalue> - </tp:enum> - </interface> </node> diff --git a/introspection/nm-wimax-nsp.xml b/introspection/nm-wimax-nsp.xml index 6174ad67..8b9a2fcc 100644 --- a/introspection/nm-wimax-nsp.xml +++ b/introspection/nm-wimax-nsp.xml @@ -1,44 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.WiMax.Nsp"> - <property name="Name" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The name of the NSP." /> - </property> - <property name="SignalQuality" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The current signal quality of the NSP, in percent." /> - </property> - <property name="NetworkType" type="u" access="read" tp:type="NM_WIMAX_NSP_NETWORK_TYPE"> - <annotation name="org.gtk.GDBus.DocString" value="The network type of the NSP." /> - </property> + <!-- + Name: - <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values. - " /> - </arg> - </signal> + The name of the NSP. + --> + <property name="Name" type="s" access="read"/> + + <!-- + SignalQuality: + + The current signal quality of the NSP, in percent. + --> + <property name="SignalQuality" type="u" access="read"/> - <tp:flags name="NM_WIMAX_NSP_NETWORK_TYPE" value-prefix="NM_WIMAX_NSP_NETWORK_TYPE" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Network type of the NSP. - " /> - <tp:flag suffix="UNKNOWN" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Unknown network." /> - </tp:flag> - <tp:flag suffix="HOME" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value="Home network." /> - </tp:flag> - <tp:flag suffix="PARTNER" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value="Partner network." /> - </tp:flag> - <tp:flag suffix="ROAMING_PARTNER" value="0x3"> - <annotation name="org.gtk.GDBus.DocString" value="Roaming partner network." /> - </tp:flag> - - </tp:flags> + <!-- + NetworkType: + The network type of the NSP. + + Returns: <link linkend="NMWimaxNspNetworkType">NMWimaxNspNetworkType</link> + --> + <property name="NetworkType" type="u" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values. + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> + </signal> </interface> </node> diff --git a/introspection/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml b/introspection/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml index eae6fef6..af445f92 100644 --- a/introspection/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml +++ b/introspection/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml @@ -55,7 +55,9 @@ PropertiesChanged (a{sv} properties); <programlisting> Flags readable u </programlisting> -<para>Flags describing the capabilities of the access point.</para> +<para> Flags describing the capabilities of the access point. +</para><para> Returns: <link linkend="NM80211ApFlags">NM80211ApFlags</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-AccessPoint.WpaFlags"> <title>The "WpaFlags" property</title> @@ -63,7 +65,10 @@ Flags readable u <programlisting> WpaFlags readable u </programlisting> -<para>Flags describing the access point's capabilities according to WPA (Wifi Protected Access).</para> +<para> Flags describing the access point's capabilities according to WPA (Wifi + Protected Access). +</para><para> Returns: <link linkend="NM80211ApSecurityFlags">NM80211ApSecurityFlags</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-AccessPoint.RsnFlags"> <title>The "RsnFlags" property</title> @@ -71,7 +76,10 @@ WpaFlags readable u <programlisting> RsnFlags readable u </programlisting> -<para>Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol.</para> +<para> Flags describing the access point's capabilities according to the RSN + (Robust Secure Network) protocol. +</para><para> Returns: <link linkend="NM80211ApSecurityFlags">NM80211ApSecurityFlags</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-AccessPoint.Ssid"> <title>The "Ssid" property</title> @@ -79,7 +87,8 @@ RsnFlags readable u <programlisting> Ssid readable ay </programlisting> -<para>The Service Set Identifier identifying the access point.</para> +<para> The Service Set Identifier identifying the access point. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-AccessPoint.Frequency"> <title>The "Frequency" property</title> @@ -87,7 +96,8 @@ Ssid readable ay <programlisting> Frequency readable u </programlisting> -<para>The radio channel frequency in use by the access point, in MHz.</para> +<para> The radio channel frequency in use by the access point, in MHz. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-AccessPoint.HwAddress"> <title>The "HwAddress" property</title> @@ -95,7 +105,8 @@ Frequency readable u <programlisting> HwAddress readable s </programlisting> -<para>The hardware address (BSSID) of the access point.</para> +<para> The hardware address (BSSID) of the access point. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-AccessPoint.Mode"> <title>The "Mode" property</title> @@ -103,7 +114,9 @@ HwAddress readable s <programlisting> Mode readable u </programlisting> -<para>Describes the operating mode of the access point.</para> +<para> Describes the operating mode of the access point. +</para><para> Returns: <link linkend="NM80211Mode">NM80211Mode</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-AccessPoint.MaxBitrate"> <title>The "MaxBitrate" property</title> @@ -111,7 +124,9 @@ Mode readable u <programlisting> MaxBitrate readable u </programlisting> -<para>The maximum bitrate this access point is capable of, in kilobits/second (Kb/s).</para> +<para> The maximum bitrate this access point is capable of, in kilobits/second + (Kb/s). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-AccessPoint.Strength"> <title>The "Strength" property</title> @@ -119,7 +134,8 @@ MaxBitrate readable u <programlisting> Strength readable y </programlisting> -<para>The current signal quality of the access point, in percent.</para> +<para> The current signal quality of the access point, in percent. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-AccessPoint.LastSeen"> <title>The "LastSeen" property</title> @@ -127,7 +143,10 @@ Strength readable y <programlisting> LastSeen readable i </programlisting> -<para>The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access point was found in scan results. A value of -1 means the access point has never been found in scan results.</para> +<para> The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access + point was found in scan results. A value of -1 means the access point has + never been found in scan results. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml b/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml index a2a352f6..0f002e22 100644 --- a/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml +++ b/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml @@ -33,7 +33,21 @@ </refsect1> <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-Connection-Active"> <title role="desc.title">Description</title> - <para>Objects that implement the Connection.Active interface represent an attempt to connect to a network using the details provided by a Connection object. The Connection.Active object tracks the life-cycle of the connection attempt and if successful indicates whether the connected network is the "default" or preferred network for access. NetworkManager has the concept of connections, which can be thought of as settings, a profile or a configuration that can be applied on a networking device. Such settings-connections are exposed as D-Bus object and the active-connection expresses this relationship between device and settings-connection. At any time a settings-connection can only be activated on one device and vice versa. However, during activation and deactivation multiple active-connections can reference the same device or settings-connection as they are waiting to be activated or to be deactivated.</para> + <para> Objects that implement the Connection.Active interface represent an + attempt to connect to a network using the details provided by a Connection + object. The Connection.Active object tracks the life-cycle of the + connection attempt and if successful indicates whether the connected + network is the "default" or preferred network for access. NetworkManager + has the concept of connections, which can be thought of as settings, a + profile or a configuration that can be applied on a networking device. + Such settings-connections are exposed as D-Bus object and the + active-connection expresses this relationship between device and + settings-connection. At any time a settings-connection can only be + activated on one device and vice versa. However, during activation and + deactivation multiple active-connections can reference the same device or + settings-connection as they are waiting to be activated or to be + deactivated. +</para> </refsect1> <refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.Connection.Active"> <title role="details.title">Signal Details</title> @@ -60,7 +74,8 @@ PropertiesChanged (a{sv} properties); <programlisting> Connection readable o </programlisting> -<para>The path of the connection.</para> +<para> The path of the connection. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.SpecificObject"> <title>The "SpecificObject" property</title> @@ -68,7 +83,10 @@ Connection readable o <programlisting> SpecificObject readable o </programlisting> -<para>A specific object associated with the active connection. This property reflects the specific object used during connection activation, and will not change over the lifetime of the ActiveConnection once set.</para> +<para> A specific object associated with the active connection. This property + reflects the specific object used during connection activation, and will + not change over the lifetime of the ActiveConnection once set. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Id"> <title>The "Id" property</title> @@ -76,7 +94,9 @@ SpecificObject readable o <programlisting> Id readable s </programlisting> -<para>The ID of the connection, provided as a convenience so that clients do not have to retrieve all connection details.</para> +<para> The ID of the connection, provided as a convenience so that clients do not + have to retrieve all connection details. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Uuid"> <title>The "Uuid" property</title> @@ -84,7 +104,9 @@ Id readable s <programlisting> Uuid readable s </programlisting> -<para>The UUID of the connection, provided as a convenience so that clients do not have to retrieve all connection details.</para> +<para> The UUID of the connection, provided as a convenience so that clients do + not have to retrieve all connection details. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Type"> <title>The "Type" property</title> @@ -92,7 +114,9 @@ Uuid readable s <programlisting> Type readable s </programlisting> -<para>The type of the connection, provided as a convenience so that clients do not have to retrieve all connection details.</para> +<para> The type of the connection, provided as a convenience so that clients do + not have to retrieve all connection details. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Devices"> <title>The "Devices" property</title> @@ -100,7 +124,9 @@ Type readable s <programlisting> Devices readable ao </programlisting> -<para>Array of object paths representing devices which are part of this active connection.</para> +<para> Array of object paths representing devices which are part of this active + connection. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.State"> <title>The "State" property</title> @@ -108,7 +134,9 @@ Devices readable ao <programlisting> State readable u </programlisting> -<para>The state of this active connection.</para> +<para> The state of this active connection. +</para><para> Returns: <link linkend="NMActiveConnectionState">NMActiveConnectionState</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Default"> <title>The "Default" property</title> @@ -116,7 +144,9 @@ State readable u <programlisting> Default readable b </programlisting> -<para>Whether this active connection is the default IPv4 connection, i.e. whether it currently owns the default IPv4 route.</para> +<para> Whether this active connection is the default IPv4 connection, i.e. + whether it currently owns the default IPv4 route. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Ip4Config"> <title>The "Ip4Config" property</title> @@ -124,7 +154,10 @@ Default readable b <programlisting> Ip4Config readable o </programlisting> -<para>Object path of the Ip4Config object describing the configuration of the connection. Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.</para> +<para> Object path of the Ip4Config object describing the configuration of the + connection. Only valid when the connection is in the + NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Dhcp4Config"> <title>The "Dhcp4Config" property</title> @@ -132,7 +165,10 @@ Ip4Config readable o <programlisting> Dhcp4Config readable o </programlisting> -<para>Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server (assuming the connection used DHCP). Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.</para> +<para> Object path of the Dhcp4Config object describing the DHCP options returned + by the DHCP server (assuming the connection used DHCP). Only valid when + the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Default6"> <title>The "Default6" property</title> @@ -140,7 +176,9 @@ Dhcp4Config readable o <programlisting> Default6 readable b </programlisting> -<para>Whether this active connection is the default IPv6 connection, i.e. whether it currently owns the default IPv6 route.</para> +<para> Whether this active connection is the default IPv6 connection, i.e. + whether it currently owns the default IPv6 route. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Ip6Config"> <title>The "Ip6Config" property</title> @@ -148,7 +186,10 @@ Default6 readable b <programlisting> Ip6Config readable o </programlisting> -<para>Object path of the Ip6Config object describing the configuration of the connection. Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.</para> +<para> Object path of the Ip6Config object describing the configuration of the + connection. Only valid when the connection is in the + NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Dhcp6Config"> <title>The "Dhcp6Config" property</title> @@ -156,7 +197,10 @@ Ip6Config readable o <programlisting> Dhcp6Config readable o </programlisting> -<para>Object path of the Dhcp6Config object describing the DHCP options returned by the DHCP server (assuming the connection used DHCP). Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.</para> +<para> Object path of the Dhcp6Config object describing the DHCP options returned + by the DHCP server (assuming the connection used DHCP). Only valid when + the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Vpn"> <title>The "Vpn" property</title> @@ -164,7 +208,8 @@ Dhcp6Config readable o <programlisting> Vpn readable b </programlisting> -<para>Whether this active connection is also a VPN connection.</para> +<para> Whether this active connection is also a VPN connection. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Master"> <title>The "Master" property</title> @@ -172,7 +217,8 @@ Vpn readable b <programlisting> Master readable o </programlisting> -<para>The path to the master device if the connection is a slave.</para> +<para> The path to the master device if the connection is a slave. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml b/introspection/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml index 29bb71d7..2f074cbe 100644 --- a/introspection/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml +++ b/introspection/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml @@ -26,11 +26,13 @@ <programlisting> Register (IN s identifier); </programlisting> -<para>Called by secret Agents to register their ability to provide and save network secrets.</para> +<para> Called by secret Agents to register their ability to provide and save + network secrets. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN s <parameter>identifier</parameter></literal>:</term> - <listitem><para>Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes).</para></listitem> + <listitem><para>Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes).</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -41,7 +43,8 @@ Register (IN s identifier); RegisterWithCapabilities (IN s identifier, IN u capabilities); </programlisting> -<para>Like Register() but indicates agent capabilities to NetworkManager.</para> +<para> Like Register() but indicates agent capabilities to NetworkManager. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN s <parameter>identifier</parameter></literal>:</term> @@ -49,7 +52,7 @@ RegisterWithCapabilities (IN s identifier, </varlistentry> <varlistentry> <term><literal>IN u <parameter>capabilities</parameter></literal>:</term> - <listitem><para>Indicates various agent capabilities to NetworkManager.</para></listitem> + <listitem><para>(<link linkend="NMSecretAgentCapabilities">NMSecretAgentCapabilities</link>) Indicates various agent capabilities to NetworkManager.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -59,7 +62,10 @@ RegisterWithCapabilities (IN s identifier, <programlisting> Unregister (); </programlisting> -<para>Called by secret Agents to notify NetworkManager that they will no longer handle requests for network secrets. Agents are automatically unregistered when they disconnect from D-Bus.</para> +<para> Called by secret Agents to notify NetworkManager that they will no longer + handle requests for network secrets. Agents are automatically unregistered + when they disconnect from D-Bus. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml b/introspection/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml index ab85429d..b4a15c7d 100644 --- a/introspection/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml +++ b/introspection/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml @@ -46,7 +46,8 @@ PropertiesChanged (a{sv} properties); <programlisting> Carrier readable b </programlisting> -<para>Indicates whether the physical carrier is found.</para> +<para> Indicates whether the physical carrier is found. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml b/introspection/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml index 22bd4ccf..1d9788ee 100644 --- a/introspection/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml +++ b/introspection/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml @@ -48,7 +48,8 @@ PropertiesChanged (a{sv} properties); <programlisting> HwAddress readable s </programlisting> -<para>Hardware address of the device.</para> +<para> Hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Bond.Carrier"> <title>The "Carrier" property</title> @@ -56,7 +57,9 @@ HwAddress readable s <programlisting> Carrier readable b </programlisting> -<para>Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).</para> +<para> Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Bond.Slaves"> <title>The "Slaves" property</title> @@ -64,7 +67,9 @@ Carrier readable b <programlisting> Slaves readable ao </programlisting> -<para>Array of object paths representing devices which are currently slaved to this device.</para> +<para> Array of object paths representing devices which are currently slaved to + this device. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml b/introspection/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml index 20946e34..7bfe783e 100644 --- a/introspection/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml +++ b/introspection/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml @@ -48,7 +48,8 @@ PropertiesChanged (a{sv} properties); <programlisting> HwAddress readable s </programlisting> -<para>Hardware address of the device.</para> +<para> Hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Bridge.Carrier"> <title>The "Carrier" property</title> @@ -56,7 +57,9 @@ HwAddress readable s <programlisting> Carrier readable b </programlisting> -<para>Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).</para> +<para> Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Bridge.Slaves"> <title>The "Slaves" property</title> @@ -64,7 +67,9 @@ Carrier readable b <programlisting> Slaves readable ao </programlisting> -<para>Array of object paths representing devices which are currently slaved to this device.</para> +<para> Array of object paths representing devices which are currently slaved to + this device. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml b/introspection/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml index 7cca9d2c..050fccf4 100644 --- a/introspection/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml +++ b/introspection/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml @@ -48,7 +48,8 @@ PropertiesChanged (a{sv} properties); <programlisting> HwAddress readable s </programlisting> -<para>Bluetooth hardware address of the device.</para> +<para> Bluetooth hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Bluetooth.Name"> <title>The "Name" property</title> @@ -56,7 +57,8 @@ HwAddress readable s <programlisting> Name readable s </programlisting> -<para>Bluetooth name of the device.</para> +<para> Bluetooth name of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Bluetooth.BtCapabilities"> <title>The "BtCapabilities" property</title> @@ -64,7 +66,9 @@ Name readable s <programlisting> BtCapabilities readable u </programlisting> -<para>Bluetooth capabilities of the device (either DUN or NAP).</para> +<para> Bluetooth capabilities of the device (either DUN or NAP). +</para><para> Returns: <link linkend="NMBluetoothCapabilities">NMBluetoothCapabilities</link> +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml b/introspection/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml index ef6e7e8b..f97f8f37 100644 --- a/introspection/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml +++ b/introspection/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml @@ -50,7 +50,8 @@ PropertiesChanged (a{sv} properties); <programlisting> HwAddress readable s </programlisting> -<para>Active hardware address of the device.</para> +<para> Active hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Wired.PermHwAddress"> <title>The "PermHwAddress" property</title> @@ -58,7 +59,8 @@ HwAddress readable s <programlisting> PermHwAddress readable s </programlisting> -<para>Permanent hardware address of the device.</para> +<para> Permanent hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Wired.Speed"> <title>The "Speed" property</title> @@ -66,7 +68,8 @@ PermHwAddress readable s <programlisting> Speed readable u </programlisting> -<para>Design speed of the device, in megabits/second (Mb/s).</para> +<para> Design speed of the device, in megabits/second (Mb/s). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Wired.S390Subchannels"> <title>The "S390Subchannels" property</title> @@ -74,7 +77,8 @@ Speed readable u <programlisting> S390Subchannels readable as </programlisting> -<para>Array of S/390 subchannels for S/390 or z/Architecture devices.</para> +<para> Array of S/390 subchannels for S/390 or z/Architecture devices. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Wired.Carrier"> <title>The "Carrier" property</title> @@ -82,7 +86,9 @@ S390Subchannels readable as <programlisting> Carrier readable b </programlisting> -<para>Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).</para> +<para> Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml b/introspection/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml index 13d81172..dc2cdbe8 100644 --- a/introspection/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml +++ b/introspection/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml @@ -47,7 +47,8 @@ PropertiesChanged (a{sv} properties); <programlisting> HwAddress readable s </programlisting> -<para>Hardware address of the device.</para> +<para> Hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Generic.TypeDescription"> <title>The "TypeDescription" property</title> @@ -55,7 +56,8 @@ HwAddress readable s <programlisting> TypeDescription readable s </programlisting> -<para>A (non-localized) description of the interface type, if known.</para> +<para> A (non-localized) description of the interface type, if known. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml b/introspection/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml index bbafdbfc..f7957eed 100644 --- a/introspection/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml +++ b/introspection/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml @@ -47,7 +47,8 @@ PropertiesChanged (a{sv} properties); <programlisting> HwAddress readable s </programlisting> -<para>Hardware address of the device.</para> +<para> Hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Infiniband.Carrier"> <title>The "Carrier" property</title> @@ -55,7 +56,9 @@ HwAddress readable s <programlisting> Carrier readable b </programlisting> -<para>Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).</para> +<para> Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml b/introspection/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml index f1a8bba7..3b59de03 100644 --- a/introspection/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml +++ b/introspection/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml @@ -56,7 +56,8 @@ PropertiesChanged (a{sv} properties); <programlisting> Mode readable u </programlisting> -<para>The tunneling mode.</para> +<para> The tunneling mode. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Parent"> <title>The "Parent" property</title> @@ -64,7 +65,8 @@ Mode readable u <programlisting> Parent readable o </programlisting> -<para>The object path of the parent device.</para> +<para> The object path of the parent device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Local"> <title>The "Local" property</title> @@ -72,7 +74,8 @@ Parent readable o <programlisting> Local readable s </programlisting> -<para>The local endpoint of the tunnel.</para> +<para> The local endpoint of the tunnel. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Remote"> <title>The "Remote" property</title> @@ -80,7 +83,8 @@ Local readable s <programlisting> Remote readable s </programlisting> -<para>The remote endpoint of the tunnel.</para> +<para> The remote endpoint of the tunnel. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Ttl"> <title>The "Ttl" property</title> @@ -88,7 +92,9 @@ Remote readable s <programlisting> Ttl readable y </programlisting> -<para>The TTL assigned to tunneled packets. 0 is a special value meaning that packets inherit the TTL value</para> +<para> The TTL assigned to tunneled packets. 0 is a special value meaning that + packets inherit the TTL value +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Tos"> <title>The "Tos" property</title> @@ -96,7 +102,9 @@ Ttl readable y <programlisting> Tos readable y </programlisting> -<para>The type of service (IPv4) or traffic class (IPv6) assigned to tunneled packets.</para> +<para> The type of service (IPv4) or traffic class (IPv6) assigned to tunneled + packets. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.PathMtuDiscovery"> <title>The "PathMtuDiscovery" property</title> @@ -104,7 +112,8 @@ Tos readable y <programlisting> PathMtuDiscovery readable b </programlisting> -<para>Whether path MTU discovery is enabled on this tunnel.</para> +<para> Whether path MTU discovery is enabled on this tunnel. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.InputKey"> <title>The "InputKey" property</title> @@ -112,7 +121,8 @@ PathMtuDiscovery readable b <programlisting> InputKey readable s </programlisting> -<para>The key used for incoming packets.</para> +<para> The key used for incoming packets. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.OutputKey"> <title>The "OutputKey" property</title> @@ -120,7 +130,8 @@ InputKey readable s <programlisting> OutputKey readable s </programlisting> -<para>The key used for outgoing packets.</para> +<para> The key used for outgoing packets. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.EncapsulationLimit"> <title>The "EncapsulationLimit" property</title> @@ -128,7 +139,9 @@ OutputKey readable s <programlisting> EncapsulationLimit readable y </programlisting> -<para>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</para> +<para> How many additional levels of encapsulation are permitted to be prepended + to packets. This property applies only to IPv6 tunnels. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.FlowLabel"> <title>The "FlowLabel" property</title> @@ -136,7 +149,9 @@ EncapsulationLimit readable y <programlisting> FlowLabel readable u </programlisting> -<para>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</para> +<para> The flow label to assign to tunnel packets. This property applies only to + IPv6 tunnels. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml b/introspection/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml index ca5d7367..b1b63d8b 100644 --- a/introspection/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml +++ b/introspection/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml @@ -49,7 +49,8 @@ PropertiesChanged (a{sv} properties); <programlisting> Parent readable o </programlisting> -<para>The object path of the parent device.</para> +<para> The object path of the parent device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Macvlan.Mode"> <title>The "Mode" property</title> @@ -57,7 +58,8 @@ Parent readable o <programlisting> Mode readable s </programlisting> -<para>The macvlan mode, one of "private", "vepa", "bridge", or "passthru".</para> +<para> The macvlan mode, one of "private", "vepa", "bridge", or "passthru". +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Macvlan.NoPromisc"> <title>The "NoPromisc" property</title> @@ -65,7 +67,8 @@ Mode readable s <programlisting> NoPromisc readable b </programlisting> -<para>Whether the device is blocked from going into promiscuous mode.</para> +<para> Whether the device is blocked from going into promiscuous mode. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Macvlan.Tap"> <title>The "Tap" property</title> @@ -73,7 +76,8 @@ NoPromisc readable b <programlisting> Tap readable b </programlisting> -<para>Whether the device is a macvtap.</para> +<para> Whether the device is a macvtap. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml b/introspection/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml index 2143ef62..839f426c 100644 --- a/introspection/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml +++ b/introspection/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml @@ -47,7 +47,12 @@ PropertiesChanged (a{sv} properties); <programlisting> ModemCapabilities readable u </programlisting> -<para>The generic family of access technologies the modem supports. Not all capabilities are available at the same time however; some modems require a firmware reload or other reinitialization to switch between eg CDMA/EVDO and GSM/UMTS.</para> +<para> The generic family of access technologies the modem supports. Not all + capabilities are available at the same time however; some modems require a + firmware reload or other reinitialization to switch between eg CDMA/EVDO + and GSM/UMTS. +</para><para> Returns: <link linkend="NMDeviceModemCapabilities">NMDeviceModemCapabilities</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Modem.CurrentCapabilities"> <title>The "CurrentCapabilities" property</title> @@ -55,7 +60,10 @@ ModemCapabilities readable u <programlisting> CurrentCapabilities readable u </programlisting> -<para>The generic family of access technologies the modem currently supports without a firmware reload or reinitialization.</para> +<para> The generic family of access technologies the modem currently supports + without a firmware reload or reinitialization. +</para><para> Returns: <link linkend="NMDeviceModemCapabilities">NMDeviceModemCapabilities</link> +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml b/introspection/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml index 4a512547..8eae57ef 100644 --- a/introspection/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml +++ b/introspection/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml @@ -31,7 +31,8 @@ <programlisting> PropertiesChanged (a{sv} properties); </programlisting> -<para>Emitted when the wireless device's properties changed.</para> +<para> Emitted when the wireless device's properties changed. +</para> <variablelist role="params"> <varlistentry> <term><literal>a{sv} <parameter>properties</parameter></literal>:</term> @@ -48,7 +49,8 @@ PropertiesChanged (a{sv} properties); <programlisting> HwAddress readable s </programlisting> -<para>The hardware address of the device.</para> +<para> The hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-OlpcMesh.Companion"> <title>The "Companion" property</title> @@ -56,7 +58,8 @@ HwAddress readable s <programlisting> Companion readable o </programlisting> -<para>The object path of the companion device.</para> +<para> The object path of the companion device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-OlpcMesh.ActiveChannel"> <title>The "ActiveChannel" property</title> @@ -64,7 +67,8 @@ Companion readable o <programlisting> ActiveChannel readable u </programlisting> -<para>The currently active channel.</para> +<para> The currently active channel. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-org.freedesktop.NetworkManager.Device.xml b/introspection/nmdbus-device-org.freedesktop.NetworkManager.Device.xml index a5a0697b..883c5d75 100644 --- a/introspection/nmdbus-device-org.freedesktop.NetworkManager.Device.xml +++ b/introspection/nmdbus-device-org.freedesktop.NetworkManager.Device.xml @@ -71,19 +71,39 @@ Reapply (IN a{sa{sv}} connection, IN t version_id, IN u flags); </programlisting> -<para>Attempts to update the configuration of a device without deactivating it. NetworkManager has the concept of connections, which are profiles that contain the configuration for a networking device. Those connections are exposed via D-Bus as individual objects that can be created, modified and deleted. When activating such a settings-connection on a device, the settings-connection is cloned to become an applied-connection and used to configure the device (see GetAppliedConnection). Subsequent modification of the settings-connection don't propagate automatically to the device's applied-connection (with exception of the firewall-zone and the metered property). For the changes to take effect, you can either re-activate the settings-connection, or call Reapply. The Reapply call allows you to directly update the applied-connection and reconfigure the device. Reapply can also be useful if the currently applied-connection is equal to the connection that is about to be reapplied. This allows to reconfigure the device and revert external changes like removing or adding an IP address (which NetworkManager doesn't revert automatically because it is assumed that the user made these changes intentionally outside of NetworkManager). Reapply can make the applied-connection different from the settings-connection, just like updating the settings-connection can make them different.</para> +<para> Attempts to update the configuration of a device without deactivating it. + NetworkManager has the concept of connections, which are profiles that + contain the configuration for a networking device. Those connections are + exposed via D-Bus as individual objects that can be created, modified and + deleted. When activating such a settings-connection on a device, the + settings-connection is cloned to become an applied-connection and used to + configure the device (see GetAppliedConnection). Subsequent modification + of the settings-connection don't propagate automatically to the device's + applied-connection (with exception of the firewall-zone and the metered + property). For the changes to take effect, you can either re-activate the + settings-connection, or call Reapply. The Reapply call allows you to + directly update the applied-connection and reconfigure the device. Reapply + can also be useful if the currently applied-connection is equal to the + connection that is about to be reapplied. This allows to reconfigure the + device and revert external changes like removing or adding an IP address + (which NetworkManager doesn't revert automatically because it is assumed + that the user made these changes intentionally outside of NetworkManager). + Reapply can make the applied-connection different from the + settings-connection, just like updating the settings-connection can make + them different. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>connection</parameter></literal>:</term> - <listitem><para>The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarly differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses.</para></listitem> + <listitem><para>The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarly differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN t <parameter>version_id</parameter></literal>:</term> - <listitem><para>If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply.</para></listitem> + <listitem><para>If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN u <parameter>flags</parameter></literal>:</term> - <listitem><para>Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0.</para></listitem> + <listitem><para>Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -95,11 +115,18 @@ GetAppliedConnection (IN u flags, OUT a{sa{sv}} connection, OUT t version_id); </programlisting> -<para>Get the currently applied connection on the device. This is a snapshot of the last activated connection on the device, that is the configuration that is currently applied on the device. Usually this is the same as GetSettings of the referenced settings connection. However, it can differ if the settings connection was subsequently modified or the applied connection was modified by Reapply. The applied connection is set when activating a device or when calling Reapply.</para> +<para> Get the currently applied connection on the device. This is a snapshot of + the last activated connection on the device, that is the configuration + that is currently applied on the device. Usually this is the same as + GetSettings of the referenced settings connection. However, it can differ + if the settings connection was subsequently modified or the applied + connection was modified by Reapply. The applied connection is set when + activating a device or when calling Reapply. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN u <parameter>flags</parameter></literal>:</term> - <listitem><para>Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0.</para></listitem> + <listitem><para>Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0.</para></listitem> </varlistentry> <varlistentry> <term><literal>OUT a{sa{sv}} <parameter>connection</parameter></literal>:</term> @@ -107,7 +134,7 @@ GetAppliedConnection (IN u flags, </varlistentry> <varlistentry> <term><literal>OUT t <parameter>version_id</parameter></literal>:</term> - <listitem><para>The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail.</para></listitem> + <listitem><para>The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -117,7 +144,9 @@ GetAppliedConnection (IN u flags, <programlisting> Disconnect (); </programlisting> -<para>Disconnects a device and prevents the device from automatically activating further connections without user intervention.</para> +<para> Disconnects a device and prevents the device from automatically activating + further connections without user intervention. +</para> </refsect2> <refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Device.Delete"> <title>The Delete() method</title> @@ -125,7 +154,10 @@ Disconnect (); <programlisting> Delete (); </programlisting> -<para>Deletes a software device from NetworkManager and removes the interface from the system. The method returns an error when called for a hardware device.</para> +<para> Deletes a software device from NetworkManager and removes the interface + from the system. The method returns an error when called for a hardware + device. +</para> </refsect2> </refsect1> <refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.Device"> @@ -142,15 +174,15 @@ StateChanged (u new_state, <variablelist role="params"> <varlistentry> <term><literal>u <parameter>new_state</parameter></literal>:</term> - <listitem><para>The new state of the device.</para></listitem> + <listitem><para>(<link linkend="NMDeviceState">NMDeviceState</link>) The new state of the device.</para></listitem> </varlistentry> <varlistentry> <term><literal>u <parameter>old_state</parameter></literal>:</term> - <listitem><para>The previous state of the device.</para></listitem> + <listitem><para>(<link linkend="NMDeviceState">NMDeviceState</link>) The previous state of the device.</para></listitem> </varlistentry> <varlistentry> <term><literal>u <parameter>reason</parameter></literal>:</term> - <listitem><para>A reason for the state transition.</para></listitem> + <listitem><para>(<link linkend="NMDeviceStateReason">NMDeviceStateReason</link>) A reason for the state transition.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -163,7 +195,18 @@ StateChanged (u new_state, <programlisting> Udi readable s </programlisting> -<para>Operating-system specific transient device hardware identifier. This is an opaque string representing the underlying hardware for the device, and shouldn't be used to keep track of individual devices. For some device types (Bluetooth, Modems) it is an identifier used by the hardware service (ie bluez or ModemManager) to refer to that device, and client programs use it get additional information from those services which NM does not provide. The Udi is not guaranteed to be consistent across reboots or hotplugs of the hardware. If you're looking for a way to uniquely track each device in your application, use the object path. If you're looking for a way to track a specific piece of hardware across reboot or hotplug, use a MAC address or USB serial number.</para> +<para> Operating-system specific transient device hardware identifier. This is an + opaque string representing the underlying hardware for the device, and + shouldn't be used to keep track of individual devices. For some device + types (Bluetooth, Modems) it is an identifier used by the hardware service + (ie bluez or ModemManager) to refer to that device, and client programs + use it get additional information from those services which NM does not + provide. The Udi is not guaranteed to be consistent across reboots or + hotplugs of the hardware. If you're looking for a way to uniquely track + each device in your application, use the object path. If you're looking + for a way to track a specific piece of hardware across reboot or hotplug, + use a MAC address or USB serial number. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Interface"> <title>The "Interface" property</title> @@ -171,7 +214,8 @@ Udi readable s <programlisting> Interface readable s </programlisting> -<para>The name of the device's control (and often data) interface.</para> +<para> The name of the device's control (and often data) interface. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.IpInterface"> <title>The "IpInterface" property</title> @@ -179,7 +223,11 @@ Interface readable s <programlisting> IpInterface readable s </programlisting> -<para>The name of the device's data interface when available. This property may not refer to the actual data interface until the device has successfully established a data connection, indicated by the device's State becoming ACTIVATED.</para> +<para> The name of the device's data interface when available. This property may + not refer to the actual data interface until the device has successfully + established a data connection, indicated by the device's State becoming + ACTIVATED. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Driver"> <title>The "Driver" property</title> @@ -187,7 +235,8 @@ IpInterface readable s <programlisting> Driver readable s </programlisting> -<para>The driver handling the device.</para> +<para> The driver handling the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.DriverVersion"> <title>The "DriverVersion" property</title> @@ -195,7 +244,8 @@ Driver readable s <programlisting> DriverVersion readable s </programlisting> -<para>The version of the driver handling the device.</para> +<para> The version of the driver handling the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.FirmwareVersion"> <title>The "FirmwareVersion" property</title> @@ -203,7 +253,8 @@ DriverVersion readable s <programlisting> FirmwareVersion readable s </programlisting> -<para>The firmware version for the device.</para> +<para> The firmware version for the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Capabilities"> <title>The "Capabilities" property</title> @@ -211,7 +262,9 @@ FirmwareVersion readable s <programlisting> Capabilities readable u </programlisting> -<para>Flags describing the capabilities of the device.</para> +<para> Flags describing the capabilities of the device. +</para><para> Returns: <link linkend="NMDeviceCapabilities">NMDeviceCapabilities</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Ip4Address"> <title>The "Ip4Address" property</title> @@ -219,7 +272,9 @@ Capabilities readable u <programlisting> Ip4Address readable u </programlisting> -<para>DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object instead.</para> +<para> DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object + instead. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.State"> <title>The "State" property</title> @@ -227,7 +282,9 @@ Ip4Address readable u <programlisting> State readable u </programlisting> -<para>The current state of the device.</para> +<para> The current state of the device. +</para><para> Returns: <link linkend="NMDeviceState">NMDeviceState</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.StateReason"> <title>The "StateReason" property</title> @@ -235,7 +292,9 @@ State readable u <programlisting> StateReason readable (uu) </programlisting> -<para>The current state and reason for changing to that state.</para> +<para> The current state and reason for changing to that state. +</para><para> Returns: A tuple of <link linkend="NMDeviceState">NMDeviceState</link> and <link linkend="NMDeviceStateReason">NMDeviceStateReason</link>. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.ActiveConnection"> <title>The "ActiveConnection" property</title> @@ -243,7 +302,11 @@ StateReason readable (uu) <programlisting> ActiveConnection readable o </programlisting> -<para>Object path of an ActiveConnection object that "owns" this device during activation. The ActiveConnection object tracks the life-cycle of a connection to a specific network and implements the org.freedesktop.NetworkManager.Connection.Active D-Bus interface.</para> +<para> Object path of an ActiveConnection object that "owns" this device during + activation. The ActiveConnection object tracks the life-cycle of a + connection to a specific network and implements the + org.freedesktop.NetworkManager.Connection.Active D-Bus interface. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Ip4Config"> <title>The "Ip4Config" property</title> @@ -251,7 +314,10 @@ ActiveConnection readable o <programlisting> Ip4Config readable o </programlisting> -<para>Object path of the Ip4Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.</para> +<para> Object path of the Ip4Config object describing the configuration of the + device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED + state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Dhcp4Config"> <title>The "Dhcp4Config" property</title> @@ -259,7 +325,10 @@ Ip4Config readable o <programlisting> Dhcp4Config readable o </programlisting> -<para>Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.</para> +<para> Object path of the Dhcp4Config object describing the DHCP options returned + by the DHCP server. Only valid when the device is in the + NM_DEVICE_STATE_ACTIVATED state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Ip6Config"> <title>The "Ip6Config" property</title> @@ -267,7 +336,10 @@ Dhcp4Config readable o <programlisting> Ip6Config readable o </programlisting> -<para>Object path of the Ip6Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.</para> +<para> Object path of the Ip6Config object describing the configuration of the + device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED + state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Dhcp6Config"> <title>The "Dhcp6Config" property</title> @@ -275,7 +347,10 @@ Ip6Config readable o <programlisting> Dhcp6Config readable o </programlisting> -<para>Object path of the Dhcp6Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.</para> +<para> Object path of the Dhcp6Config object describing the DHCP options returned + by the DHCP server. Only valid when the device is in the + NM_DEVICE_STATE_ACTIVATED state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Managed"> <title>The "Managed" property</title> @@ -283,7 +358,11 @@ Dhcp6Config readable o <programlisting> Managed readwrite b </programlisting> -<para>Whether or not this device is managed by NetworkManager. Setting this property has a similar effect to configuring the device as unmanaged via the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to this value are not persistent and lost after NetworkManager restart.</para> +<para> Whether or not this device is managed by NetworkManager. Setting this + property has a similar effect to configuring the device as unmanaged via + the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to + this value are not persistent and lost after NetworkManager restart. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Autoconnect"> <title>The "Autoconnect" property</title> @@ -291,7 +370,12 @@ Managed readwrite b <programlisting> Autoconnect readwrite b </programlisting> -<para>If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual intervention is required before the device will automatically connect to a known network, such as activating a connection using the device, or setting this property to TRUE. This property cannot be set to TRUE for default-unmanaged devices, since they never autoconnect.</para> +<para> If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual + intervention is required before the device will automatically connect to a + known network, such as activating a connection using the device, or + setting this property to TRUE. This property cannot be set to TRUE for + default-unmanaged devices, since they never autoconnect. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.FirmwareMissing"> <title>The "FirmwareMissing" property</title> @@ -299,7 +383,9 @@ Autoconnect readwrite b <programlisting> FirmwareMissing readable b </programlisting> -<para>If TRUE, indicates the device is likely missing firmware necessary for its operation.</para> +<para> If TRUE, indicates the device is likely missing firmware necessary for its + operation. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.NmPluginMissing"> <title>The "NmPluginMissing" property</title> @@ -307,7 +393,9 @@ FirmwareMissing readable b <programlisting> NmPluginMissing readable b </programlisting> -<para>If TRUE, indicates the NetworkManager plugin for the device is likely missing or misconfigured.</para> +<para> If TRUE, indicates the NetworkManager plugin for the device is likely + missing or misconfigured. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.DeviceType"> <title>The "DeviceType" property</title> @@ -315,7 +403,9 @@ NmPluginMissing readable b <programlisting> DeviceType readable u </programlisting> -<para>The general type of the network device; ie Ethernet, WiFi, etc.</para> +<para> The general type of the network device; ie Ethernet, WiFi, etc. +</para><para> Returns: <link linkend="NMDeviceType">NMDeviceType</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.AvailableConnections"> <title>The "AvailableConnections" property</title> @@ -323,7 +413,9 @@ DeviceType readable u <programlisting> AvailableConnections readable ao </programlisting> -<para>An array of object paths of every configured connection that is currently 'available' through this device.</para> +<para> An array of object paths of every configured connection that is currently + 'available' through this device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.PhysicalPortId"> <title>The "PhysicalPortId" property</title> @@ -331,7 +423,11 @@ AvailableConnections readable ao <programlisting> PhysicalPortId readable s </programlisting> -<para>If non-empty, an (opaque) indicator of the physical network port associated with the device. This can be used to recognize when two seemingly-separate hardware devices are actually just different virtual interfaces to the same physical port.</para> +<para> If non-empty, an (opaque) indicator of the physical network port + associated with the device. This can be used to recognize when two + seemingly-separate hardware devices are actually just different virtual + interfaces to the same physical port. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Mtu"> <title>The "Mtu" property</title> @@ -339,7 +435,8 @@ PhysicalPortId readable s <programlisting> Mtu readable u </programlisting> -<para>The device MTU (maximum transmission unit).</para> +<para> The device MTU (maximum transmission unit). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Metered"> <title>The "Metered" property</title> @@ -347,7 +444,10 @@ Mtu readable u <programlisting> Metered readable u </programlisting> -<para>Whether the amount of traffic flowing through the device is subject to limitations, for example set by service providers.</para> +<para> Whether the amount of traffic flowing through the device is subject to + limitations, for example set by service providers. +</para><para> Returns: <link linkend="NMMetered">NMMetered</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.LldpNeighbors"> <title>The "LldpNeighbors" property</title> @@ -355,7 +455,9 @@ Metered readable u <programlisting> LldpNeighbors readable aa{sv} </programlisting> -<para>Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV names to variant boxed values.</para> +<para> Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV + names to variant boxed values. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device.Real"> <title>The "Real" property</title> @@ -363,7 +465,10 @@ LldpNeighbors readable aa{sv} <programlisting> Real readable b </programlisting> -<para>True if the device exists, or False for placeholder devices that do not yet exist but could be automatically created by NetworkManager if one of their AvailableConnections was activated.</para> +<para> True if the device exists, or False for placeholder devices that do not + yet exist but could be automatically created by NetworkManager if one of + their AvailableConnections was activated. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml b/introspection/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml index 6d6ae5aa..5fc0d238 100644 --- a/introspection/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml +++ b/introspection/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml @@ -48,7 +48,8 @@ PropertiesChanged (a{sv} properties); <programlisting> HwAddress readable s </programlisting> -<para>Hardware address of the device.</para> +<para> Hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Team.Carrier"> <title>The "Carrier" property</title> @@ -56,7 +57,9 @@ HwAddress readable s <programlisting> Carrier readable b </programlisting> -<para>Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).</para> +<para> Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Team.Slaves"> <title>The "Slaves" property</title> @@ -64,7 +67,9 @@ Carrier readable b <programlisting> Slaves readable ao </programlisting> -<para>Array of object paths representing devices which are currently slaved to this device.</para> +<para> Array of object paths representing devices which are currently slaved to + this device. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml b/introspection/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml index c676e395..11c71961 100644 --- a/introspection/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml +++ b/introspection/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml @@ -52,7 +52,8 @@ PropertiesChanged (a{sv} properties); <programlisting> Owner readable x </programlisting> -<para>The uid of the tunnel owner, or -1 if it has no owner.</para> +<para> The uid of the tunnel owner, or -1 if it has no owner. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Tun.Group"> <title>The "Group" property</title> @@ -60,7 +61,8 @@ Owner readable x <programlisting> Group readable x </programlisting> -<para>The gid of the tunnel group, or -1 if it has no owner.</para> +<para> The gid of the tunnel group, or -1 if it has no owner. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Tun.Mode"> <title>The "Mode" property</title> @@ -68,7 +70,8 @@ Group readable x <programlisting> Mode readable s </programlisting> -<para>The tunnel mode, either "tun" or "tap".</para> +<para> The tunnel mode, either "tun" or "tap". +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Tun.NoPi"> <title>The "NoPi" property</title> @@ -76,7 +79,9 @@ Mode readable s <programlisting> NoPi readable b </programlisting> -<para>The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to the tunnel packets.</para> +<para> The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to + the tunnel packets. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Tun.VnetHdr"> <title>The "VnetHdr" property</title> @@ -84,7 +89,9 @@ NoPi readable b <programlisting> VnetHdr readable b </programlisting> -<para>The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a virtio network header.</para> +<para> The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a + virtio network header. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Tun.MultiQueue"> <title>The "MultiQueue" property</title> @@ -92,7 +99,9 @@ VnetHdr readable b <programlisting> MultiQueue readable b </programlisting> -<para>The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap device multiple times, for multiple send/receive queues.</para> +<para> The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap + device multiple times, for multiple send/receive queues. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Tun.HwAddress"> <title>The "HwAddress" property</title> @@ -100,7 +109,8 @@ MultiQueue readable b <programlisting> HwAddress readable s </programlisting> -<para>Hardware address of the device.</para> +<para> Hardware address of the device. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml b/introspection/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml index f1e1d03a..b097e4f7 100644 --- a/introspection/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml +++ b/introspection/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml @@ -46,7 +46,8 @@ PropertiesChanged (a{sv} properties); <programlisting> Peer readable o </programlisting> -<para>The object path of the device's peer.</para> +<para> The object path of the device's peer. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml b/introspection/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml index fd07a398..2d0f9cfd 100644 --- a/introspection/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml +++ b/introspection/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml @@ -49,7 +49,8 @@ PropertiesChanged (a{sv} properties); <programlisting> HwAddress readable s </programlisting> -<para>Hardware address of the device.</para> +<para> Hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vlan.Carrier"> <title>The "Carrier" property</title> @@ -57,7 +58,9 @@ HwAddress readable s <programlisting> Carrier readable b </programlisting> -<para>Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).</para> +<para> Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vlan.Parent"> <title>The "Parent" property</title> @@ -65,7 +68,8 @@ Carrier readable b <programlisting> Parent readable o </programlisting> -<para>Object path of the parent device of this VLAN device.</para> +<para> Object path of the parent device of this VLAN device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vlan.VlanId"> <title>The "VlanId" property</title> @@ -73,7 +77,8 @@ Parent readable o <programlisting> VlanId readable u </programlisting> -<para>The VLAN ID of this VLAN interface.</para> +<para> The VLAN ID of this VLAN interface. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml b/introspection/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml index b755dcb2..b36a9f09 100644 --- a/introspection/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml +++ b/introspection/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml @@ -62,7 +62,9 @@ PropertiesChanged (a{sv} properties); <programlisting> Parent readable o </programlisting> -<para>The object path of the parent device (if the VXLAN is not purely internal to this host).</para> +<para> The object path of the parent device (if the VXLAN is not purely internal + to this host). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.HwAddress"> <title>The "HwAddress" property</title> @@ -70,7 +72,8 @@ Parent readable o <programlisting> HwAddress readable s </programlisting> -<para>Hardware address of the device.</para> +<para> Hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.Id"> <title>The "Id" property</title> @@ -78,7 +81,8 @@ HwAddress readable s <programlisting> Id readable u </programlisting> -<para>The VXLAN Network Identifier (VNI).</para> +<para> The VXLAN Network Identifier (VNI). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.Group"> <title>The "Group" property</title> @@ -86,7 +90,9 @@ Id readable u <programlisting> Group readable s </programlisting> -<para>The IP (v4 or v6) multicast group used to communicate with other physical hosts on this VXLAN.</para> +<para> The IP (v4 or v6) multicast group used to communicate with other physical + hosts on this VXLAN. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.Local"> <title>The "Local" property</title> @@ -94,7 +100,9 @@ Group readable s <programlisting> Local readable s </programlisting> -<para>The local IPv4 or IPv6 address to use when sending VXLAN packets to other physical hosts.</para> +<para> The local IPv4 or IPv6 address to use when sending VXLAN packets to other + physical hosts. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.Tos"> <title>The "Tos" property</title> @@ -102,7 +110,9 @@ Local readable s <programlisting> Tos readable y </programlisting> -<para>The value to use in the IP ToS field for VXLAN packets sent to other physical hosts.</para> +<para> The value to use in the IP ToS field for VXLAN packets sent to other + physical hosts. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.Ttl"> <title>The "Ttl" property</title> @@ -110,7 +120,9 @@ Tos readable y <programlisting> Ttl readable y </programlisting> -<para>The value to use in the IP TTL field for VXLAN packets sent to other physical hosts.</para> +<para> The value to use in the IP TTL field for VXLAN packets sent to other + physical hosts. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.Learning"> <title>The "Learning" property</title> @@ -118,7 +130,8 @@ Ttl readable y <programlisting> Learning readable b </programlisting> -<para>True if the VXLAN dynamically learns remote IP addresses.</para> +<para> True if the VXLAN dynamically learns remote IP addresses. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.Ageing"> <title>The "Ageing" property</title> @@ -126,7 +139,8 @@ Learning readable b <programlisting> Ageing readable u </programlisting> -<para>The interval in seconds at which the kernel purges stale cached addresses.</para> +<para> The interval in seconds at which the kernel purges stale cached addresses. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.Limit"> <title>The "Limit" property</title> @@ -134,7 +148,9 @@ Ageing readable u <programlisting> Limit readable u </programlisting> -<para>The maximum number of entries that can be added to the VXLAN's forwarding table.</para> +<para> The maximum number of entries that can be added to the VXLAN's forwarding + table. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.DstPort"> <title>The "DstPort" property</title> @@ -142,7 +158,8 @@ Limit readable u <programlisting> DstPort readable q </programlisting> -<para>Destination port for outgoing VXLAN packets.</para> +<para> Destination port for outgoing VXLAN packets. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.SrcPortMin"> <title>The "SrcPortMin" property</title> @@ -150,7 +167,8 @@ DstPort readable q <programlisting> SrcPortMin readable q </programlisting> -<para>The lowest source port number to use for outgoing VXLAN packets.</para> +<para> The lowest source port number to use for outgoing VXLAN packets. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.SrcPortMax"> <title>The "SrcPortMax" property</title> @@ -158,7 +176,8 @@ SrcPortMin readable q <programlisting> SrcPortMax readable q </programlisting> -<para>The highest source port number to use for outgoing VXLAN packets.</para> +<para> The highest source port number to use for outgoing VXLAN packets. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.Proxy"> <title>The "Proxy" property</title> @@ -166,7 +185,8 @@ SrcPortMax readable q <programlisting> Proxy readable b </programlisting> -<para>True if the VXLAN is implementing DOVE ARP proxying for remote clients.</para> +<para> True if the VXLAN is implementing DOVE ARP proxying for remote clients. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.Rsc"> <title>The "Rsc" property</title> @@ -174,7 +194,9 @@ Proxy readable b <programlisting> Rsc readable b </programlisting> -<para>True if the VXLAN is implementing DOVE route short-circuiting of known remote IP addresses.</para> +<para> True if the VXLAN is implementing DOVE route short-circuiting of known + remote IP addresses. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.L2miss"> <title>The "L2miss" property</title> @@ -182,7 +204,8 @@ Rsc readable b <programlisting> L2miss readable b </programlisting> -<para>True if the VXLAN will emit netlink notifications of L2 switch misses.</para> +<para> True if the VXLAN will emit netlink notifications of L2 switch misses. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Vxlan.L3miss"> <title>The "L3miss" property</title> @@ -190,7 +213,8 @@ L2miss readable b <programlisting> L3miss readable b </programlisting> -<para>True if the VXLAN will emit netlink notifications of L3 switch misses.</para> +<para> True if the VXLAN will emit netlink notifications of L3 switch misses. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml b/introspection/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml index 1951a6f5..9ba7807d 100644 --- a/introspection/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml +++ b/introspection/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml @@ -45,7 +45,11 @@ <programlisting> GetAccessPoints (OUT ao access_points); </programlisting> -<para>DEPRECATED. Get the list of access points visible to this device. Note that this list does not include access points which hide their SSID. To retrieve a list of all access points (including hidden ones) use the GetAllAccessPoints() method.</para> +<para> DEPRECATED. Get the list of access points visible to this device. Note + that this list does not include access points which hide their SSID. To + retrieve a list of all access points (including hidden ones) use the + GetAllAccessPoints() method. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT ao <parameter>access_points</parameter></literal>:</term> @@ -59,7 +63,9 @@ GetAccessPoints (OUT ao access_points); <programlisting> GetAllAccessPoints (OUT ao access_points); </programlisting> -<para>Get the list of all access points visible to this device, including hidden ones for which the SSID is not yet known.</para> +<para> Get the list of all access points visible to this device, including hidden + ones for which the SSID is not yet known. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT ao <parameter>access_points</parameter></literal>:</term> @@ -73,11 +79,12 @@ GetAllAccessPoints (OUT ao access_points); <programlisting> RequestScan (IN a{sv} options); </programlisting> -<para>Request the device to scan</para> +<para> Request the device to scan +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sv} <parameter>options</parameter></literal>:</term> - <listitem><para>Options of scan. Currently 'ssids' option with value of "aay" type is supported.</para></listitem> + <listitem><para>Options of scan. Currently 'ssids' option with value of "aay" type is supported.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -90,7 +97,8 @@ RequestScan (IN a{sv} options); <programlisting> PropertiesChanged (a{sv} properties); </programlisting> -<para>Emitted when the wireless device's properties changed.</para> +<para> Emitted when the wireless device's properties changed. +</para> <variablelist role="params"> <varlistentry> <term><literal>a{sv} <parameter>properties</parameter></literal>:</term> @@ -104,7 +112,8 @@ PropertiesChanged (a{sv} properties); <programlisting> AccessPointAdded (o access_point); </programlisting> -<para>Emitted when a new access point is found by the device.</para> +<para> Emitted when a new access point is found by the device. +</para> <variablelist role="params"> <varlistentry> <term><literal>o <parameter>access_point</parameter></literal>:</term> @@ -118,7 +127,8 @@ AccessPointAdded (o access_point); <programlisting> AccessPointRemoved (o access_point); </programlisting> -<para>Emitted when an access point disappears from view of the device.</para> +<para> Emitted when an access point disappears from view of the device. +</para> <variablelist role="params"> <varlistentry> <term><literal>o <parameter>access_point</parameter></literal>:</term> @@ -135,7 +145,8 @@ AccessPointRemoved (o access_point); <programlisting> HwAddress readable s </programlisting> -<para>The active hardware address of the device.</para> +<para> The active hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Wireless.PermHwAddress"> <title>The "PermHwAddress" property</title> @@ -143,7 +154,8 @@ HwAddress readable s <programlisting> PermHwAddress readable s </programlisting> -<para>The permanent hardware address of the device.</para> +<para> The permanent hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Wireless.Mode"> <title>The "Mode" property</title> @@ -151,7 +163,9 @@ PermHwAddress readable s <programlisting> Mode readable u </programlisting> -<para>The operating mode of the wireless device.</para> +<para> The operating mode of the wireless device. +</para><para> Returns: <link linkend="NM80211Mode">NM80211Mode</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Wireless.Bitrate"> <title>The "Bitrate" property</title> @@ -159,7 +173,9 @@ Mode readable u <programlisting> Bitrate readable u </programlisting> -<para>The bit rate currently used by the wireless device, in kilobits/second (Kb/s).</para> +<para> The bit rate currently used by the wireless device, in kilobits/second + (Kb/s). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Wireless.AccessPoints"> <title>The "AccessPoints" property</title> @@ -167,7 +183,8 @@ Bitrate readable u <programlisting> AccessPoints readable ao </programlisting> -<para>List of object paths of access point visible to this wireless device.</para> +<para> List of object paths of access point visible to this wireless device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Wireless.ActiveAccessPoint"> <title>The "ActiveAccessPoint" property</title> @@ -175,7 +192,8 @@ AccessPoints readable ao <programlisting> ActiveAccessPoint readable o </programlisting> -<para>Object path of the access point currently used by the wireless device.</para> +<para> Object path of the access point currently used by the wireless device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-Wireless.WirelessCapabilities"> <title>The "WirelessCapabilities" property</title> @@ -183,7 +201,9 @@ ActiveAccessPoint readable o <programlisting> WirelessCapabilities readable u </programlisting> -<para>The capabilities of the wireless device.</para> +<para> The capabilities of the wireless device. +</para><para> Returns: <link linkend="NMDeviceWifiCapabilities">NMDeviceWifiCapabilities</link> +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml b/introspection/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml index 5ad7234a..4ecc776f 100644 --- a/introspection/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml +++ b/introspection/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml @@ -44,7 +44,8 @@ <programlisting> GetNspList (OUT ao nsps); </programlisting> -<para>Get the list of NSPs visible to this device.</para> +<para> Get the list of NSPs visible to this device. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT ao <parameter>nsps</parameter></literal>:</term> @@ -61,7 +62,8 @@ GetNspList (OUT ao nsps); <programlisting> PropertiesChanged (a{sv} properties); </programlisting> -<para>Emitted when the WiMax device's properties changed.</para> +<para> Emitted when the WiMax device's properties changed. +</para> <variablelist role="params"> <varlistentry> <term><literal>a{sv} <parameter>properties</parameter></literal>:</term> @@ -75,7 +77,8 @@ PropertiesChanged (a{sv} properties); <programlisting> NspAdded (o nsp); </programlisting> -<para>Emitted when a new NSP is found by the device.</para> +<para> Emitted when a new NSP is found by the device. +</para> <variablelist role="params"> <varlistentry> <term><literal>o <parameter>nsp</parameter></literal>:</term> @@ -89,7 +92,8 @@ NspAdded (o nsp); <programlisting> NspRemoved (o nsp); </programlisting> -<para>Emitted when an NSP disappears from view of the device.</para> +<para> Emitted when an NSP disappears from view of the device. +</para> <variablelist role="params"> <varlistentry> <term><literal>o <parameter>nsp</parameter></literal>:</term> @@ -106,7 +110,9 @@ NspRemoved (o nsp); <programlisting> Nsps readable ao </programlisting> -<para>List of object paths of Network Service Providers (NSPs) visible to this WiMAX device.</para> +<para> List of object paths of Network Service Providers (NSPs) visible to this + WiMAX device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-WiMax.HwAddress"> <title>The "HwAddress" property</title> @@ -114,7 +120,8 @@ Nsps readable ao <programlisting> HwAddress readable s </programlisting> -<para>Hardware address of the device.</para> +<para> Hardware address of the device. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-WiMax.CenterFrequency"> <title>The "CenterFrequency" property</title> @@ -122,7 +129,10 @@ HwAddress readable s <programlisting> CenterFrequency readable u </programlisting> -<para>Center frequency (in KHz) of the radio channel the device is using to communicate with the network when connected. Has no meaning when the device is not connected.</para> +<para> Center frequency (in KHz) of the radio channel the device is using to + communicate with the network when connected. Has no meaning when the + device is not connected. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-WiMax.Rssi"> <title>The "Rssi" property</title> @@ -130,7 +140,11 @@ CenterFrequency readable u <programlisting> Rssi readable i </programlisting> -<para>RSSI of the current radio link in dBm. This value indicates how strong the raw received RF signal from the base station is, but does not indicate the overall quality of the radio link. Has no meaning when the device is not connected.</para> +<para> RSSI of the current radio link in dBm. This value indicates how strong the + raw received RF signal from the base station is, but does not indicate the + overall quality of the radio link. Has no meaning when the device is not + connected. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-WiMax.Cinr"> <title>The "Cinr" property</title> @@ -138,7 +152,10 @@ Rssi readable i <programlisting> Cinr readable i </programlisting> -<para>CINR (Carrier to Interference + Noise Ratio) of the current radio link in dB. CINR is a more accurate measure of radio link quality. Has no meaning when the device is not connected.</para> +<para> CINR (Carrier to Interference + Noise Ratio) of the current radio link in + dB. CINR is a more accurate measure of radio link quality. Has no meaning + when the device is not connected. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-WiMax.TxPower"> <title>The "TxPower" property</title> @@ -146,7 +163,10 @@ Cinr readable i <programlisting> TxPower readable i </programlisting> -<para>Average power of the last burst transmitted by the device, in units of 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of -5.5 dBm. Has no meaning when the device is not connected.</para> +<para> Average power of the last burst transmitted by the device, in units of 0.5 + dBm. i.e. a TxPower of -11 represents an actual device TX power of -5.5 + dBm. Has no meaning when the device is not connected. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-WiMax.Bsid"> <title>The "Bsid" property</title> @@ -154,7 +174,9 @@ TxPower readable i <programlisting> Bsid readable s </programlisting> -<para>The ID of the serving base station as received from the network. Has no meaning when the device is not connected.</para> +<para> The ID of the serving base station as received from the network. Has no + meaning when the device is not connected. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-WiMax.ActiveNsp"> <title>The "ActiveNsp" property</title> @@ -162,7 +184,8 @@ Bsid readable s <programlisting> ActiveNsp readable o </programlisting> -<para>Object path of the NSP currently used by the WiMax device.</para> +<para> Object path of the NSP currently used by the WiMax device. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml b/introspection/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml index 5c144868..615ce6da 100644 --- a/introspection/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml +++ b/introspection/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml @@ -19,7 +19,8 @@ </refsect1> <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-DHCP4Config"> <title role="desc.title">Description</title> - <para>Options and configuration returned by the IPv4 DHCP server.</para> + <para> Options and configuration returned by the IPv4 DHCP server. +</para> </refsect1> <refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.DHCP4Config"> <title role="details.title">Signal Details</title> @@ -46,7 +47,8 @@ PropertiesChanged (a{sv} properties); <programlisting> Options readable a{sv} </programlisting> -<para>Configuration options returned by a DHCP server, if any.</para> +<para> Configuration options returned by a DHCP server, if any. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml b/introspection/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml index 65c12825..8931bb6e 100644 --- a/introspection/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml +++ b/introspection/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml @@ -19,7 +19,8 @@ </refsect1> <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-DHCP6Config"> <title role="desc.title">Description</title> - <para>Options and configuration returned by the IPv6 DHCP server.</para> + <para> Options and configuration returned by the IPv6 DHCP server. +</para> </refsect1> <refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.DHCP6Config"> <title role="details.title">Signal Details</title> @@ -46,7 +47,8 @@ PropertiesChanged (a{sv} properties); <programlisting> Options readable a{sv} </programlisting> -<para>Configuration options returned by a DHCP server, if any.</para> +<para> Configuration options returned by a DHCP server, if any. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml b/introspection/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml index 08ddf98a..4383ae42 100644 --- a/introspection/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml +++ b/introspection/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml @@ -55,7 +55,10 @@ PropertiesChanged (a{sv} properties); <programlisting> Addresses readable aau </programlisting> -<para>Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each array are in network byte order. Essentially: [(addr, prefix, gateway), (addr, prefix, gateway), ...] Deprecated: use AddressData and Gateway</para> +<para> Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each + array are in network byte order. Essentially: [(addr, prefix, gateway), + (addr, prefix, gateway), ...] Deprecated: use AddressData and Gateway +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP4Config.AddressData"> <title>The "AddressData" property</title> @@ -63,7 +66,10 @@ Addresses readable aau <programlisting> AddressData readable aa{sv} </programlisting> -<para>Array of IP address data objects. All addresses will include "address" (an IP address string), and "prefix" (a uint). Some addresses may include additional attributes.</para> +<para> Array of IP address data objects. All addresses will include "address" (an + IP address string), and "prefix" (a uint). Some addresses may include + additional attributes. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP4Config.Gateway"> <title>The "Gateway" property</title> @@ -71,7 +77,8 @@ AddressData readable aa{sv} <programlisting> Gateway readable s </programlisting> -<para>The gateway in use.</para> +<para> The gateway in use. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP4Config.Routes"> <title>The "Routes" property</title> @@ -79,7 +86,12 @@ Gateway readable s <programlisting> Routes readable aau </programlisting> -<para>Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of each tuple are in network byte order. 'route' and 'next hop' are IPv4 addresses, while prefix and metric are simple unsigned integers. Essentially: [(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), ...] Deprecated: use RouteData</para> +<para> Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of each tuple + are in network byte order. 'route' and 'next hop' are IPv4 addresses, + while prefix and metric are simple unsigned integers. Essentially: + [(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), + ...] Deprecated: use RouteData +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP4Config.RouteData"> <title>The "RouteData" property</title> @@ -87,7 +99,10 @@ Routes readable aau <programlisting> RouteData readable aa{sv} </programlisting> -<para>Array of IP route data objects. All routes will include "dest" (an IP address string) and "prefix" (a uint). Some routes may include "next-hop" (an IP address string), "metric" (a uint), and additional attributes.</para> +<para> Array of IP route data objects. All routes will include "dest" (an IP + address string) and "prefix" (a uint). Some routes may include "next-hop" + (an IP address string), "metric" (a uint), and additional attributes. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP4Config.Nameservers"> <title>The "Nameservers" property</title> @@ -95,7 +110,8 @@ RouteData readable aa{sv} <programlisting> Nameservers readable au </programlisting> -<para>The nameservers in use.</para> +<para> The nameservers in use. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP4Config.Domains"> <title>The "Domains" property</title> @@ -103,7 +119,8 @@ Nameservers readable au <programlisting> Domains readable as </programlisting> -<para>A list of domains this address belongs to.</para> +<para> A list of domains this address belongs to. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP4Config.Searches"> <title>The "Searches" property</title> @@ -111,7 +128,8 @@ Domains readable as <programlisting> Searches readable as </programlisting> -<para>A list of dns searches.</para> +<para> A list of dns searches. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP4Config.DnsOptions"> <title>The "DnsOptions" property</title> @@ -119,7 +137,9 @@ Searches readable as <programlisting> DnsOptions readable as </programlisting> -<para>A list of DNS options that modify the behavior of the DNS resolver. See resolv.conf(5) manual page for the list of supported options.</para> +<para> A list of DNS options that modify the behavior of the DNS resolver. See + resolv.conf(5) manual page for the list of supported options. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP4Config.WinsServers"> <title>The "WinsServers" property</title> @@ -127,7 +147,9 @@ DnsOptions readable as <programlisting> WinsServers readable au </programlisting> -<para>The Windows Internet Name Service servers associated with the connection. Each address is in network byte order.</para> +<para> The Windows Internet Name Service servers associated with the connection. + Each address is in network byte order. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml b/introspection/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml index a0e327eb..80dd9b4f 100644 --- a/introspection/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml +++ b/introspection/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml @@ -54,7 +54,9 @@ PropertiesChanged (a{sv} properties); <programlisting> Addresses readable a(ayuay) </programlisting> -<para>Array of tuples of IPv6 address/prefix/gateway. Deprecated: use AddressData and Gateway.</para> +<para> Array of tuples of IPv6 address/prefix/gateway. Deprecated: use + AddressData and Gateway. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP6Config.AddressData"> <title>The "AddressData" property</title> @@ -62,7 +64,10 @@ Addresses readable a(ayuay) <programlisting> AddressData readable aa{sv} </programlisting> -<para>Array of IP address data objects. All addresses will include "address" (an IP address string), and "prefix" (a uint). Some addresses may include additional attributes.</para> +<para> Array of IP address data objects. All addresses will include "address" (an + IP address string), and "prefix" (a uint). Some addresses may include + additional attributes. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP6Config.Gateway"> <title>The "Gateway" property</title> @@ -70,7 +75,8 @@ AddressData readable aa{sv} <programlisting> Gateway readable s </programlisting> -<para>The gateway in use.</para> +<para> The gateway in use. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP6Config.Routes"> <title>The "Routes" property</title> @@ -78,7 +84,8 @@ Gateway readable s <programlisting> Routes readable a(ayuayu) </programlisting> -<para>Tuples of IPv6 route/prefix/next-hop/metric. Deprecated: use RouteData</para> +<para> Tuples of IPv6 route/prefix/next-hop/metric. Deprecated: use RouteData +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP6Config.RouteData"> <title>The "RouteData" property</title> @@ -86,7 +93,10 @@ Routes readable a(ayuayu) <programlisting> RouteData readable aa{sv} </programlisting> -<para>Array of IP route data objects. All routes will include "dest" (an IP address string) and "prefix" (a uint). Some routes may include "next-hop" (an IP address string), "metric" (a uint), and additional attributes.</para> +<para> Array of IP route data objects. All routes will include "dest" (an IP + address string) and "prefix" (a uint). Some routes may include "next-hop" + (an IP address string), "metric" (a uint), and additional attributes. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP6Config.Nameservers"> <title>The "Nameservers" property</title> @@ -94,7 +104,8 @@ RouteData readable aa{sv} <programlisting> Nameservers readable aay </programlisting> -<para>The nameservers in use.</para> +<para> The nameservers in use. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP6Config.Domains"> <title>The "Domains" property</title> @@ -102,7 +113,8 @@ Nameservers readable aay <programlisting> Domains readable as </programlisting> -<para>A list of domains this address belongs to.</para> +<para> A list of domains this address belongs to. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP6Config.Searches"> <title>The "Searches" property</title> @@ -110,7 +122,8 @@ Domains readable as <programlisting> Searches readable as </programlisting> -<para>A list of dns searches.</para> +<para> A list of dns searches. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-IP6Config.DnsOptions"> <title>The "DnsOptions" property</title> @@ -118,7 +131,9 @@ Searches readable as <programlisting> DnsOptions readable as </programlisting> -<para>A list of DNS options that modify the behavior of the DNS resolver. See resolv.conf(5) manual page for the list of supported options.</para> +<para> A list of DNS options that modify the behavior of the DNS resolver. See + resolv.conf(5) manual page for the list of supported options. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-manager-org.freedesktop.NetworkManager.xml b/introspection/nmdbus-manager-org.freedesktop.NetworkManager.xml index 10cc472e..26b499bb 100644 --- a/introspection/nmdbus-manager-org.freedesktop.NetworkManager.xml +++ b/introspection/nmdbus-manager-org.freedesktop.NetworkManager.xml @@ -79,11 +79,12 @@ <programlisting> GetDevices (OUT ao devices); </programlisting> -<para>Get the list of realized network devices.</para> +<para> Get the list of realized network devices. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT ao <parameter>devices</parameter></literal>:</term> - <listitem><para>List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()).</para></listitem> + <listitem><para>List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()).</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -93,11 +94,12 @@ GetDevices (OUT ao devices); <programlisting> GetAllDevices (OUT ao devices); </programlisting> -<para>Get the list of all network devices.</para> +<para> Get the list of all network devices. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT ao <parameter>devices</parameter></literal>:</term> - <listitem><para>List of object paths of network devices and device placeholders (eg, devices that do not yet exist but which can be automatically created by NetworkManager if one of their AvailableConnections was activated).</para></listitem> + <listitem><para>List of object paths of network devices and device placeholders (eg, devices that do not yet exist but which can be automatically created by NetworkManager if one of their AvailableConnections was activated).</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -108,7 +110,10 @@ GetAllDevices (OUT ao devices); GetDeviceByIpIface (IN s iface, OUT o device); </programlisting> -<para>Return the object path of the network device referenced by its IP interface name. Note that some devices (usually modems) only have an IP interface name when they are connected.</para> +<para> Return the object path of the network device referenced by its IP + interface name. Note that some devices (usually modems) only have an IP + interface name when they are connected. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN s <parameter>iface</parameter></literal>:</term> @@ -129,19 +134,20 @@ ActivateConnection (IN o connection, IN o specific_object, OUT o active_connection); </programlisting> -<para>Activate a connection using the supplied device.</para> +<para> Activate a connection using the supplied device. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN o <parameter>connection</parameter></literal>:</term> - <listitem><para>The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path.</para></listitem> + <listitem><para>The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN o <parameter>device</parameter></literal>:</term> - <listitem><para>The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use.</para></listitem> + <listitem><para>The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN o <parameter>specific_object</parameter></literal>:</term> - <listitem><para>The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device.</para></listitem> + <listitem><para>The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device.</para></listitem> </varlistentry> <varlistentry> <term><literal>OUT o <parameter>active_connection</parameter></literal>:</term> @@ -159,11 +165,15 @@ AddAndActivateConnection (IN a{sa{sv}} connection, OUT o path, OUT o active_connection); </programlisting> -<para>Adds a new connection using the given details (if any) as a template (automatically filling in missing settings with the capabilities of the given device and specific object), then activate the new connection. Cannot be used for VPN connections at this time.</para> +<para> Adds a new connection using the given details (if any) as a template + (automatically filling in missing settings with the capabilities of the + given device and specific object), then activate the new connection. + Cannot be used for VPN connections at this time. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>connection</parameter></literal>:</term> - <listitem><para>Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.</para></listitem> + <listitem><para>Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN o <parameter>device</parameter></literal>:</term> @@ -171,7 +181,7 @@ AddAndActivateConnection (IN a{sa{sv}} connection, </varlistentry> <varlistentry> <term><literal>IN o <parameter>specific_object</parameter></literal>:</term> - <listitem><para>The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection.</para></listitem> + <listitem><para>The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection.</para></listitem> </varlistentry> <varlistentry> <term><literal>OUT o <parameter>path</parameter></literal>:</term> @@ -189,7 +199,8 @@ AddAndActivateConnection (IN a{sa{sv}} connection, <programlisting> DeactivateConnection (IN o active_connection); </programlisting> -<para>Deactivate an active connection.</para> +<para> Deactivate an active connection. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN o <parameter>active_connection</parameter></literal>:</term> @@ -203,7 +214,11 @@ DeactivateConnection (IN o active_connection); <programlisting> Sleep (IN b sleep); </programlisting> -<para>Control the NetworkManager daemon's sleep state. When asleep, all interfaces that it manages are deactivated. When awake, devices are available to be activated. This command should not be called directly by users or clients; it is intended for system suspend/resume tracking.</para> +<para> Control the NetworkManager daemon's sleep state. When asleep, all + interfaces that it manages are deactivated. When awake, devices are + available to be activated. This command should not be called directly by + users or clients; it is intended for system suspend/resume tracking. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN b <parameter>sleep</parameter></literal>:</term> @@ -217,11 +232,16 @@ Sleep (IN b sleep); <programlisting> Enable (IN b enable); </programlisting> -<para>Control whether overall networking is enabled or disabled. When disabled, all interfaces that NM manages are deactivated. When enabled, all managed interfaces are re-enabled and available to be activated. This command should be used by clients that provide to users the ability to enable/disable all networking.</para> +<para> Control whether overall networking is enabled or disabled. When disabled, + all interfaces that NM manages are deactivated. When enabled, all managed + interfaces are re-enabled and available to be activated. This command + should be used by clients that provide to users the ability to + enable/disable all networking. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN b <parameter>enable</parameter></literal>:</term> - <listitem><para>If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices.</para></listitem> + <listitem><para>If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -231,11 +251,14 @@ Enable (IN b enable); <programlisting> GetPermissions (OUT a{ss} permissions); </programlisting> -<para>Returns the permissions a caller has for various authenticated operations that NetworkManager provides, like Enable/Disable networking, changing WiFi, WWAN, and WiMAX state, etc.</para> +<para> Returns the permissions a caller has for various authenticated operations + that NetworkManager provides, like Enable/Disable networking, changing + WiFi, WWAN, and WiMAX state, etc. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT a{ss} <parameter>permissions</parameter></literal>:</term> - <listitem><para>Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations.</para></listitem> + <listitem><para>Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -246,15 +269,16 @@ GetPermissions (OUT a{ss} permissions); SetLogging (IN s level, IN s domains); </programlisting> -<para>Set logging verbosity and which operations are logged.</para> +<para> Set logging verbosity and which operations are logged. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN s <parameter>level</parameter></literal>:</term> - <listitem><para>One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain.</para></listitem> + <listitem><para>One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN s <parameter>domains</parameter></literal>:</term> - <listitem><para>A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, 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, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged.</para></listitem> + <listitem><para>A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, 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, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -265,7 +289,8 @@ SetLogging (IN s level, GetLogging (OUT s level, OUT s domains); </programlisting> -<para>Get current logging verbosity level and operations domains.</para> +<para> Get current logging verbosity level and operations domains. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT s <parameter>level</parameter></literal>:</term> @@ -283,11 +308,12 @@ GetLogging (OUT s level, <programlisting> CheckConnectivity (OUT u connectivity); </programlisting> -<para>Re-check the network connectivity state.</para> +<para> Re-check the network connectivity state. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT u <parameter>connectivity</parameter></literal>:</term> - <listitem><para>The current connectivity state.</para></listitem> + <listitem><para>(<link linkend="NMConnectivityState">NMConnectivityState</link>) The current connectivity state.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -297,11 +323,13 @@ CheckConnectivity (OUT u connectivity); <programlisting> state (OUT u state); </programlisting> -<para>The overall networking state as determined by the NetworkManager daemon, based on the state of network devices under it's management.</para> +<para> The overall networking state as determined by the NetworkManager daemon, + based on the state of network devices under it's management. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT u <parameter>state</parameter></literal>:</term> - <listitem><para></para></listitem> + <listitem><para><link linkend="NMState">NMState</link></para></listitem> </varlistentry> </variablelist> </refsect2> @@ -314,7 +342,9 @@ state (OUT u state); <programlisting> CheckPermissions (); </programlisting> -<para>Emitted when system authorization details change, indicating that clients may wish to recheck permissions with GetPermissions.</para> +<para> Emitted when system authorization details change, indicating that clients + may wish to recheck permissions with GetPermissions. +</para> </refsect2> <refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager.StateChanged"> <title>The "StateChanged" signal</title> @@ -322,11 +352,12 @@ CheckPermissions (); <programlisting> StateChanged (u state); </programlisting> -<para>NetworkManager's state changed.</para> +<para> NetworkManager's state changed. +</para> <variablelist role="params"> <varlistentry> <term><literal>u <parameter>state</parameter></literal>:</term> - <listitem><para>The new state of NetworkManager.</para></listitem> + <listitem><para>(<link linkend="NMState">NMState</link>) The new state of NetworkManager.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -336,7 +367,8 @@ StateChanged (u state); <programlisting> PropertiesChanged (a{sv} properties); </programlisting> -<para>NetworkManager's properties changed.</para> +<para> NetworkManager's properties changed. +</para> <variablelist role="params"> <varlistentry> <term><literal>a{sv} <parameter>properties</parameter></literal>:</term> @@ -350,7 +382,8 @@ PropertiesChanged (a{sv} properties); <programlisting> DeviceAdded (o device_path); </programlisting> -<para>A device was added to the system</para> +<para> A device was added to the system +</para> <variablelist role="params"> <varlistentry> <term><literal>o <parameter>device_path</parameter></literal>:</term> @@ -364,7 +397,8 @@ DeviceAdded (o device_path); <programlisting> DeviceRemoved (o device_path); </programlisting> -<para>A device was removed from the system, and is no longer available.</para> +<para> A device was removed from the system, and is no longer available. +</para> <variablelist role="params"> <varlistentry> <term><literal>o <parameter>device_path</parameter></literal>:</term> @@ -381,7 +415,10 @@ DeviceRemoved (o device_path); <programlisting> Devices readable ao </programlisting> -<para>The list of realized network devices. Realized devices are those which have backing resources (eg from the kernel or a management daemon like ModemManager, teamd, etc).</para> +<para> The list of realized network devices. Realized devices are those which + have backing resources (eg from the kernel or a management daemon like + ModemManager, teamd, etc). +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.AllDevices"> <title>The "AllDevices" property</title> @@ -389,7 +426,10 @@ Devices readable ao <programlisting> AllDevices readable ao </programlisting> -<para>The list of both realized and un-realized network devices. Un-realized devices are software devices which do not yet have backing resources, but for which backing resources can be created if the device is activated.</para> +<para> The list of both realized and un-realized network devices. Un-realized + devices are software devices which do not yet have backing resources, but + for which backing resources can be created if the device is activated. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.NetworkingEnabled"> <title>The "NetworkingEnabled" property</title> @@ -397,7 +437,9 @@ AllDevices readable ao <programlisting> NetworkingEnabled readable b </programlisting> -<para>Indicates if overall networking is currently enabled or not. See the Enable() method.</para> +<para> Indicates if overall networking is currently enabled or not. See the + Enable() method. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.WirelessEnabled"> <title>The "WirelessEnabled" property</title> @@ -405,7 +447,8 @@ NetworkingEnabled readable b <programlisting> WirelessEnabled readwrite b </programlisting> -<para>Indicates if wireless is currently enabled or not.</para> +<para> Indicates if wireless is currently enabled or not. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.WirelessHardwareEnabled"> <title>The "WirelessHardwareEnabled" property</title> @@ -413,7 +456,9 @@ WirelessEnabled readwrite b <programlisting> WirelessHardwareEnabled readable b </programlisting> -<para>Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch.</para> +<para> Indicates if the wireless hardware is currently enabled, i.e. the state of + the RF kill switch. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.WwanEnabled"> <title>The "WwanEnabled" property</title> @@ -421,7 +466,8 @@ WirelessHardwareEnabled readable b <programlisting> WwanEnabled readwrite b </programlisting> -<para>Indicates if mobile broadband devices are currently enabled or not.</para> +<para> Indicates if mobile broadband devices are currently enabled or not. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.WwanHardwareEnabled"> <title>The "WwanHardwareEnabled" property</title> @@ -429,7 +475,9 @@ WwanEnabled readwrite b <programlisting> WwanHardwareEnabled readable b </programlisting> -<para>Indicates if the mobile broadband hardware is currently enabled, i.e. the state of the RF kill switch.</para> +<para> Indicates if the mobile broadband hardware is currently enabled, i.e. the + state of the RF kill switch. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.WimaxEnabled"> <title>The "WimaxEnabled" property</title> @@ -437,7 +485,8 @@ WwanHardwareEnabled readable b <programlisting> WimaxEnabled readwrite b </programlisting> -<para>Indicates if WiMAX devices are currently enabled or not.</para> +<para> Indicates if WiMAX devices are currently enabled or not. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.WimaxHardwareEnabled"> <title>The "WimaxHardwareEnabled" property</title> @@ -445,7 +494,9 @@ WimaxEnabled readwrite b <programlisting> WimaxHardwareEnabled readable b </programlisting> -<para>Indicates if the WiMAX hardware is currently enabled, i.e. the state of the RF kill switch.</para> +<para> Indicates if the WiMAX hardware is currently enabled, i.e. the state of + the RF kill switch. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.ActiveConnections"> <title>The "ActiveConnections" property</title> @@ -453,7 +504,8 @@ WimaxHardwareEnabled readable b <programlisting> ActiveConnections readable ao </programlisting> -<para>List of active connection object paths.</para> +<para> List of active connection object paths. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.PrimaryConnection"> <title>The "PrimaryConnection" property</title> @@ -461,7 +513,12 @@ ActiveConnections readable ao <programlisting> PrimaryConnection readable o </programlisting> -<para>The object path of the "primary" active connection being used to access the network. In particular, if there is no VPN active, or the VPN does not have the default route, then this indicates the connection that has the default route. If there is a VPN active with the default route, then this indicates the connection that contains the route to the VPN endpoint.</para> +<para> The object path of the "primary" active connection being used to access + the network. In particular, if there is no VPN active, or the VPN does not + have the default route, then this indicates the connection that has the + default route. If there is a VPN active with the default route, then this + indicates the connection that contains the route to the VPN endpoint. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.PrimaryConnectionType"> <title>The "PrimaryConnectionType" property</title> @@ -469,7 +526,10 @@ PrimaryConnection readable o <programlisting> PrimaryConnectionType readable s </programlisting> -<para>The connection type of the "primary" active connection being used to access the network. This is the same as the Type property on the object indicated by PrimaryConnection.</para> +<para> The connection type of the "primary" active connection being used to + access the network. This is the same as the Type property on the object + indicated by PrimaryConnection. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.Metered"> <title>The "Metered" property</title> @@ -477,7 +537,10 @@ PrimaryConnectionType readable s <programlisting> Metered readable u </programlisting> -<para>Indicates whether the connectivity is metered. This is equivalent to the metered property of the device associated with the primary connection.</para> +<para> Indicates whether the connectivity is metered. This is equivalent to the + metered property of the device associated with the primary connection. +</para><para> Returns: <link linkend="NMMetered">NMMetered</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.ActivatingConnection"> <title>The "ActivatingConnection" property</title> @@ -485,7 +548,10 @@ Metered readable u <programlisting> ActivatingConnection readable o </programlisting> -<para>The object path of an active connection that is currently being activated and which is expected to become the new PrimaryConnection when it finishes activating.</para> +<para> The object path of an active connection that is currently being activated + and which is expected to become the new PrimaryConnection when it finishes + activating. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.Startup"> <title>The "Startup" property</title> @@ -493,7 +559,10 @@ ActivatingConnection readable o <programlisting> Startup readable b </programlisting> -<para>Indicates whether NM is still starting up; this becomes FALSE when NM has finished attempting to activate every connection that it might be able to activate at startup.</para> +<para> Indicates whether NM is still starting up; this becomes FALSE when NM has + finished attempting to activate every connection that it might be able to + activate at startup. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.Version"> <title>The "Version" property</title> @@ -501,7 +570,8 @@ Startup readable b <programlisting> Version readable s </programlisting> -<para>NetworkManager version.</para> +<para> NetworkManager version. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.State"> <title>The "State" property</title> @@ -509,7 +579,9 @@ Version readable s <programlisting> State readable u </programlisting> -<para>The overall state of the NetworkManager daemon.</para> +<para> The overall state of the NetworkManager daemon. +</para><para> Returns: <link linkend="NMState">NMState</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.Connectivity"> <title>The "Connectivity" property</title> @@ -517,7 +589,9 @@ State readable u <programlisting> Connectivity readable u </programlisting> -<para>The network connectivity state.</para> +<para> The network connectivity state. +</para><para> Returns: <link linkend="NMConnectivityState">NMConnectivityState</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager.GlobalDnsConfiguration"> <title>The "GlobalDnsConfiguration" property</title> @@ -525,7 +599,15 @@ Connectivity readable u <programlisting> GlobalDnsConfiguration readwrite a{sv} </programlisting> -<para>Dictionary of global DNS settings where the key is one of "searches", "options" and "domains". The values for the "searches" and "options" keys are string arrays describing the list of search domains and resolver options, respectively. The value of the "domains" key is a second-level dictionary, where each key is a domain name, and each key's value is a third-level dictionary with the keys "servers" and "options". "servers" is a string array of DNS servers, "options" is a string array of domain-specific options.</para> +<para> Dictionary of global DNS settings where the key is one of "searches", + "options" and "domains". The values for the "searches" and "options" keys + are string arrays describing the list of search domains and resolver + options, respectively. The value of the "domains" key is a second-level + dictionary, where each key is a domain name, and each key's value is a + third-level dictionary with the keys "servers" and "options". "servers" is + a string array of DNS servers, "options" is a string array of + domain-specific options. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml b/introspection/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml index 36a683d6..0a77ec15 100644 --- a/introspection/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml +++ b/introspection/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml @@ -24,7 +24,16 @@ </refsynopsisdiv> <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-SecretAgent"> <title role="desc.title">Description</title> - <para>Private D-Bus interface used by secret agents that store and provide secrets to NetworkManager. If an agent provides secrets to NetworkManager as part of connection creation, and the some of those secrets are "agent owned" the agent should store those secrets itself and should not expect its SaveSecrets() method to be called. SaveSecrets() will be called eg if some program other than the agent itself (like a connection editor) changes the secrets out of band. The agent should implement this D-Bus interface on an object with the path /org/freedesktop/NetworkManager/SecretAgent.</para> + <para> Private D-Bus interface used by secret agents that store and provide + secrets to NetworkManager. If an agent provides secrets to NetworkManager + as part of connection creation, and the some of those secrets are "agent + owned" the agent should store those secrets itself and should not expect + its SaveSecrets() method to be called. SaveSecrets() will be called eg if + some program other than the agent itself (like a connection editor) + changes the secrets out of band. The agent should implement this D-Bus + interface on an object with the path + /org/freedesktop/NetworkManager/SecretAgent. +</para> </refsect1> <refsect1 role="details" id="gdbus-methods-org.freedesktop.NetworkManager.SecretAgent"> <title role="details.title">Method Details</title> @@ -39,15 +48,22 @@ GetSecrets (IN a{sa{sv}} connection, IN u flags, OUT a{sa{sv}} secrets); </programlisting> -<para>Retrieve and return stored secrets, if any, or request new secrets from the agent's user. If user interaction is allowed and the user enters new secrets, the agent is expected to save the new secrets to persistent storage (if the secret's flags include AGENT_OWNED) as NetworkManager will not send these secrets back to the same agent via a SaveSecrets() call. If the user canceled any interaction, the agent should return the UserCanceled error (see below).</para> +<para> Retrieve and return stored secrets, if any, or request new secrets from + the agent's user. If user interaction is allowed and the user enters new + secrets, the agent is expected to save the new secrets to persistent + storage (if the secret's flags include AGENT_OWNED) as NetworkManager will + not send these secrets back to the same agent via a SaveSecrets() call. If + the user canceled any interaction, the agent should return the + UserCanceled error (see below). +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>connection</parameter></literal>:</term> - <listitem><para>Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction.</para></listitem> + <listitem><para>Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN o <parameter>connection_path</parameter></literal>:</term> - <listitem><para>Object path of the connection for which secrets are being requested.</para></listitem> + <listitem><para>Object path of the connection for which secrets are being requested.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN s <parameter>setting_name</parameter></literal>:</term> @@ -55,15 +71,15 @@ GetSecrets (IN a{sa{sv}} connection, </varlistentry> <varlistentry> <term><literal>IN as <parameter>hints</parameter></literal>:</term> - <listitem><para>Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:".</para></listitem> + <listitem><para>Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:".</para></listitem> </varlistentry> <varlistentry> <term><literal>IN u <parameter>flags</parameter></literal>:</term> - <listitem><para>Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user.</para></listitem> + <listitem><para>(<link linkend="NMSecretAgentGetSecretsFlags">NMSecretAgentGetSecretsFlags</link>) Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user.</para></listitem> </varlistentry> <varlistentry> <term><literal>OUT a{sa{sv}} <parameter>secrets</parameter></literal>:</term> - <listitem><para>Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets.</para></listitem> + <listitem><para>Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -74,15 +90,18 @@ GetSecrets (IN a{sa{sv}} connection, CancelGetSecrets (IN o connection_path, IN s setting_name); </programlisting> -<para>Cancel a pending GetSecrets request for secrets of the given connection. Any GetSecrets request with the same 'connection_path' and 'setting_name' that are given in a CancelGetSecrets request should be canceled.</para> +<para> Cancel a pending GetSecrets request for secrets of the given connection. + Any GetSecrets request with the same 'connection_path' and 'setting_name' + that are given in a CancelGetSecrets request should be canceled. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN o <parameter>connection_path</parameter></literal>:</term> - <listitem><para>Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled.</para></listitem> + <listitem><para>Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN s <parameter>setting_name</parameter></literal>:</term> - <listitem><para>Setting name for which secrets for this connection were originally being requested.</para></listitem> + <listitem><para>Setting name for which secrets for this connection were originally being requested.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -93,15 +112,16 @@ CancelGetSecrets (IN o connection_path, SaveSecrets (IN a{sa{sv}} connection, IN o connection_path); </programlisting> -<para>Save given secrets to backing storage.</para> +<para> Save given secrets to backing storage. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>connection</parameter></literal>:</term> - <listitem><para>Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already.</para></listitem> + <listitem><para>Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN o <parameter>connection_path</parameter></literal>:</term> - <listitem><para>Object path of the connection for which the agent should save secrets to backing storage.</para></listitem> + <listitem><para>Object path of the connection for which the agent should save secrets to backing storage.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -112,15 +132,16 @@ SaveSecrets (IN a{sa{sv}} connection, DeleteSecrets (IN a{sa{sv}} connection, IN o connection_path); </programlisting> -<para>Delete secrets from backing storage.</para> +<para> Delete secrets from backing storage. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>connection</parameter></literal>:</term> - <listitem><para>Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage.</para></listitem> + <listitem><para>Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage.</para></listitem> </varlistentry> <varlistentry> <term><literal>IN o <parameter>connection_path</parameter></literal>:</term> - <listitem><para>Object path of the connection for which the agent should delete secrets from backing storage.</para></listitem> + <listitem><para>Object path of the connection for which the agent should delete secrets from backing storage.</para></listitem> </varlistentry> </variablelist> </refsect2> diff --git a/introspection/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml b/introspection/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml index f5dd15ff..d2bb83f5 100644 --- a/introspection/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml +++ b/introspection/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml @@ -34,7 +34,8 @@ </refsect1> <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-Settings-Connection"> <title role="desc.title">Description</title> - <para>Represents a single network connection configuration.</para> + <para> Represents a single network connection configuration. +</para> </refsect1> <refsect1 role="details" id="gdbus-methods-org.freedesktop.NetworkManager.Settings.Connection"> <title role="details.title">Method Details</title> @@ -44,7 +45,12 @@ <programlisting> Update (IN a{sa{sv}} properties); </programlisting> -<para>Update the connection with new settings and properties (replacing all previous settings and properties) and save the connection to disk. Secrets may be part of the update request, and will be either stored in persistent storage or sent to a Secret Agent for storage, depending on the flags associated with each secret.</para> +<para> Update the connection with new settings and properties (replacing all + previous settings and properties) and save the connection to disk. Secrets + may be part of the update request, and will be either stored in persistent + storage or sent to a Secret Agent for storage, depending on the flags + associated with each secret. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>properties</parameter></literal>:</term> @@ -58,7 +64,15 @@ Update (IN a{sa{sv}} properties); <programlisting> UpdateUnsaved (IN a{sa{sv}} properties); </programlisting> -<para>Update the connection with new settings and properties (replacing all previous settings and properties) but do not immediately save the connection to disk. Secrets may be part of the update request and may sent to a Secret Agent for storage, depending on the flags associated with each secret. Use the 'Save' method to save these changes to disk. Note that unsaved changes will be lost if the connection is reloaded from disk (either automatically on file change or due to an explicit ReloadConnections call).</para> +<para> Update the connection with new settings and properties (replacing all + previous settings and properties) but do not immediately save the + connection to disk. Secrets may be part of the update request and may sent + to a Secret Agent for storage, depending on the flags associated with each + secret. Use the 'Save' method to save these changes to disk. Note that + unsaved changes will be lost if the connection is reloaded from disk + (either automatically on file change or due to an explicit + ReloadConnections call). +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>properties</parameter></literal>:</term> @@ -72,7 +86,8 @@ UpdateUnsaved (IN a{sa{sv}} properties); <programlisting> Delete (); </programlisting> -<para>Delete the connection.</para> +<para> Delete the connection. +</para> </refsect2> <refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSettings"> <title>The GetSettings() method</title> @@ -80,7 +95,11 @@ Delete (); <programlisting> GetSettings (OUT a{sa{sv}} settings); </programlisting> -<para>Get the settings maps describing this network configuration. This will never include any secrets required for connection to the network, as those are often protected. Secrets must be requested separately using the GetSecrets() call.</para> +<para> Get the settings maps describing this network configuration. This will + never include any secrets required for connection to the network, as those + are often protected. Secrets must be requested separately using the + GetSecrets() call. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT a{sa{sv}} <parameter>settings</parameter></literal>:</term> @@ -95,11 +114,15 @@ GetSettings (OUT a{sa{sv}} settings); GetSecrets (IN s setting_name, OUT a{sa{sv}} secrets); </programlisting> -<para>Get the secrets belonging to this network configuration. Only secrets from persistent storage or a Secret Agent running in the requestor's session will be returned. The user will never be prompted for secrets as a result of this request.</para> +<para> Get the secrets belonging to this network configuration. Only secrets from + persistent storage or a Secret Agent running in the requestor's session + will be returned. The user will never be prompted for secrets as a result + of this request. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN s <parameter>setting_name</parameter></literal>:</term> - <listitem><para>Name of the setting to return secrets for. If empty, all all secrets will be returned.</para></listitem> + <listitem><para>Name of the setting to return secrets for. If empty, all all secrets will be returned.</para></listitem> </varlistentry> <varlistentry> <term><literal>OUT a{sa{sv}} <parameter>secrets</parameter></literal>:</term> @@ -113,7 +136,8 @@ GetSecrets (IN s setting_name, <programlisting> ClearSecrets (); </programlisting> -<para>Clear the secrets belonging to this network connection profile.</para> +<para> Clear the secrets belonging to this network connection profile. +</para> </refsect2> <refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Save"> <title>The Save() method</title> @@ -121,7 +145,9 @@ ClearSecrets (); <programlisting> Save (); </programlisting> -<para>Saves a "dirty" connection (that had previously been updated with UpdateUnsaved) to persistent storage.</para> +<para> Saves a "dirty" connection (that had previously been updated with + UpdateUnsaved) to persistent storage. +</para> </refsect2> </refsect1> <refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.Settings.Connection"> @@ -132,7 +158,11 @@ Save (); <programlisting> Updated (); </programlisting> -<para>Emitted when any settings or permissions change. When handling this signal, clients should re-read the connection using the GetSettings method to get the changes and to ensure the client still has permission to access the connection.</para> +<para> Emitted when any settings or permissions change. When handling this + signal, clients should re-read the connection using the GetSettings method + to get the changes and to ensure the client still has permission to access + the connection. +</para> </refsect2> <refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Removed"> <title>The "Removed" signal</title> @@ -140,7 +170,11 @@ Updated (); <programlisting> Removed (); </programlisting> -<para>Emitted when this connection is no longer available. This happens when the connection is deleted or if it is no longer accessible by any of the system's logged-in users. After receipt of this signal, the object no longer exists. Also see the Settings.ConnectionRemoved signal.</para> +<para> Emitted when this connection is no longer available. This happens when the + connection is deleted or if it is no longer accessible by any of the + system's logged-in users. After receipt of this signal, the object no + longer exists. Also see the Settings.ConnectionRemoved signal. +</para> </refsect2> <refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.PropertiesChanged"> <title>The "PropertiesChanged" signal</title> @@ -165,7 +199,11 @@ PropertiesChanged (a{sv} properties); <programlisting> Unsaved readable b </programlisting> -<para>If set, indicates that the in-memory state of the connection does not match the on-disk state. This flag will be set when UpdateUnsaved() is called or when any connection details change, and cleared when the connection is saved to disk via Save() or from internal operations.</para> +<para> If set, indicates that the in-memory state of the connection does not + match the on-disk state. This flag will be set when UpdateUnsaved() is + called or when any connection details change, and cleared when the + connection is saved to disk via Save() or from internal operations. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml b/introspection/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml index 0481b710..1186064b 100644 --- a/introspection/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml +++ b/introspection/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml @@ -40,7 +40,9 @@ </refsect1> <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-Settings"> <title role="desc.title">Description</title> - <para>The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager.</para> + <para> The Settings interface allows clients to view and administrate the + connections stored and used by NetworkManager. +</para> </refsect1> <refsect1 role="details" id="gdbus-methods-org.freedesktop.NetworkManager.Settings"> <title role="details.title">Method Details</title> @@ -50,7 +52,8 @@ <programlisting> ListConnections (OUT ao connections); </programlisting> -<para>List the saved network connections known to NetworkManager.</para> +<para> List the saved network connections known to NetworkManager. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT ao <parameter>connections</parameter></literal>:</term> @@ -65,7 +68,8 @@ ListConnections (OUT ao connections); GetConnectionByUuid (IN s uuid, OUT o connection); </programlisting> -<para>Retrieve the object path of a connection, given that connection's UUID.</para> +<para> Retrieve the object path of a connection, given that connection's UUID. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN s <parameter>uuid</parameter></literal>:</term> @@ -84,7 +88,11 @@ GetConnectionByUuid (IN s uuid, AddConnection (IN a{sa{sv}} connection, OUT o path); </programlisting> -<para>Add new connection and save it to disk. This operation does not start the network connection unless (1) device is idle and able to connect to the network described by the new connection, and (2) the connection is allowed to be started automatically.</para> +<para> Add new connection and save it to disk. This operation does not start the + network connection unless (1) device is idle and able to connect to the + network described by the new connection, and (2) the connection is allowed + to be started automatically. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>connection</parameter></literal>:</term> @@ -103,7 +111,14 @@ AddConnection (IN a{sa{sv}} connection, AddConnectionUnsaved (IN a{sa{sv}} connection, OUT o path); </programlisting> -<para>Add new connection but do not save it to disk immediately. This operation does not start the network connection unless (1) device is idle and able to connect to the network described by the new connection, and (2) the connection is allowed to be started automatically. Use the 'Save' method on the connection to save these changes to disk. Note that unsaved changes will be lost if the connection is reloaded from disk (either automatically on file change or due to an explicit ReloadConnections call).</para> +<para> Add new connection but do not save it to disk immediately. This operation + does not start the network connection unless (1) device is idle and able + to connect to the network described by the new connection, and (2) the + connection is allowed to be started automatically. Use the 'Save' method + on the connection to save these changes to disk. Note that unsaved changes + will be lost if the connection is reloaded from disk (either automatically + on file change or due to an explicit ReloadConnections call). +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>connection</parameter></literal>:</term> @@ -123,15 +138,21 @@ LoadConnections (IN as filenames, OUT b status, OUT as failures); </programlisting> -<para>Loads or reloads the indicated connections from disk. You should call this after making changes directly to an on-disk connection file to make sure that NetworkManager sees the changes. (If "monitor-connection-files" in NetworkManager.conf is "true", then this will have no real effect, but is harmless.) As with AddConnection(), this operation does not necessarily start the network connection.</para> +<para> Loads or reloads the indicated connections from disk. You should call this + after making changes directly to an on-disk connection file to make sure + that NetworkManager sees the changes. (If "monitor-connection-files" in + NetworkManager.conf is "true", then this will have no real effect, but is + harmless.) As with AddConnection(), this operation does not necessarily + start the network connection. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN as <parameter>filenames</parameter></literal>:</term> - <listitem><para>Array of paths to on-disk connection profiles in directories monitored by NetworkManager.</para></listitem> + <listitem><para>Array of paths to on-disk connection profiles in directories monitored by NetworkManager.</para></listitem> </varlistentry> <varlistentry> <term><literal>OUT b <parameter>status</parameter></literal>:</term> - <listitem><para>Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied).</para></listitem> + <listitem><para>Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied).</para></listitem> </varlistentry> <varlistentry> <term><literal>OUT as <parameter>failures</parameter></literal>:</term> @@ -145,7 +166,12 @@ LoadConnections (IN as filenames, <programlisting> ReloadConnections (OUT b status); </programlisting> -<para>Tells NetworkManager to reload all connection files from disk, including noticing any added or deleted connection files. By default, connections are re-read automatically any time they change, so you only need to use this command if you have set "monitor-connection-files=false" in NetworkManager.conf.</para> +<para> Tells NetworkManager to reload all connection files from disk, including + noticing any added or deleted connection files. By default, connections + are re-read automatically any time they change, so you only need to use + this command if you have set "monitor-connection-files=false" in + NetworkManager.conf. +</para> <variablelist role="params"> <varlistentry> <term><literal>OUT b <parameter>status</parameter></literal>:</term> @@ -159,11 +185,12 @@ ReloadConnections (OUT b status); <programlisting> SaveHostname (IN s hostname); </programlisting> -<para>Save the hostname to persistent configuration.</para> +<para> Save the hostname to persistent configuration. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN s <parameter>hostname</parameter></literal>:</term> - <listitem><para>The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.</para></listitem> + <listitem><para>The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -190,7 +217,15 @@ PropertiesChanged (a{sv} properties); <programlisting> NewConnection (o connection); </programlisting> -<para>Emitted when a new connection has been added after NetworkManager has started up and initialized. This signal is not emitted for connections read while starting up, because NetworkManager's D-Bus service is only available after all connections have been read, and to prevent spamming listeners with too many signals at one time. To retrieve the initial connection list, call the ListConnections() method once, and then listen for individual Settings.NewConnection and Settings.Connection.Deleted signals for further updates.</para> +<para> Emitted when a new connection has been added after NetworkManager has + started up and initialized. This signal is not emitted for connections + read while starting up, because NetworkManager's D-Bus service is only + available after all connections have been read, and to prevent spamming + listeners with too many signals at one time. To retrieve the initial + connection list, call the ListConnections() method once, and then listen + for individual Settings.NewConnection and Settings.Connection.Deleted + signals for further updates. +</para> <variablelist role="params"> <varlistentry> <term><literal>o <parameter>connection</parameter></literal>:</term> @@ -204,7 +239,12 @@ NewConnection (o connection); <programlisting> ConnectionRemoved (o connection); </programlisting> -<para>Emitted when a connection is no longer available. This happens when the connection is deleted or if it is no longer accessible by any of the system's logged-in users. After receipt of this signal, the connection no longer exists and cannot be used. Also see the Settings.Connection.Removed signal.</para> +<para> Emitted when a connection is no longer available. This happens when the + connection is deleted or if it is no longer accessible by any of the + system's logged-in users. After receipt of this signal, the connection no + longer exists and cannot be used. Also see the Settings.Connection.Removed + signal. +</para> <variablelist role="params"> <varlistentry> <term><literal>o <parameter>connection</parameter></literal>:</term> @@ -221,7 +261,8 @@ ConnectionRemoved (o connection); <programlisting> Connections readable ao </programlisting> -<para>List of object paths of available network connection profiles.</para> +<para> List of object paths of available network connection profiles. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Settings.Hostname"> <title>The "Hostname" property</title> @@ -229,7 +270,8 @@ Connections readable ao <programlisting> Hostname readable s </programlisting> -<para>The machine hostname stored in persistent configuration.</para> +<para> The machine hostname stored in persistent configuration. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Settings.CanModify"> <title>The "CanModify" property</title> @@ -237,7 +279,8 @@ Hostname readable s <programlisting> CanModify readable b </programlisting> -<para>If true, adding and modifying connections is supported.</para> +<para> If true, adding and modifying connections is supported. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml b/introspection/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml index b52c7409..74964757 100644 --- a/introspection/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml +++ b/introspection/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml @@ -22,7 +22,8 @@ </refsect1> <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-VPN-Connection"> <title role="desc.title">Description</title> - <para>Represents an active connection to a Virtual Private Network.</para> + <para> Represents an active connection to a Virtual Private Network. +</para> </refsect1> <refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.VPN.Connection"> <title role="details.title">Signal Details</title> @@ -47,15 +48,16 @@ PropertiesChanged (a{sv} properties); VpnStateChanged (u state, u reason); </programlisting> -<para>Emitted when the state of the VPN connection has changed.</para> +<para> Emitted when the state of the VPN connection has changed. +</para> <variablelist role="params"> <varlistentry> <term><literal>u <parameter>state</parameter></literal>:</term> - <listitem><para>The new state of the VPN connection.</para></listitem> + <listitem><para>(<link linkend="NMVpnConnectionState">NMVpnConnectionState</link>) The new state of the VPN connection.</para></listitem> </varlistentry> <varlistentry> <term><literal>u <parameter>reason</parameter></literal>:</term> - <listitem><para>Reason code describing the change to the new state.</para></listitem> + <listitem><para>(<link linkend="NMVpnConnectionStateReason">NMVpnConnectionStateReason</link>) Reason code describing the change to the new state.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -68,7 +70,9 @@ VpnStateChanged (u state, <programlisting> VpnState readable u </programlisting> -<para>The VPN-specific state of the connection.</para> +<para> The VPN-specific state of the connection. +</para><para> Returns: <link linkend="NMVpnConnectionState">NMVpnConnectionState</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-VPN-Connection.Banner"> <title>The "Banner" property</title> @@ -76,7 +80,8 @@ VpnState readable u <programlisting> Banner readable s </programlisting> -<para>The banner string of the VPN connection.</para> +<para> The banner string of the VPN connection. +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml b/introspection/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml index a3c249b0..80eaebc3 100644 --- a/introspection/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml +++ b/introspection/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml @@ -42,7 +42,9 @@ </refsect1> <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-VPN-Plugin"> <title role="desc.title">Description</title> - <para>This interface is provided by plugins providing VPN services to the NetworkManager daemon.</para> + <para> This interface is provided by plugins providing VPN services to the + NetworkManager daemon. +</para> </refsect1> <refsect1 role="details" id="gdbus-methods-org.freedesktop.NetworkManager.VPN.Plugin"> <title role="details.title">Method Details</title> @@ -52,7 +54,9 @@ <programlisting> Connect (IN a{sa{sv}} connection); </programlisting> -<para>Tells the plugin to connect. Interactive secrets requests (eg, emitting the SecretsRequired signal) are not allowed.</para> +<para> Tells the plugin to connect. Interactive secrets requests (eg, emitting + the SecretsRequired signal) are not allowed. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>connection</parameter></literal>:</term> @@ -67,7 +71,10 @@ Connect (IN a{sa{sv}} connection); ConnectInteractive (IN a{sa{sv}} connection, IN a{sv} details); </programlisting> -<para>Tells the plugin to connect, allowing interactive secrets requests (eg the plugin is allowed to emit the SecretsRequired signal if the VPN service indicates that it needs additional secrets during the connect process).</para> +<para> Tells the plugin to connect, allowing interactive secrets requests (eg the + plugin is allowed to emit the SecretsRequired signal if the VPN service + indicates that it needs additional secrets during the connect process). +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>connection</parameter></literal>:</term> @@ -86,7 +93,9 @@ ConnectInteractive (IN a{sa{sv}} connection, NeedSecrets (IN a{sa{sv}} settings, OUT s setting_name); </programlisting> -<para>Asks the plugin whether the provided connection will require secrets to connect successfully.</para> +<para> Asks the plugin whether the provided connection will require secrets to + connect successfully. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>settings</parameter></literal>:</term> @@ -104,7 +113,8 @@ NeedSecrets (IN a{sa{sv}} settings, <programlisting> Disconnect (); </programlisting> -<para>Disconnect the plugin.</para> +<para> Disconnect the plugin. +</para> </refsect2> <refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-VPN-Plugin.SetConfig"> <title>The SetConfig() method</title> @@ -112,7 +122,8 @@ Disconnect (); <programlisting> SetConfig (IN a{sv} config); </programlisting> -<para>Set generic connection details on the connection.</para> +<para> Set generic connection details on the connection. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sv} <parameter>config</parameter></literal>:</term> @@ -126,11 +137,12 @@ SetConfig (IN a{sv} config); <programlisting> SetIp4Config (IN a{sv} config); </programlisting> -<para>Set IPv4 details on the connection.</para> +<para> Set IPv4 details on the connection. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sv} <parameter>config</parameter></literal>:</term> - <listitem><para>Ip4Config details for the connection. You must call SetConfig() before calling this.</para></listitem> + <listitem><para>Ip4Config details for the connection. You must call SetConfig() before calling this.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -140,11 +152,12 @@ SetIp4Config (IN a{sv} config); <programlisting> SetIp6Config (IN a{sv} config); </programlisting> -<para>Set IPv6 details on the connection.</para> +<para> Set IPv6 details on the connection. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sv} <parameter>config</parameter></literal>:</term> - <listitem><para>Ip6Config details for the connection. You must call SetConfig() before calling this.</para></listitem> + <listitem><para>Ip6Config details for the connection. You must call SetConfig() before calling this.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -154,7 +167,8 @@ SetIp6Config (IN a{sv} config); <programlisting> SetFailure (IN s reason); </programlisting> -<para>Indicate a failure to the plugin.</para> +<para> Indicate a failure to the plugin. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN s <parameter>reason</parameter></literal>:</term> @@ -168,7 +182,9 @@ SetFailure (IN s reason); <programlisting> NewSecrets (IN a{sa{sv}} connection); </programlisting> -<para>Called in response to a SecretsRequired signal to deliver updated secrets or other information to the plugin.</para> +<para> Called in response to a SecretsRequired signal to deliver updated secrets + or other information to the plugin. +</para> <variablelist role="params"> <varlistentry> <term><literal>IN a{sa{sv}} <parameter>connection</parameter></literal>:</term> @@ -185,11 +201,12 @@ NewSecrets (IN a{sa{sv}} connection); <programlisting> StateChanged (u state); </programlisting> -<para>Emitted when the plugin state changes.</para> +<para> Emitted when the plugin state changes. +</para> <variablelist role="params"> <varlistentry> <term><literal>u <parameter>state</parameter></literal>:</term> - <listitem><para>The new state of the plugin.</para></listitem> + <listitem><para>(<link linkend="NMVpnServiceState">NMVpnServiceState</link>) The new state of the plugin.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -200,15 +217,18 @@ StateChanged (u state); SecretsRequired (s message, as secrets); </programlisting> -<para>Emitted during an ongoing ConnectInteractive() request when the plugin has determined that new secrets are required. NetworkManager will then call the NewSecrets() method with a connection hash including the new secrets.</para> +<para> Emitted during an ongoing ConnectInteractive() request when the plugin has + determined that new secrets are required. NetworkManager will then call + the NewSecrets() method with a connection hash including the new secrets. +</para> <variablelist role="params"> <varlistentry> <term><literal>s <parameter>message</parameter></literal>:</term> - <listitem><para>Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN.</para></listitem> + <listitem><para>Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN.</para></listitem> </varlistentry> <varlistentry> <term><literal>as <parameter>secrets</parameter></literal>:</term> - <listitem><para>Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end.</para></listitem> + <listitem><para>Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -218,7 +238,8 @@ SecretsRequired (s message, <programlisting> Config (a{sv} config); </programlisting> -<para>The plugin obtained generic configuration information.</para> +<para> The plugin obtained generic configuration information. +</para> <variablelist role="params"> <varlistentry> <term><literal>a{sv} <parameter>config</parameter></literal>:</term> @@ -232,7 +253,8 @@ Config (a{sv} config); <programlisting> Ip4Config (a{sv} ip4config); </programlisting> -<para>The plugin obtained an IPv4 configuration.</para> +<para> The plugin obtained an IPv4 configuration. +</para> <variablelist role="params"> <varlistentry> <term><literal>a{sv} <parameter>ip4config</parameter></literal>:</term> @@ -246,7 +268,8 @@ Ip4Config (a{sv} ip4config); <programlisting> Ip6Config (a{sv} ip6config); </programlisting> -<para>The plugin obtained an IPv6 configuration.</para> +<para> The plugin obtained an IPv6 configuration. +</para> <variablelist role="params"> <varlistentry> <term><literal>a{sv} <parameter>ip6config</parameter></literal>:</term> @@ -260,7 +283,8 @@ Ip6Config (a{sv} ip6config); <programlisting> LoginBanner (s banner); </programlisting> -<para>Emitted when the plugin receives a login banner from the VPN service.</para> +<para> Emitted when the plugin receives a login banner from the VPN service. +</para> <variablelist role="params"> <varlistentry> <term><literal>s <parameter>banner</parameter></literal>:</term> @@ -274,11 +298,12 @@ LoginBanner (s banner); <programlisting> Failure (u reason); </programlisting> -<para>Emitted when a failure in the VPN plugin occurs.</para> +<para> Emitted when a failure in the VPN plugin occurs. +</para> <variablelist role="params"> <varlistentry> <term><literal>u <parameter>reason</parameter></literal>:</term> - <listitem><para>Reason code for the failure.</para></listitem> + <listitem><para>(<link linkend="NMVpnPluginFailure">NMVpnPluginFailure</link>) Reason code for the failure.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -291,7 +316,9 @@ Failure (u reason); <programlisting> State readable u </programlisting> -<para>The state of the plugin.</para> +<para> The state of the plugin. +</para><para> Returns: <link linkend="NMVpnServiceState">NMVpnServiceState</link> +</para> </refsect2> </refsect1> </refentry> diff --git a/introspection/vpn-errors.xml b/introspection/vpn-errors.xml deleted file mode 100644 index c1e02aac..00000000 --- a/introspection/vpn-errors.xml +++ /dev/null @@ -1,60 +0,0 @@ -<?xml version="1.0" ?> -<tp:errors xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" - namespace="org.freedesktop.NetworkManager.VPN.Error"> - <tp:error name="General"> - <annotation name="org.gtk.GDBus.DocString" value="General failure without further details." /> - </tp:error> - <tp:error name="StartingInProgress"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is already starting, and another connect request was received. - " /> - </tp:error> - <tp:error name="AlreadyStarted"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is already connected, and another connect request was received. - " /> - </tp:error> - <tp:error name="StoppingInProgress"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is already stopping, and another stop request was received. - " /> - </tp:error> - <tp:error name="AlreadyStopped"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is already stopped, and another disconnect request was received. - " /> - </tp:error> - <tp:error name="WrongState"> - <annotation name="org.gtk.GDBus.DocString" value=" - The request could not be processed because the VPN plugin is in the wrong - state for this type of request. - " /> - </tp:error> - <tp:error name="BadArguments"> - <annotation name="org.gtk.GDBus.DocString" value=" - The request could not be processed because it contained malformed - arguments, or arguments of unexpected type. It usually means that one of - the VPN setting data items or secrets was not of the expected type (i.e. - int, string, bool, etc). - " /> - </tp:error> - <tp:error name="LaunchFailed"> - <annotation name="org.gtk.GDBus.DocString" value=" - A binary providing the service failed to launch. - " /> - </tp:error> - <tp:error name="ConnectionInvalid"> - <annotation name="org.gtk.GDBus.DocString" value=" - The request could not be processed because the connection was invalid. It - usually means that the connection's VPN setting was missing some required - data item or secret. - " /> - </tp:error> - <tp:error name="InteractiveNotSupported"> - <annotation name="org.gtk.GDBus.DocString" value=" - The request could not be processed because the plugin does not support - interactive operations, such as ConnectInteractive() or NewSecrets(). - " /> - </tp:error> -</tp:errors> - |