From 50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 Mon Sep 17 00:00:00 2001
From: Michael Biebl the WPA flags
@@ -311,7 +308,6 @@ nm_access_point_get_wpa_flags (
Returns
@@ -339,7 +335,6 @@ point.
Returns
the BSSID of the access point. This is an internal string and must
not be modified or freed.
-
@@ -422,7 +416,6 @@ nm_access_point_get_frequency (
Returns
the frequency
-
@@ -449,7 +442,6 @@ nm_access_point_get_mode (
Returns
the mode
-
@@ -476,7 +468,6 @@ nm_access_point_get_max_bitrate (
Returns
the maximum bit rate (kbit/s)
-
@@ -503,7 +494,6 @@ nm_access_point_get_strength (
Returns
the signal strength
-
@@ -592,7 +582,6 @@ against
Returns
TRUE if the connection may be activated with this Wi-Fi AP,
FALSE if it cannot be.
-
@@ -602,80 +591,60 @@ against
NM_ACCESS_POINT_FLAGS
#define NM_ACCESS_POINT_FLAGS "flags"
-
-
@@ -683,7 +652,7 @@ against
The “bssid” property
“bssid” gchar *
-
+The BSSID of the access point.
Flags: Read
Default value: NULL
@@ -691,14 +660,14 @@ against
The “frequency” property
“frequency” guint
-
+The frequency of the access point.
Flags: Read
Allowed values: <= 10000
Default value: 0
@@ -707,7 +676,7 @@ against
The “hw-address” property
“hw-address” gchar *
-
+Alias for “bssid”.
NMAccessPoint:hw-address has been deprecated since version 1.0 and should not be used in newly-written code.
use “bssid”.
@@ -719,7 +688,7 @@ against
The “max-bitrate” property
“max-bitrate” guint
-
+The maximum bit rate of the access point in kbit/s.
Flags: Read
Default value: 0
@@ -727,7 +696,9 @@ against
The “mode” property
“mode” NM80211Mode
-
+The mode of the access point; either "infrastructure" (a central
+coordinator of the wireless network allowing clients to connect) or
+"ad-hoc" (a network with no central controller).
Flags: Read
Default value: NM_802_11_MODE_INFRA
@@ -735,21 +706,21 @@ against
The “rsn-flags” property
“rsn-flags” NM80211ApSecurityFlags
-
+The RSN flags of the access point.
Flags: Read
The “ssid” property
“ssid” GBytes *
-
+The SSID of the access point, or NULL if it is not known.
Flags: Read
The “strength” property
“strength” guchar
-
+The current signal strength of the access point.
Flags: Read
Default value: 0
@@ -757,13 +728,12 @@ against
The “wpa-flags” property
“wpa-flags” NM80211ApSecurityFlags
-
+The WPA flags of the access point.
Flags: Read
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMActiveConnection.html b/docs/libnm/html/NMActiveConnection.html
index bbe1a3fe..a059c180 100644
--- a/docs/libnm/html/NMActiveConnection.html
+++ b/docs/libnm/html/NMActiveConnection.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMActiveConnection
+NMActiveConnection: libnm Reference Manual
-
+
@@ -338,8 +338,6 @@
Functions
@@ -396,7 +394,6 @@ nm_active_connection_get_id (Returns
the ID of the NMConnection that backs the NMActiveConnection.
This is the internal string used by the connection, and must not be modified.
-
@@ -424,7 +421,6 @@ nm_active_connection_get_uuid (Returns
the UUID of the NMConnection that backs the NMActiveConnection.
This is the internal string used by the connection, and must not be modified.
-
@@ -453,7 +449,6 @@ nm_active_connection_get_connection_type
Returns
the type of the NMConnection that backs the NMActiveConnection.
This is the internal string used by the connection, and must not be modified.
-
@@ -488,7 +483,6 @@ resolve it with Returns
the specific object's D-Bus path. This is the internal string used
by the connection, and must not be modified.
-
@@ -543,7 +537,6 @@ nm_active_connection_get_state (
Returns
the state
-
@@ -598,7 +591,6 @@ the default IPv4 route and DNS information).
@@ -684,7 +676,6 @@ the default IPv6 route and DNS information).
@@ -769,7 +760,6 @@ nm_active_connection_get_vpn (
Returns
TRUE if the active connection is a VPN connection
-
@@ -779,120 +769,90 @@ nm_active_connection_get_vpn (NM_ACTIVE_CONNECTION_CONNECTION
#define NM_ACTIVE_CONNECTION_CONNECTION "connection"
-
-
NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH
#define NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH "specific-object-path"
-
-
@@ -900,14 +860,14 @@ nm_active_connection_get_vpn (
The “connection” property
“connection” NMRemoteConnection *
-
+The connection that this is an active instance of.
Flags: Read
The “default” property
“default” gboolean
-
+Whether the active connection is the default IPv4 one.
Flags: Read
Default value: FALSE
@@ -915,7 +875,7 @@ nm_active_connection_get_vpn (
The “default6” property
“default6” gboolean
-
+Whether the active connection is the default IPv6 one.
Flags: Read
Default value: FALSE
@@ -923,28 +883,29 @@ nm_active_connection_get_vpn (
The “devices” property
“devices” GPtrArray *
-
+The devices of the active connection.
+Element-type: NMDevice
Flags: Read
The “dhcp4-config” property
“dhcp4-config” NMDhcpConfig *
-
+The IPv4 NMDhcpConfig of the connection.
Flags: Read
The “dhcp6-config” property
“dhcp6-config” NMDhcpConfig *
-
+The IPv6 NMDhcpConfig of the connection.
Flags: Read
@@ -952,28 +913,29 @@ nm_active_connection_get_vpn (
The “ip4-config” property
“ip4-config” NMIPConfig *
-
+The IPv4 NMIPConfig of the connection.
Flags: Read
The “ip6-config” property
“ip6-config” NMIPConfig *
-
+The IPv6 NMIPConfig of the connection.
Flags: Read
The “specific-object-path” property
“specific-object-path” gchar *
-
+The path to the "specific object" of the active connection; see
+nm_active_connection_get_specific_object_path() for more details.
Flags: Read
Default value: NULL
@@ -981,7 +943,7 @@ nm_active_connection_get_vpn (
The “state” property
“state” NMActiveConnectionState
-
+The state of the active connection.
Flags: Read
Default value: NM_ACTIVE_CONNECTION_STATE_UNKNOWN
@@ -989,7 +951,7 @@ nm_active_connection_get_vpn (
The “type” property
“type” gchar *
-
+The active connection's type
Flags: Read
Default value: NULL
@@ -997,7 +959,7 @@ nm_active_connection_get_vpn (
The “uuid” property
“uuid” gchar *
-
+The active connection's UUID
Flags: Read
Default value: NULL
@@ -1005,14 +967,13 @@ nm_active_connection_get_vpn (
The “vpn” property
“vpn” gboolean
-
+Whether the active connection is a VPN connection.
Flags: Read
Default value: FALSE
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html
index b038c231..950d7251 100644
--- a/docs/libnm/html/NMClient.html
+++ b/docs/libnm/html/NMClient.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMClient
+NMClient: libnm Reference Manual
-
+
@@ -759,8 +759,6 @@
Functions
@@ -772,7 +770,6 @@ nm_client_error_quark (void
Returns
the error quark used for NMClient errors.
-
@@ -810,7 +807,6 @@ that.
@@ -886,7 +882,6 @@ nm_client_new_finish (GAsyncResul
@@ -913,7 +908,6 @@ nm_client_get_version (
Returns
string with the version (or NULL if NetworkManager is not running)
-
@@ -940,7 +934,6 @@ nm_client_get_state (
Returns
the current NMState
-
@@ -968,7 +961,6 @@ connections at startup.
@@ -995,7 +987,6 @@ nm_client_get_nm_running (
Returns
TRUE if the daemon is running
-
@@ -1022,7 +1013,6 @@ nm_client_networking_get_enabled (
Returns
TRUE if networking is enabled, FALSE if networking is disabled
-
@@ -1065,7 +1055,6 @@ all controlled interfaces are available for activation.
@@ -1092,7 +1081,6 @@ nm_client_wireless_get_enabled (
Returns
TRUE if wireless is enabled
-
@@ -1150,7 +1138,6 @@ nm_client_wireless_hardware_get_enabled
@@ -1177,7 +1164,6 @@ nm_client_wwan_get_enabled (
Returns
TRUE if WWAN is enabled
-
@@ -1234,7 +1220,6 @@ nm_client_wwan_hardware_get_enabled (
Returns
TRUE if the WWAN hardware is enabled
-
@@ -1261,7 +1246,6 @@ nm_client_wimax_get_enabled (
Returns
TRUE if WiMAX is enabled
-
@@ -1318,7 +1302,6 @@ nm_client_wimax_hardware_get_enabled (
Returns
TRUE if the WiMAX hardware is enabled
-
@@ -1366,7 +1349,6 @@ a list of domains separated by ",".
@@ -1414,7 +1396,6 @@ domains separated by ",". (NULL or an empty string
@@ -1450,7 +1431,6 @@ client can or cannot perform the action the permission represents
@@ -1480,7 +1460,6 @@ connectivity state first before returning any information.
@@ -1525,7 +1504,6 @@ if you do not want to block.
@@ -1614,7 +1592,6 @@ call.
@@ -1663,7 +1640,6 @@ clear any existing persistent hostname.
@@ -1755,7 +1731,6 @@ nm_client_save_hostname_finish (
Returns
TRUE if the request was successful, FALSE if it failed
-
@@ -2256,7 +2231,6 @@ nm_client_deactivate_connection (
Returns
success or failure
-
@@ -2347,7 +2321,6 @@ nm_client_deactivate_connection_finish
@@ -2668,7 +2641,6 @@ filenames that failed to load.
TRUE if NetworkManager at least tried to load filenames
,
FALSE if an error occurred (eg, permission denied).
-
@@ -2770,7 +2742,6 @@ filenames that failed to load.
TRUE if NetworkManager at least tried to load filenames
,
FALSE if an error occurred (eg, permission denied).
-
@@ -2813,7 +2784,6 @@ the in-memory state matches the on-disk state.
@@ -2899,7 +2869,6 @@ nm_client_reload_connections_finish (
Returns
TRUE on success, FALSE on failure
-
@@ -2909,192 +2878,144 @@ nm_client_reload_connections_finish (NM_CLIENT_VERSION
#define NM_CLIENT_VERSION "version"
-
-
NM_CLIENT_WIRELESS_HARDWARE_ENABLED
#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
-
-
NM_CLIENT_WIMAX_HARDWARE_ENABLED
#define NM_CLIENT_WIMAX_HARDWARE_ENABLED "wimax-hardware-enabled"
-
-
@@ -3313,8 +3234,6 @@ the user requires to obtain a given NM_CLIENT_ERROR
#define NM_CLIENT_ERROR nm_client_error_quark ()
-
-
@@ -3322,21 +3241,23 @@ the user requires to obtain a given
The “activating-connection” property
“activating-connection” NMActiveConnection *
-
+The NMActiveConnection of the activating connection that is
+likely to become the new “primary-connection”.
Flags: Read
The “active-connections” property
“active-connections” GPtrArray *
-
+The active connections.
+Element-type: NMActiveConnection
Flags: Read
The “can-modify” property
“can-modify” gboolean
-
+If TRUE, adding and modifying connections is supported.
Flags: Read
Default value: FALSE
@@ -3344,14 +3265,18 @@ the user requires to obtain a given
The “connections” property
“connections” GPtrArray *
-
+The list of configured connections that are available to the user. (Note
+that this differs from the underlying D-Bus property, which may also
+contain the object paths of connections that the user does not have
+permission to read the details of.)
+Element-type: NMRemoteConnection
Flags: Read
The “connectivity” property
“connectivity” NMConnectivityState
-
+The network connectivity state.
Flags: Read
Default value: NM_CONNECTIVITY_UNKNOWN
@@ -3359,14 +3284,16 @@ the user requires to obtain a given
The “devices” property
“devices” GPtrArray *
-
+List of known network devices.
+Element-type: NMDevice
Flags: Read
The “hostname” property
“hostname” gchar *
-
+The machine hostname stored in persistent configuration. This can be
+modified by calling nm_client_save_hostname().
Flags: Read
Default value: NULL
@@ -3374,7 +3301,7 @@ the user requires to obtain a given
The “networking-enabled” property
“networking-enabled” gboolean
-
+Whether networking is enabled.
Flags: Read / Write
Default value: TRUE
@@ -3382,7 +3309,7 @@ the user requires to obtain a given
The “nm-running” property
“nm-running” gboolean
-
+Whether the daemon is running.
Flags: Read
Default value: FALSE
@@ -3390,14 +3317,15 @@ the user requires to obtain a given
The “primary-connection” property
“primary-connection” NMActiveConnection *
-
+The NMActiveConnection of the device with the default route;
+see nm_client_get_primary_connection() for more details.
Flags: Read
The “startup” property
“startup” gboolean
-
+Whether the daemon is still starting up.
Flags: Read
Default value: FALSE
@@ -3405,7 +3333,7 @@ the user requires to obtain a given
The “state” property
“state” NMState
-
+The current daemon state.
Flags: Read
Default value: NM_STATE_UNKNOWN
@@ -3413,7 +3341,7 @@ the user requires to obtain a given
The “version” property
“version” gchar *
-
+The NetworkManager version.
Flags: Read
Default value: NULL
@@ -3421,7 +3349,7 @@ the user requires to obtain a given
The “wimax-enabled” property
“wimax-enabled” gboolean
-
+Whether WiMAX functionality is enabled.
Flags: Read / Write
Default value: FALSE
@@ -3429,7 +3357,7 @@ the user requires to obtain a given
The “wimax-hardware-enabled” property
“wimax-hardware-enabled” gboolean
-
+Whether the WiMAX hardware is enabled.
Flags: Read
Default value: FALSE
@@ -3437,7 +3365,7 @@ the user requires to obtain a given
The “wireless-enabled” property
“wireless-enabled” gboolean
-
+Whether wireless is enabled.
Flags: Read / Write
Default value: FALSE
@@ -3445,7 +3373,7 @@ the user requires to obtain a given
The “wireless-hardware-enabled” property
“wireless-hardware-enabled” gboolean
-
+Whether the wireless hardware is enabled.
Flags: Read
Default value: TRUE
@@ -3453,7 +3381,7 @@ the user requires to obtain a given
The “wwan-enabled” property
“wwan-enabled” gboolean
-
+Whether WWAN functionality is enabled.
Flags: Read / Write
Default value: FALSE
@@ -3461,7 +3389,7 @@ the user requires to obtain a given
The “wwan-hardware-enabled” property
“wwan-hardware-enabled” gboolean
-
+Whether the WWAN hardware is enabled.
Flags: Read
Default value: FALSE
@@ -3474,6 +3402,34 @@ the user requires to obtain a given NMClient *client,
NMRemoteConnection *connection,
gpointer user_data)
+Notifies that a NMConnection has been added.
+
+Parameters
+
+
+
+
+
+
+
+
+client
+the settings object that received the signal
+
+
+
+connection
+the new connection
+
+
+
+user_data
+user data set when the signal handler was connected.
+
+
+
+
+
Flags: Run First
@@ -3483,6 +3439,34 @@ user_function (NMClient *client,
NMRemoteConnection *connection,
gpointer user_data)
+Notifies that a NMConnection has been removed.
+
+Parameters
+
+
+
+
+
+
+
+
+client
+the settings object that received the signal
+
+
+
+connection
+the removed connection
+
+
+
+user_data
+user data set when the signal handler was connected.
+
+
+
+
+
Flags: Run First
@@ -3492,6 +3476,34 @@ user_function (NMClient *client,
GObject *device,
gpointer user_data)
+Notifies that a NMDevice is added.
+
+Parameters
+
+
+
+
+
+
+
+
+client
+the client that received the signal
+
+
+
+device
+ the new device.
+[type NMDevice]
+
+
+user_data
+user data set when the signal handler was connected.
+
+
+
+
+
Flags: Run First
@@ -3501,6 +3513,34 @@ user_function (NMClient *client,
GObject *device,
gpointer user_data)
+Notifies that a NMDevice is removed.
+
+Parameters
+
+
+
+
+
+
+
+
+client
+the client that received the signal
+
+
+
+device
+ the removed device.
+[type NMDevice]
+
+
+user_data
+user data set when the signal handler was connected.
+
+
+
+
+
Flags: Run First
@@ -3511,12 +3551,44 @@ user_function (guint permission,
guint result,
gpointer user_data)
+Notifies that a permission has changed
+
+Parameters
+
+
+
+
+
+
+
+
+client
+the client that received the signal
+
+
+
+permission
+a permission from NMClientPermission
+
+
+
+result
+the permission's result, one of NMClientPermissionResult
+
+
+
+user_data
+user data set when the signal handler was connected.
+
+
+
+
+
Flags: Run First
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDevice.html b/docs/libnm/html/NMDevice.html
index 13cae2db..8065247c 100644
--- a/docs/libnm/html/NMDevice.html
+++ b/docs/libnm/html/NMDevice.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDevice
+NMDevice: libnm Reference Manual
-
+
@@ -626,8 +626,6 @@
Functions
@@ -655,7 +653,6 @@ nm_device_get_iface (Returns
the interface of the device. This is the internal string used by the
device, and must not be modified.
-
@@ -684,7 +681,6 @@ when the device is in the ACTIVATED state.
Returns
the IP traffic interface of the device. This is the internal string
used by the device, and must not be modified.
-
@@ -711,7 +707,6 @@ nm_device_get_device_type (
Returns
the device type
-
@@ -740,7 +735,6 @@ nm_device_get_udi (Returns
the driver of the device. This is the internal string used by the
device, and must not be modified.
-
@@ -796,7 +789,6 @@ nm_device_get_driver_version (Returns
the version of the device driver. This is the internal string used by the
device, and must not be modified.
-
@@ -824,7 +816,6 @@ nm_device_get_firmware_version (Returns
the firmware version of the device. This is the internal string used by the
device, and must not be modified.
-
@@ -854,7 +845,6 @@ nm_device_get_type_description (Returns
the type description of the device. This is the internal
string used by the device, and must not be modified.
-
@@ -883,7 +873,6 @@ nm_device_get_hw_address (Returns
the current MAC of the device, or NULL.
This is the internal string used by the device, and must not be modified.
-
@@ -910,7 +899,6 @@ nm_device_get_capabilities (
Returns
the capabilities
-
@@ -937,7 +925,6 @@ nm_device_get_managed (
Returns
TRUE if the device is managed by NetworkManager
-
@@ -964,7 +951,6 @@ nm_device_get_autoconnect (
Returns
TRUE if the device is allowed to be autoconnected
-
@@ -1023,7 +1009,6 @@ to be missing.
Returns
TRUE if firmware required for the device's operation is likely
to be missing.
-
@@ -1169,7 +1154,6 @@ nm_device_get_state (
Returns
the current device state
-
@@ -1196,7 +1180,6 @@ nm_device_get_state_reason (
Returns
the reason for entering the current device state
-
@@ -1287,7 +1270,6 @@ ports on a single physical port. (Eg, NPAR / SR-IOV.)
the physical port ID of the device, or NULL if the port
ID is unknown. This is the internal string used by the device and
must not be modified.
-
@@ -1314,7 +1296,6 @@ nm_device_get_mtu (
Returns
the MTU of the device.
-
@@ -1342,7 +1323,6 @@ nm_device_is_software (Returns
TRUE if device
is a software device, FALSE if it is a hardware device.
-
@@ -1370,7 +1350,6 @@ nm_device_get_product (Returns
the product name of the device. This is the internal string used by the
device, and must not be modified.
-
@@ -1398,7 +1377,6 @@ nm_device_get_vendor (Returns
the vendor name of the device. This is the internal string used by the
device, and must not be modified.
-
@@ -1428,7 +1406,6 @@ nm_device_get_description (device
. If either the vendor or the
product name is unknown, this returns the interface name.
-
@@ -1510,7 +1487,6 @@ request.
Returns
TRUE on success, FALSE on error, in which case error
will be set.
-
@@ -1597,7 +1573,6 @@ nm_device_disconnect_finish (Returns
TRUE on success, FALSE on error, in which case error
will be set.
-
@@ -1639,7 +1614,6 @@ nm_device_delete (Returns
TRUE on success, FALSE on error, in which case error
will be set.
-
@@ -1725,7 +1699,6 @@ nm_device_delete_finish (Returns
TRUE on success, FALSE on error, in which case error
will be set.
-
@@ -1817,7 +1790,6 @@ against
Returns
TRUE if the connection may be activated with this device, FALSE
if is incompatible with the device's capabilities and characteristics.
-
@@ -1871,7 +1843,6 @@ against
Returns
TRUE if the connection may be activated with this device, FALSE
if is incompatible with the device's capabilities and characteristics.
-
@@ -1901,7 +1872,6 @@ that can be used on device
Returns
device
's associated NMSetting type
-
@@ -1911,184 +1881,138 @@ that can be used on device
NM_DEVICE_DEVICE_TYPE
#define NM_DEVICE_DEVICE_TYPE "device-type"
-
-
@@ -2096,14 +2020,14 @@ that can be used on device
The “active-connection” property
“active-connection” NMActiveConnection *
-
+The NMActiveConnection object that "owns" this device during activation.
Flags: Read
The “autoconnect” property
“autoconnect” gboolean
-
+Whether the device can auto-activate a connection.
Flags: Read / Write
Default value: TRUE
@@ -2111,21 +2035,22 @@ that can be used on device
The “available-connections” property
“available-connections” GPtrArray *
-
+The available connections of the device
+Element-type: NMRemoteConnection
Flags: Read
The “capabilities” property
“capabilities” NMDeviceCapabilities
-
+The capabilities of the device.
Flags: Read
The “device-type” property
“device-type” NMDeviceType
-
+The numeric type of the device.
Flags: Read
Default value: NM_DEVICE_TYPE_UNKNOWN
@@ -2133,21 +2058,21 @@ that can be used on device
The “dhcp4-config” property
“dhcp4-config” NMDhcpConfig *
-
+The IPv4 NMDhcpConfig of the device.
Flags: Read
The “dhcp6-config” property
“dhcp6-config” NMDhcpConfig *
-
+The IPv6 NMDhcpConfig of the device.
Flags: Read
@@ -2155,7 +2080,7 @@ that can be used on device
The “driver-version” property
“driver-version” gchar *
-
+The version of the device driver.
Flags: Read
Default value: NULL
@@ -2163,7 +2088,8 @@ that can be used on device
The “firmware-missing” property
“firmware-missing” gboolean
-
+When TRUE indicates the device is likely missing firmware required
+for its operation.
Flags: Read
Default value: FALSE
@@ -2171,7 +2097,7 @@ that can be used on device
The “firmware-version” property
“firmware-version” gchar *
-
+The firmware version of the device.
Flags: Read
Default value: NULL
@@ -2179,7 +2105,7 @@ that can be used on device
The “interface” property
“interface” gchar *
-
+The interface of the device.
Flags: Read
Default value: NULL
@@ -2187,7 +2113,8 @@ that can be used on device
The “ip-interface” property
“ip-interface” gchar *
-
+The IP interface of the device which should be used for all IP-related
+operations like addressing and routing.
Flags: Read
Default value: NULL
@@ -2195,21 +2122,21 @@ that can be used on device
The “ip6-config” property
“ip6-config” NMIPConfig *
-
+The IPv6 NMIPConfig of the device.
Flags: Read
The “managed” property
“managed” gboolean
-
+Whether the device is managed by NetworkManager.
Flags: Read
Default value: FALSE
@@ -2217,7 +2144,7 @@ that can be used on device
@@ -2225,7 +2152,8 @@ that can be used on device
The “physical-port-id” property
“physical-port-id” gchar *
-
+The physical port ID of the device. (See
+nm_device_get_physical_port_id().)
Flags: Read
Default value: NULL
@@ -2233,7 +2161,7 @@ that can be used on device
The “product” property
“product” gchar *
-
+The product string of the device.
Flags: Read
Default value: NULL
@@ -2241,7 +2169,7 @@ that can be used on device
The “state” property
“state” NMDeviceState
-
+The state of the device.
Flags: Read
Default value: NM_DEVICE_STATE_UNKNOWN
@@ -2249,7 +2177,7 @@ that can be used on device
The “state-reason” property
“state-reason” guint
-
+The reason for the device state.
Flags: Read
Default value: 0
@@ -2257,7 +2185,12 @@ that can be used on device
The “udi” property
“udi” gchar *
-
+An operating-system specific device hardware identifier; this is not
+unique to a specific hardware device across reboots or hotplugs. It
+is an opaque string which for some device types (Bluetooth, Modem)
+contains an identifier provided by the underlying hardware service daemon
+such as Bluez or ModemManager, and clients can use this property to
+request more information about the device from those services.
Flags: Read
Default value: NULL
@@ -2265,7 +2198,7 @@ that can be used on device
The “vendor” property
“vendor” gchar *
-
+The vendor string of the device.
Flags: Read
Default value: NULL
@@ -2280,12 +2213,49 @@ user_function (guint old_state,
guint reason,
gpointer user_data)
+Notifies the state change of a NMDevice.
+
+Parameters
+
+
+
+
+
+
+
+
+device
+the device object that received the signal
+
+
+
+new_state
+the new state of the device
+
+
+
+old_state
+the previous state of the device
+
+
+
+reason
+the reason describing the state change
+
+
+
+user_data
+user data set when the signal handler was connected.
+
+
+
+
+
Flags: Run First
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceAdsl.html b/docs/libnm/html/NMDeviceAdsl.html
index 168d4ad8..7c9c5612 100644
--- a/docs/libnm/html/NMDeviceAdsl.html
+++ b/docs/libnm/html/NMDeviceAdsl.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceAdsl
+NMDeviceAdsl: libnm Reference Manual
-
+
@@ -88,8 +88,6 @@
@@ -126,8 +123,6 @@ nm_device_adsl_get_carrier (NM_DEVICE_ADSL_CARRIER
#define NM_DEVICE_ADSL_CARRIER "carrier"
-
-
@@ -135,14 +130,13 @@ nm_device_adsl_get_carrier (
The “carrier” property
“carrier” gboolean
-
+Whether the device has carrier.
Flags: Read
Default value: FALSE
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceBond.html b/docs/libnm/html/NMDeviceBond.html
index 03023581..b99d8ba3 100644
--- a/docs/libnm/html/NMDeviceBond.html
+++ b/docs/libnm/html/NMDeviceBond.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceBond
+NMDeviceBond: libnm Reference Manual
-
+
@@ -128,8 +128,6 @@
Functions
@@ -157,7 +155,6 @@ nm_device_bond_get_hw_address (Returns
the hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -184,7 +181,6 @@ nm_device_bond_get_carrier (
Returns
TRUE if the device has carrier
-
@@ -225,24 +221,18 @@ copy used by the device, and must not be modified.
NM_DEVICE_BOND_HW_ADDRESS
#define NM_DEVICE_BOND_HW_ADDRESS "hw-address"
-
-
@@ -250,7 +240,7 @@ copy used by the device, and must not be modified.
The “carrier” property
“carrier” gboolean
-
+Whether the device has carrier.
Flags: Read
Default value: FALSE
@@ -258,7 +248,7 @@ copy used by the device, and must not be modified.
@@ -266,13 +256,13 @@ copy used by the device, and must not be modified.
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceBridge.html b/docs/libnm/html/NMDeviceBridge.html
index 6fd332de..dee83c75 100644
--- a/docs/libnm/html/NMDeviceBridge.html
+++ b/docs/libnm/html/NMDeviceBridge.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceBridge
+NMDeviceBridge: libnm Reference Manual
-
+
@@ -128,8 +128,6 @@
Functions
@@ -157,7 +155,6 @@ nm_device_bridge_get_hw_address (Returns
the hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -184,7 +181,6 @@ nm_device_bridge_get_carrier (
Returns
TRUE if the device has carrier
-
@@ -225,24 +221,18 @@ copy used by the device, and must not be modified.
NM_DEVICE_BRIDGE_HW_ADDRESS
#define NM_DEVICE_BRIDGE_HW_ADDRESS "hw-address"
-
-
@@ -250,7 +240,7 @@ copy used by the device, and must not be modified.
The “carrier” property
“carrier” gboolean
-
+Whether the device has carrier.
Flags: Read
Default value: FALSE
@@ -258,7 +248,7 @@ copy used by the device, and must not be modified.
@@ -266,13 +256,13 @@ copy used by the device, and must not be modified.
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceBt.html b/docs/libnm/html/NMDeviceBt.html
index 8aad8df8..b8cb2689 100644
--- a/docs/libnm/html/NMDeviceBt.html
+++ b/docs/libnm/html/NMDeviceBt.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceBt
+NMDeviceBt: libnm Reference Manual
-
+
@@ -128,8 +128,6 @@
Functions
@@ -157,7 +155,6 @@ nm_device_bt_get_hw_address (Returns
the hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -184,7 +181,6 @@ nm_device_bt_get_name (
Returns
the name of the device
-
@@ -211,7 +207,6 @@ nm_device_bt_get_capabilities (
Returns
a combination of NMBluetoothCapabilities
-
@@ -221,24 +216,18 @@ nm_device_bt_get_capabilities (NM_DEVICE_BT_HW_ADDRESS
#define NM_DEVICE_BT_HW_ADDRESS "hw-address"
-
-
@@ -246,14 +235,14 @@ nm_device_bt_get_capabilities (
The “bt-capabilities” property
“bt-capabilities” NMBluetoothCapabilities
-
+The device's bluetooth capabilities, a combination of NMBluetoothCapabilities.
Flags: Read
The “hw-address” property
“hw-address” gchar *
-
+The hardware (MAC) address of the device.
Flags: Read
Default value: NULL
@@ -261,14 +250,13 @@ nm_device_bt_get_capabilities (
The “name” property
“name” gchar *
-
+The name of the bluetooth device.
Flags: Read
Default value: NULL
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceEthernet.html b/docs/libnm/html/NMDeviceEthernet.html
index 2beee10d..04e68bda 100644
--- a/docs/libnm/html/NMDeviceEthernet.html
+++ b/docs/libnm/html/NMDeviceEthernet.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceEthernet
+NMDeviceEthernet: libnm Reference Manual
-
+
@@ -145,8 +145,6 @@
Functions
@@ -174,7 +172,6 @@ nm_device_ethernet_get_hw_address (Returns
the active hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -203,7 +200,6 @@ nm_device_ethernet_get_permanent_hw_address
Returns
the permanent hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -230,7 +226,6 @@ nm_device_ethernet_get_speed (
Returns
the speed of the device
-
@@ -257,7 +252,6 @@ nm_device_ethernet_get_carrier (
Returns
TRUE if the device has carrier
-
@@ -267,32 +261,24 @@ nm_device_ethernet_get_carrier (NM_DEVICE_ETHERNET_HW_ADDRESS
#define NM_DEVICE_ETHERNET_HW_ADDRESS "hw-address"
-
-
NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS
#define NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS "perm-hw-address"
-
-
@@ -300,7 +286,7 @@ nm_device_ethernet_get_carrier (
The “carrier” property
“carrier” gboolean
-
+Whether the device has carrier.
Flags: Read
Default value: FALSE
@@ -308,7 +294,7 @@ nm_device_ethernet_get_carrier (
The “hw-address” property
“hw-address” gchar *
-
+The active hardware (MAC) address of the device.
Flags: Read
Default value: NULL
@@ -316,7 +302,7 @@ nm_device_ethernet_get_carrier (
The “perm-hw-address” property
“perm-hw-address” gchar *
-
+The permanent hardware (MAC) address of the device.
Flags: Read
Default value: NULL
@@ -324,14 +310,13 @@ nm_device_ethernet_get_carrier (
The “speed” property
“speed” guint
-
+The speed of the device.
Flags: Read
Default value: 0
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceGeneric.html b/docs/libnm/html/NMDeviceGeneric.html
index 28a8bb86..8144c52f 100644
--- a/docs/libnm/html/NMDeviceGeneric.html
+++ b/docs/libnm/html/NMDeviceGeneric.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceGeneric
+NMDeviceGeneric: libnm Reference Manual
-
+
@@ -102,8 +102,6 @@
Functions
@@ -131,7 +129,6 @@ nm_device_generic_get_hw_address (Returns
the hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -141,16 +138,12 @@ device, and must not be modified.
NM_DEVICE_GENERIC_HW_ADDRESS
#define NM_DEVICE_GENERIC_HW_ADDRESS "hw-address"
-
-
NM_DEVICE_GENERIC_TYPE_DESCRIPTION
#define NM_DEVICE_GENERIC_TYPE_DESCRIPTION "type-description"
-
-
@@ -158,7 +151,7 @@ device, and must not be modified.
@@ -166,14 +159,14 @@ device, and must not be modified.
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceInfiniband.html b/docs/libnm/html/NMDeviceInfiniband.html
index 60783944..310d8550 100644
--- a/docs/libnm/html/NMDeviceInfiniband.html
+++ b/docs/libnm/html/NMDeviceInfiniband.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceInfiniband
+NMDeviceInfiniband: libnm Reference Manual
-
+
@@ -111,8 +111,6 @@
Functions
@@ -140,7 +138,6 @@ nm_device_infiniband_get_hw_address (Returns
the hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -167,7 +164,6 @@ nm_device_infiniband_get_carrier (
Returns
TRUE if the device has carrier
-
@@ -177,16 +173,12 @@ nm_device_infiniband_get_carrier (NM_DEVICE_INFINIBAND_HW_ADDRESS
#define NM_DEVICE_INFINIBAND_HW_ADDRESS "hw-address"
-
-
@@ -194,7 +186,7 @@ nm_device_infiniband_get_carrier (
The “carrier” property
“carrier” gboolean
-
+Whether the device has carrier.
Flags: Read
Default value: FALSE
@@ -202,14 +194,13 @@ nm_device_infiniband_get_carrier (
The “hw-address” property
“hw-address” gchar *
-
+The hardware (MAC) address of the device.
Flags: Read
Default value: NULL
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceModem.html b/docs/libnm/html/NMDeviceModem.html
index 49cd12df..63f1dbf6 100644
--- a/docs/libnm/html/NMDeviceModem.html
+++ b/docs/libnm/html/NMDeviceModem.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceModem
+NMDeviceModem: libnm Reference Manual
-
+
@@ -111,8 +111,6 @@
@@ -173,7 +170,6 @@ represents the network types the modem can immediately connect to.
Returns
the generic access technology families the modem supports without
a firmware reload or other reinitialization
-
@@ -183,16 +179,12 @@ a firmware reload or other reinitialization
NM_DEVICE_MODEM_MODEM_CAPABILITIES
#define NM_DEVICE_MODEM_MODEM_CAPABILITIES "modem-capabilities"
-
-
NM_DEVICE_MODEM_CURRENT_CAPABILITIES
#define NM_DEVICE_MODEM_CURRENT_CAPABILITIES "current-capabilities"
-
-
@@ -200,20 +192,23 @@ a firmware reload or other reinitialization
The “current-capabilities” property
“current-capabilities” NMDeviceModemCapabilities
-
+The generic family of access technologies the modem currently supports
+without a firmware reload or reinitialization.
Flags: Read
The “modem-capabilities” property
“modem-capabilities” NMDeviceModemCapabilities
-
+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.
Flags: Read
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceOlpcMesh.html b/docs/libnm/html/NMDeviceOlpcMesh.html
index 0bdbf9aa..1e4e036a 100644
--- a/docs/libnm/html/NMDeviceOlpcMesh.html
+++ b/docs/libnm/html/NMDeviceOlpcMesh.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceOlpcMesh
+NMDeviceOlpcMesh: libnm Reference Manual
-
+
@@ -129,8 +129,6 @@
Functions
@@ -158,7 +156,6 @@ nm_device_olpc_mesh_get_hw_address (Returns
the hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -213,7 +210,6 @@ nm_device_olpc_mesh_get_active_channel
@@ -223,24 +219,18 @@ nm_device_olpc_mesh_get_active_channel
NM_DEVICE_OLPC_MESH_HW_ADDRESS
#define NM_DEVICE_OLPC_MESH_HW_ADDRESS "hw-address"
-
-
@@ -248,7 +238,7 @@ nm_device_olpc_mesh_get_active_channel
The “active-channel” property
“active-channel” guint
-
+The device's active channel.
Flags: Read
Default value: 0
@@ -256,21 +246,20 @@ nm_device_olpc_mesh_get_active_channel
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceTeam.html b/docs/libnm/html/NMDeviceTeam.html
index ded0ca8f..9290d518 100644
--- a/docs/libnm/html/NMDeviceTeam.html
+++ b/docs/libnm/html/NMDeviceTeam.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceTeam
+NMDeviceTeam: libnm Reference Manual
-
+
@@ -128,8 +128,6 @@
Functions
@@ -157,7 +155,6 @@ nm_device_team_get_hw_address (Returns
the hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -184,7 +181,6 @@ nm_device_team_get_carrier (
Returns
TRUE if the device has carrier
-
@@ -225,24 +221,18 @@ copy used by the device, and must not be modified.
NM_DEVICE_TEAM_HW_ADDRESS
#define NM_DEVICE_TEAM_HW_ADDRESS "hw-address"
-
-
@@ -250,7 +240,7 @@ copy used by the device, and must not be modified.
The “carrier” property
“carrier” gboolean
-
+Whether the device has carrier.
Flags: Read
Default value: FALSE
@@ -258,7 +248,7 @@ copy used by the device, and must not be modified.
@@ -266,13 +256,13 @@ copy used by the device, and must not be modified.
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceVlan.html b/docs/libnm/html/NMDeviceVlan.html
index 3febf838..1101eb80 100644
--- a/docs/libnm/html/NMDeviceVlan.html
+++ b/docs/libnm/html/NMDeviceVlan.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceVlan
+NMDeviceVlan: libnm Reference Manual
-
+
@@ -146,8 +146,6 @@
Functions
@@ -175,7 +173,6 @@ nm_device_vlan_get_hw_address (Returns
the hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -202,7 +199,6 @@ nm_device_vlan_get_carrier (
Returns
TRUE if the device has carrier
-
@@ -254,7 +250,6 @@ nm_device_vlan_get_vlan_id (
Returns
the device's VLAN ID
-
@@ -264,32 +259,24 @@ nm_device_vlan_get_vlan_id (NM_DEVICE_VLAN_HW_ADDRESS
#define NM_DEVICE_VLAN_HW_ADDRESS "hw-address"
-
-
@@ -297,7 +284,7 @@ nm_device_vlan_get_vlan_id (
The “carrier” property
“carrier” gboolean
-
+Whether the device has carrier.
Flags: Read
Default value: FALSE
@@ -305,7 +292,7 @@ nm_device_vlan_get_vlan_id (
The “hw-address” property
“hw-address” gchar *
-
+The hardware (MAC) address of the device.
Flags: Read
Default value: NULL
@@ -313,14 +300,14 @@ nm_device_vlan_get_vlan_id (
The “parent” property
“parent” NMDevice *
-
+The devices's parent device.
Flags: Read
The “vlan-id” property
“vlan-id” guint
-
+The device's VLAN ID.
Flags: Read
Allowed values: <= 4095
Default value: 0
@@ -328,7 +315,6 @@ nm_device_vlan_get_vlan_id (
-
- Generated by GTK-Doc V1.21
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceWifi.html b/docs/libnm/html/NMDeviceWifi.html
index 6bbad017..db0dca47 100644
--- a/docs/libnm/html/NMDeviceWifi.html
+++ b/docs/libnm/html/NMDeviceWifi.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceWifi
+NMDeviceWifi: libnm Reference Manual
-
+
@@ -252,8 +252,6 @@
Functions
@@ -281,7 +279,6 @@ nm_device_wifi_get_hw_address (Returns
the actual hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -310,7 +307,6 @@ nm_device_wifi_get_permanent_hw_address
Returns
the permanent hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -337,7 +333,6 @@ nm_device_wifi_get_mode (
Returns
the mode
-
@@ -364,7 +359,6 @@ nm_device_wifi_get_bitrate (
Returns
the bit rate (kbit/s)
-
@@ -391,7 +385,6 @@ nm_device_wifi_get_capabilities (
Returns
the capabilities
-
@@ -530,7 +523,6 @@ after that for the scan to complete.
TRUE on success, FALSE on error, in which case error
will be
set.
-
@@ -620,7 +612,6 @@ nm_device_wifi_request_scan_finish ( TRUE on success, FALSE on error, in which case error
will be
set.
-
@@ -630,56 +621,42 @@ set.
NM_DEVICE_WIFI_HW_ADDRESS
#define NM_DEVICE_WIFI_HW_ADDRESS "hw-address"
-
-
NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS
#define NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS "perm-hw-address"
-
-
NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT
#define NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT "active-access-point"
-
-
@@ -687,21 +664,22 @@ set.
The “access-points” property
“access-points” GPtrArray *
-
+List of all Wi-Fi access points the device can see.
+Element-type: NMAccessPoint
Flags: Read
The “active-access-point” property
“active-access-point” NMAccessPoint *
-
+The active NMAccessPoint of the device.
Flags: Read
The “bitrate” property
“bitrate” guint
-
+The bit rate of the device in kbit/s.
Flags: Read
Default value: 0
@@ -709,7 +687,7 @@ set.
The “hw-address” property
“hw-address” gchar *
-
+The hardware (MAC) address of the device.
Flags: Read
Default value: NULL
@@ -717,7 +695,7 @@ set.
The “mode” property
“mode” NM80211Mode
-
+The mode of the device.
Flags: Read
Default value: NM_802_11_MODE_UNKNOWN
@@ -725,7 +703,7 @@ set.
The “perm-hw-address” property
“perm-hw-address” gchar *
-
+The hardware (MAC) address of the device.
Flags: Read
Default value: NULL
@@ -733,7 +711,7 @@ set.
The “wireless-capabilities” property
“wireless-capabilities” NMDeviceWifiCapabilities
-
+The wireless capabilities of the device.
Flags: Read
@@ -745,6 +723,34 @@ set.
user_function (NMDeviceWifi *device,
GObject *ap,
gpointer user_data)
+Notifies that a NMAccessPoint is added to the Wi-Fi device.
+
+Parameters
+
+
+
+
+
+
+
+
+device
+the Wi-Fi device that received the signal
+
+
+
+ap
+the new access point
+
+
+
+user_data
+user data set when the signal handler was connected.
+
+
+
+
+
Flags: Run First
@@ -754,12 +760,39 @@ user_function (NMDeviceWifi *device,
GObject *ap,
gpointer user_data)
+Notifies that a NMAccessPoint is removed from the Wi-Fi device.
+
+Parameters
+
+
+
+
+
+
+
+
+device
+the Wi-Fi device that received the signal
+
+
+
+ap
+the removed access point
+
+
+
+user_data
+user data set when the signal handler was connected.
+
+
+
+
+
Flags: Run First
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDeviceWimax.html b/docs/libnm/html/NMDeviceWimax.html
index f1d58b57..4fc7c558 100644
--- a/docs/libnm/html/NMDeviceWimax.html
+++ b/docs/libnm/html/NMDeviceWimax.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDeviceWimax
+NMDeviceWimax: libnm Reference Manual
-
+
@@ -245,8 +245,6 @@
Functions
@@ -274,7 +272,6 @@ nm_device_wimax_get_hw_address (Returns
the hardware address. This is the internal string used by the
device, and must not be modified.
-
@@ -394,7 +391,6 @@ device is not connected.
@@ -424,7 +420,6 @@ device is not connected.
@@ -453,7 +448,6 @@ meaning when the device is not connected.
@@ -482,7 +476,6 @@ nm_device_wimax_get_tx_power (
Returns
the TX power in dBm, or 0
-
@@ -509,7 +502,6 @@ nm_device_wimax_get_bsid (
Returns
the ID of the serving Base Station, or NULL
-
@@ -519,64 +511,48 @@ nm_device_wimax_get_bsid (NM_DEVICE_WIMAX_HW_ADDRESS
#define NM_DEVICE_WIMAX_HW_ADDRESS "hw-address"
-
-
@@ -584,14 +560,15 @@ nm_device_wimax_get_bsid (
The “active-nsp” property
“active-nsp” NMWimaxNsp *
-
+The active NMWimaxNsp of the device.
Flags: Read
The “bsid” property
“bsid” gchar *
-
+The ID of the serving base station as received from the network. Has
+no meaning when the device is not connected.
Flags: Read
Default value: NULL
@@ -599,7 +576,9 @@ nm_device_wimax_get_bsid (
The “center-frequency” property
“center-frequency” guint
-
+The 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.
Flags: Read
Default value: 0
@@ -607,7 +586,9 @@ nm_device_wimax_get_bsid (
The “cinr” property
“cinr” gint
-
+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.
Flags: Read
Default value: 0
@@ -615,7 +596,7 @@ nm_device_wimax_get_bsid (
The “hw-address” property
“hw-address” gchar *
-
+The hardware (MAC) address of the device.
Flags: Read
Default value: NULL
@@ -623,14 +604,18 @@ nm_device_wimax_get_bsid (
The “nsps” property
“nsps” GPtrArray *
-
+List of all WiMAX Network Service Providers the device can see.
+Element-type: NMWimaxNsp
Flags: Read
The “rssi” property
“rssi” gint
-
+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.
Flags: Read
Default value: 0
@@ -638,7 +623,9 @@ nm_device_wimax_get_bsid (
The “tx-power” property
“tx-power” gint
-
+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.
Flags: Read
Default value: 0
@@ -651,6 +638,34 @@ nm_device_wimax_get_bsid (NMDeviceWimax *self,
GObject *nsp,
gpointer user_data)
+Notifies that a NMWimaxNsp is added to the wimax device.
+
+Parameters
+
+
+
+
+
+
+
+
+self
+the wimax device that received the signal
+
+
+
+nsp
+the new NSP
+
+
+
+user_data
+user data set when the signal handler was connected.
+
+
+
+
+
Flags: Run First
@@ -660,12 +675,39 @@ user_function (<
user_function (NMDeviceWimax *self,
GObject *nsp,
gpointer user_data)
+Notifies that a NMWimaxNsp is removed from the wimax device.
+
+Parameters
+
+
+
+
+
+
+
+
+self
+the wimax device that received the signal
+
+
+
+nsp
+the removed NSP
+
+
+
+user_data
+user data set when the signal handler was connected.
+
+
+
+
+
Flags: Run First
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMDhcpConfig.html b/docs/libnm/html/NMDhcpConfig.html
index 3a4a0229..a1e97a8a 100644
--- a/docs/libnm/html/NMDhcpConfig.html
+++ b/docs/libnm/html/NMDhcpConfig.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMDhcpConfig
+NMDhcpConfig: libnm Reference Manual
-
+
@@ -118,8 +118,6 @@
Functions
@@ -147,7 +145,6 @@ nm_dhcp_config_get_family (Returns
the IP address family; either AF_INET or
AF_INET6
-
@@ -212,7 +209,6 @@ nm_dhcp_config_get_one_option (Returns
the configuration option's value. This is the internal string used by the
configuration, and must not be modified.
-
@@ -222,16 +218,12 @@ configuration, and must not be modified.
NM_DHCP_CONFIG_FAMILY
#define NM_DHCP_CONFIG_FAMILY "family"
-
-
@@ -239,7 +231,8 @@ configuration, and must not be modified.
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMIPConfig.html b/docs/libnm/html/NMIPConfig.html
index a93213ab..9a32ecb6 100644
--- a/docs/libnm/html/NMIPConfig.html
+++ b/docs/libnm/html/NMIPConfig.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMIPConfig
+NMIPConfig: libnm Reference Manual
-
+
@@ -210,8 +210,6 @@
Functions
@@ -239,7 +237,6 @@ nm_ip_config_get_family (Returns
the IP address family; either AF_INET or
AF_INET6
-
@@ -445,64 +442,48 @@ nm_ip_config_get_wins_servers (NM_IP_CONFIG_FAMILY
#define NM_IP_CONFIG_FAMILY "family"
-
-
@@ -510,21 +491,22 @@ nm_ip_config_get_wins_servers (
The “addresses” property
“addresses” GPtrArray *
-
+A GPtrArray containing the addresses (NMIPAddress) of the configuration.
Flags: Read
The “domains” property
“domains” GStrv
-
+The array containing domain strings of the configuration.
Flags: Read
The “family” property
“family” gint
-
+The IP address family of the configuration; either
+AF_INET or AF_INET6.
Flags: Read
Allowed values: [0,255]
Default value: 0
@@ -533,7 +515,7 @@ nm_ip_config_get_wins_servers (
The “gateway” property
“gateway” gchar *
-
+The IP gateway address of the configuration as string.
Flags: Read
Default value: NULL
@@ -541,34 +523,34 @@ nm_ip_config_get_wins_servers (
The “nameservers” property
“nameservers” GStrv
-
+The array containing name server IP addresses of the configuration.
Flags: Read
The “routes” property
“routes” GPtrArray *
-
+A GPtrArray containing the routes (NMIPRoute) of the configuration.
Flags: Read
The “searches” property
“searches” GStrv
-
+The array containing DNS search strings of the configuration.
Flags: Read
The “wins-servers” property
“wins-servers” GStrv
-
+The array containing WINS server IP addresses of the configuration.
+(This will always be empty for IPv6 configurations.)
Flags: Read
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMObject.html b/docs/libnm/html/NMObject.html
index 38da67a0..c9779152 100644
--- a/docs/libnm/html/NMObject.html
+++ b/docs/libnm/html/NMObject.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMObject
+NMObject: libnm Reference Manual
-
+
@@ -112,8 +112,6 @@
Functions
@@ -141,7 +139,6 @@ nm_object_get_path (Returns
the object's path. This is the internal string used by the
device, and must not be modified.
-
@@ -151,16 +148,12 @@ device, and must not be modified.
NM_OBJECT_PATH
#define NM_OBJECT_PATH "path"
-
-
@@ -168,14 +161,14 @@ device, and must not be modified.
The “dbus-connection” property
“dbus-connection” GDBusConnection *
-
+The GDBusConnection of the object.
+[skip]
Flags: Read / Write / Construct Only
@@ -183,14 +176,13 @@ device, and must not be modified.
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMRemoteConnection.html b/docs/libnm/html/NMRemoteConnection.html
index 0bead3ba..d413162d 100644
--- a/docs/libnm/html/NMRemoteConnection.html
+++ b/docs/libnm/html/NMRemoteConnection.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMRemoteConnection
+NMRemoteConnection: libnm Reference Manual
-
+
@@ -214,8 +214,6 @@
Functions
@@ -267,7 +265,6 @@ disk; if FALSE, then only the in-memory representat
Returns
TRUE on success, FALSE on error, in which case error
will be set.
-
@@ -365,7 +362,6 @@ nm_remote_connection_commit_changes_finish
Returns
TRUE on success, FALSE on error, in which case error
will be set.
-
@@ -408,7 +404,6 @@ been written to disk, or if the connection has never been saved.
Returns
TRUE on success, FALSE on error, in which case error
will be set.
-
@@ -494,7 +489,6 @@ nm_remote_connection_save_finish (Returns
TRUE on success, FALSE on error, in which case error
will be set.
-
@@ -536,7 +530,6 @@ nm_remote_connection_delete (Returns
TRUE on success, FALSE on error, in which case error
will be set.
-
@@ -621,7 +614,6 @@ nm_remote_connection_delete_finish (Returns
TRUE on success, FALSE on error, in which case error
will be set.
-
@@ -671,7 +663,6 @@ not a simple property accessor.
a GVariant of type NM_VARIANT_TYPE_CONNECTION containing
connection
's secrets, or NULL on error.
-
@@ -793,7 +784,6 @@ nm_remote_connection_get_unsaved ( TRUE if the remote connection contains changes that have not
been saved to disk, FALSE if the connection is the same as its on-disk
representation.
-
@@ -828,7 +818,6 @@ reference to it.)
Returns
TRUE if the remote connection is visible to the current
user, FALSE if not.
-
@@ -838,32 +827,24 @@ user, FALSE if not.
NM_REMOTE_CONNECTION_DBUS_CONNECTION
#define NM_REMOTE_CONNECTION_DBUS_CONNECTION "dbus-connection"
-
-
@@ -871,7 +852,8 @@ user, FALSE if not.
The “unsaved” property
“unsaved” gboolean
-
+TRUE if the remote connection contains changes that have not been saved
+to disk, FALSE if the connection is the same as its on-disk representation.
Flags: Read
Default value: FALSE
@@ -879,14 +861,19 @@ user, FALSE if not.
The “visible” property
“visible” gboolean
-
+TRUE if the remote connection is visible to the current user, FALSE if
+not. If the connection is not visible then it is essentially useless; it
+will not contain any settings, and operations such as
+nm_remote_connection_save() and nm_remote_connection_delete() will always
+fail. (NMRemoteSettings will not normally return non-visible connections
+to callers, but it is possible for a connection's visibility to change
+after you already have a reference to it.)
Flags: Read
Default value: FALSE
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMSecretAgentOld.html b/docs/libnm/html/NMSecretAgentOld.html
index 4eb3641b..ab20b0eb 100644
--- a/docs/libnm/html/NMSecretAgentOld.html
+++ b/docs/libnm/html/NMSecretAgentOld.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMSecretAgentOld
+NMSecretAgentOld: libnm Reference Manual
-
+
@@ -216,8 +216,6 @@
Functions
@@ -267,7 +265,7 @@ something like this:
NM_SETTING_WIRELESS_SECURITY_PSK, "my really cool PSK",
NULL);
nm_connection_add_setting (secrets, NM_SETTING (s_wsec));
-secrets_dict = nm_connection_to_dbus (secrets, NM_CONNECTION_SERIALIZE_ALL);
+secrets_dict = nm_connection_to_dbus (secrets, NM_CONNECTION_SERIALIZE_ALL);
(call the NMSecretAgentOldGetSecretsFunc with secrets_dict)
@@ -461,7 +459,6 @@ registered, or in the process of registering.
@@ -549,7 +546,6 @@ nm_secret_agent_old_register_finish (
Returns
TRUE if registration was successful, FALSE on error.
-
@@ -594,7 +590,6 @@ registered.
@@ -682,7 +677,6 @@ nm_secret_agent_old_unregister_finish (
Returns
TRUE if unregistration was successful, FALSE on error.
-
@@ -708,7 +702,6 @@ nm_secret_agent_old_get_registered (
Returns
a TRUE if the agent is registered, FALSE if it is not.
-
@@ -879,32 +872,24 @@ nm_secret_agent_old_delete_secrets (NM_SECRET_AGENT_OLD_IDENTIFIER
#define NM_SECRET_AGENT_OLD_IDENTIFIER "identifier"
-
-
@@ -912,7 +897,20 @@ nm_secret_agent_old_delete_secrets (
The “auto-register” property
“auto-register” gboolean
-
+If TRUE (the default), the agent will always be registered when
+NetworkManager is running; if NetworkManager exits and restarts, the
+agent will re-register itself automatically.
+In particular, if this property is TRUE at construct time, then the
+agent will register itself with NetworkManager during
+construction/initialization, and initialization will fail with an error
+if the agent is unable to register itself.
+If the property is FALSE, the agent will not automatically register with
+NetworkManager, and nm_secret_agent_old_register() or
+nm_secret_agent_old_register_async() must be called to register it.
+Calling nm_secret_agent_old_unregister() will suppress auto-registration
+until nm_secret_agent_old_register() is called, which re-enables
+auto-registration. This ensures that the agent remains un-registered when
+you expect it to be unregistered.
Flags: Read / Write / Construct
Default value: TRUE
@@ -920,14 +918,20 @@ nm_secret_agent_old_delete_secrets (
The “capabilities” property
“capabilities” NMSecretAgentCapabilities
-
+A bitfield of NMSecretAgentCapabilities.
Flags: Read / Write / Construct
The “identifier” property
“identifier” gchar *
-
+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[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).
Flags: Read / Write / Construct Only
Default value: NULL
@@ -935,14 +939,13 @@ nm_secret_agent_old_delete_secrets (
The “registered” property
“registered” gboolean
-
+TRUE if the agent is registered with NetworkManager, FALSE if not.
Flags: Read
Default value: FALSE
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMSetting.html b/docs/libnm/html/NMSetting.html
index 5e5d535b..43757b42 100644
--- a/docs/libnm/html/NMSetting.html
+++ b/docs/libnm/html/NMSetting.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMSetting
+NMSetting: libnm Reference Manual
-
+
@@ -256,24 +256,18 @@ of properties and allowed values.
NM_SETTING_PARAM_REQUIRED
#define NM_SETTING_PARAM_REQUIRED (1 << (1 + G_PARAM_USER_SHIFT))
-
-
NM_SETTING_PARAM_FUZZY_IGNORE
#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT))
-
-
@@ -318,7 +312,6 @@ of properties and allowed values.
@@ -395,7 +388,6 @@ nm_setting_lookup_type (const cha
the GType of the setting's class, or G_TYPE_INVALID if
name
is not recognized.
-
@@ -451,7 +443,6 @@ nm_setting_get_name (Returns
a string containing the type name of the NMSetting object,
like 'ppp' or 'wireless' or 'wired'.
-
@@ -499,7 +490,6 @@ is being verified in isolation.
@@ -542,7 +532,6 @@ for a description of each flag's behavior.
@@ -605,7 +594,6 @@ in and the settings differ, a new one is created and returned.
@@ -674,7 +662,6 @@ output format is not guaranteed to be stable and may change at any time.
an allocated string containing a textual representation of the
setting's properties and values (including secrets!), which the caller should
free with g_free()
-
@@ -723,7 +710,6 @@ handle that secret.
Returns
TRUE on success (if the given secret name was a valid property of
this setting, and if that property is secret), FALSE if not
-
@@ -772,7 +758,6 @@ handle that secret.
Returns
TRUE on success (if the given secret name was a valid property of
this setting, and if that property is secret), FALSE if not
-
@@ -812,7 +797,6 @@ to get the type of
the D-Bus marshalling type of property
on setting
.
-
@@ -822,8 +806,6 @@ on setting
NM_SETTING_NAME
#define NM_SETTING_NAME "name"
-
-
@@ -1064,7 +1046,6 @@ example "ppp" or "wireless" or "wired".
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMSetting8021x.html b/docs/libnm/html/NMSetting8021x.html
index ba6aa73f..f9e3ae1b 100644
--- a/docs/libnm/html/NMSetting8021x.html
+++ b/docs/libnm/html/NMSetting8021x.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMSetting8021x
+NMSetting8021x: libnm Reference Manual
-
+
@@ -767,6 +767,10 @@
+#define
+NM_SETTING_802_1X_CERT_SCHEME_PREFIX_PATH
+
+
enum
NMSetting8021xCKFormat
@@ -950,7 +954,6 @@ nm_setting_802_1x_new (void
Returns
the new empty NMSetting8021x object
-
@@ -981,7 +984,6 @@ allowed EAP methods.
@@ -1018,7 +1020,6 @@ nm_setting_802_1x_get_eap_method (Returns
the name of the allowed EAP method at index i
-
@@ -1056,7 +1057,6 @@ allowed EAP methods.
Returns
TRUE if the EAP method was successfully added, FALSE if it was
not a valid method or if it was already allowed.
-
@@ -1123,7 +1123,6 @@ nm_setting_802_1x_remove_eap_method_by_value
@@ -1173,7 +1172,6 @@ authenticate the user. Often this is a username or login name.
@@ -1204,7 +1202,6 @@ a secure form, if applicable for that EAP method.
@@ -1231,7 +1228,6 @@ nm_setting_802_1x_get_pac_file (
Returns
the PAC file
-
@@ -1263,7 +1259,6 @@ of these properties.
@@ -1294,7 +1289,6 @@ certificates for verifying the network to client.
@@ -1325,7 +1319,6 @@ to add more CA certificates for verifying the network to client.
@@ -1354,7 +1347,6 @@ if
Returns
scheme used to store the CA certificate (blob or path)
-
@@ -1418,7 +1410,6 @@ of the network cannot be confirmed by the client.
@@ -1479,7 +1470,6 @@ clears the CA certificate.
@@ -1508,7 +1498,6 @@ nm_setting_802_1x_get_subject_match (NULL no subject verification is to be
performed.
-
@@ -1537,7 +1526,6 @@ nm_setting_802_1x_get_num_altsubject_matches
@@ -1575,7 +1563,6 @@ nm_setting_802_1x_get_altsubject_match
Returns
the altSubjectName match at index i
-
@@ -1614,7 +1601,6 @@ server is not verified.
Returns
TRUE if the alternative subject name match was
successfully added, FALSE if it was already allowed.
-
@@ -1683,7 +1669,6 @@ nm_setting_802_1x_remove_altsubject_match_by_value
Returns
TRUE if the alternative subject name match was found and removed,
FALSE if it was not.
-
@@ -1736,7 +1721,6 @@ if
Returns
scheme used to store the client certificate (blob or path)
-
@@ -1796,7 +1780,6 @@ authentication method.
@@ -1861,7 +1844,6 @@ clears the client certificate.
@@ -1889,7 +1871,6 @@ nm_setting_802_1x_get_phase1_peapver (“phase1-peapver” property. Valid
values are NULL (unset), "0" (PEAP version 0), and "1" (PEAP version 1).
-
@@ -1920,7 +1901,6 @@ used when authenticating with EAP-PEAP, as contained in the
“phase1-peaplabel” property. Valid values are NULL (unset),
"0" (use old-style label), and "1" (use new-style label). See the
wpa_supplicant documentation for more details.
-
@@ -1949,7 +1929,6 @@ nm_setting_802_1x_get_phase1_fast_provisioning
whether "phase 1" PEAP fast provisioning should be used, as specified
by the “phase1-fast-provisioning” property. See the
wpa_supplicant documentation for more details.
-
@@ -1976,7 +1955,6 @@ nm_setting_802_1x_get_phase2_auth (Returns
the "phase 2" non-EAP (ex MD5) allowed authentication method as
specified by the “phase2-auth” property.
-
@@ -2003,7 +1981,6 @@ nm_setting_802_1x_get_phase2_autheap (Returns
the "phase 2" EAP-based (ex TLS) allowed authentication method as
specified by the “phase2-autheap” property.
-
@@ -2034,7 +2011,6 @@ use
Returns
scheme used to store the "phase 2" CA certificate (blob or path)
-
@@ -2100,7 +2076,6 @@ of the network cannot be confirmed by the client.
@@ -2161,7 +2136,6 @@ clears the "phase2" CA certificate.
@@ -2191,7 +2165,6 @@ nm_setting_802_1x_get_phase2_subject_match
the substring to be matched against the subject of the "phase 2"
authentication server certificate, or NULL no subject verification
is to be performed.
-
@@ -2220,7 +2193,6 @@ nm_setting_802_1x_get_num_phase2_altsubject_matches
@@ -2258,7 +2230,6 @@ nm_setting_802_1x_get_phase2_altsubject_match
Returns
the "phase 2" altSubjectName match at index i
-
@@ -2298,7 +2269,6 @@ connection
Returns
TRUE if the "phase 2" alternative subject name match was
successfully added, FALSE if it was already allowed.
-
@@ -2367,7 +2337,6 @@ nm_setting_802_1x_remove_phase2_altsubject_match_by_value
Returns
TRUE if the alternative subject name match for "phase 2" was found and removed,
FALSE if it was not.
-
@@ -2422,7 +2391,6 @@ returned scheme is
Returns
scheme used to store the "phase 2" client certificate (blob or path)
-
@@ -2482,7 +2450,6 @@ authentication method.
@@ -2548,7 +2515,6 @@ clears the "phase2" client certificate.
@@ -2575,7 +2541,6 @@ nm_setting_802_1x_get_password (Returns
the password used by the authentication method, if any, as specified
by the “password” property
-
@@ -2601,7 +2566,6 @@ nm_setting_802_1x_get_password_flags (
Returns
the NMSettingSecretFlags pertaining to the “password”
-
@@ -2657,7 +2621,6 @@ nm_setting_802_1x_get_password_raw_flags
Returns
the NMSettingSecretFlags pertaining to the
“password-raw”
-
@@ -2684,7 +2647,6 @@ nm_setting_802_1x_get_pin (Returns
the PIN used by the authentication method, if any, as specified
by the “pin” property
-
@@ -2711,7 +2673,6 @@ nm_setting_802_1x_get_pin_flags (Returns
the NMSettingSecretFlags pertaining to the
“pin”
-
@@ -2743,7 +2704,6 @@ nm_setting_802_1x_get_private_key_scheme
@@ -2806,7 +2766,6 @@ authentication method.
@@ -2894,7 +2853,6 @@ an error is returned.
@@ -2923,7 +2881,6 @@ nm_setting_802_1x_get_private_key_password
the private key password used to decrypt the private key if
previously set with nm_setting_802_1x_set_private_key(), or the
“private-key-password” property.
-
@@ -2951,7 +2908,6 @@ nm_setting_802_1x_get_private_key_password_flags
Returns
the NMSettingSecretFlags pertaining to the
“private-key-password”
-
@@ -2979,7 +2935,6 @@ nm_setting_802_1x_get_private_key_format
Returns
the data format of the private key data stored in the
“private-key” property
-
@@ -3011,7 +2966,6 @@ scheme is
Returns
scheme used to store the "phase 2" private key (blob or path)
-
@@ -3074,7 +3028,6 @@ authentication method.
@@ -3164,7 +3117,6 @@ an error is returned.
@@ -3193,7 +3145,6 @@ nm_setting_802_1x_get_phase2_private_key_password
the private key password used to decrypt the private key if
previously set with nm_setting_802_1x_set_phase2_private_key() or the
“phase2-private-key-password” property.
-
@@ -3221,7 +3172,6 @@ nm_setting_802_1x_get_phase2_private_key_password_flags
Returns
the NMSettingSecretFlags pertaining to the
“phase2-private-key-password”
-
@@ -3249,18 +3199,23 @@ nm_setting_802_1x_get_phase2_private_key_format
Returns
the data format of the "phase 2" private key data stored in the
“phase2-private-key” property
-
Types and Values
+NM_SETTING_802_1X_CERT_SCHEME_PREFIX_PATH
+#define NM_SETTING_802_1X_CERT_SCHEME_PREFIX_PATH "file://"
+
+
+
+
enum NMSetting8021xCKFormat
NMSetting8021xCKFormat values indicate the general type of a certificate
or private key
-Members
+Members
@@ -3309,7 +3264,7 @@ and private key
stored in the setting properties, either as a blob of the item's data, or as
a path to a certificate or private key file on the filesystem
-Members
+Members
@@ -3350,264 +3305,198 @@ to a file containing the certificate or key data
NM_SETTING_802_1X_SETTING_NAME
#define NM_SETTING_802_1X_SETTING_NAME "802-1x"
-
-
NM_SETTING_802_1X_ANONYMOUS_IDENTITY
#define NM_SETTING_802_1X_ANONYMOUS_IDENTITY "anonymous-identity"
-
-
NM_SETTING_802_1X_ALTSUBJECT_MATCHES
#define NM_SETTING_802_1X_ALTSUBJECT_MATCHES "altsubject-matches"
-
-
NM_SETTING_802_1X_PHASE1_PEAPLABEL
#define NM_SETTING_802_1X_PHASE1_PEAPLABEL "phase1-peaplabel"
-
-
NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING
#define NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING "phase1-fast-provisioning"
-
-
NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH
#define NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH "phase2-subject-match"
-
-
NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES
#define NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES "phase2-altsubject-matches"
-
-
NM_SETTING_802_1X_PHASE2_CLIENT_CERT
#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert"
-
-
NM_SETTING_802_1X_PASSWORD_RAW_FLAGS
#define NM_SETTING_802_1X_PASSWORD_RAW_FLAGS "password-raw-flags"
-
-
NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD "private-key-password"
-
-
NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS "private-key-password-flags"
-
-
NM_SETTING_802_1X_PHASE2_PRIVATE_KEY
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY "phase2-private-key"
-
-
NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD "phase2-private-key-password"
-
-
NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS "phase2-private-key-password-flags"
-
-
@@ -3615,14 +3504,18 @@ to a file containing the certificate or key data
The “altsubject-matches” property
“altsubject-matches” GStrv
-
+List of strings to be matched against the altSubjectName of the
+certificate presented by the authentication server. If the list is empty,
+no verification of the server certificate's altSubjectName is performed.
Flags: Read / Write
The “anonymous-identity” property
“anonymous-identity” gchar *
-
+Anonymous identity string for EAP authentication methods. Used as the
+unencrypted identity with EAP types that support different tunneled
+identity like EAP-TTLS.
Flags: Read / Write
Default value: NULL
@@ -3630,14 +3523,27 @@ to a file containing the certificate or key data
The “ca-cert” property
“ca-cert” GBytes *
-
+Contains the CA certificate if used by the EAP method specified in the
+“eap” property.
+Certificate data is specified using a "scheme"; two are currently
+supported: blob and path. When using the blob scheme (which is backwards
+compatible with NM 0.7.x) this property should be set to the
+certificate's DER encoded data. When using the path scheme, this property
+should be set to the full UTF-8 encoded path of the certificate, prefixed
+with the string "file://" and ending with a terminating NUL byte. This
+property can be unset even if the EAP method supports CA certificates,
+but this allows man-in-the-middle attacks and is NOT recommended.
+Setting this property directly is discouraged; use the
+nm_setting_802_1x_set_ca_cert() function instead.
Flags: Read / Write
The “ca-path” property
“ca-path” gchar *
-
+UTF-8 encoded path to a directory containing PEM or DER formatted
+certificates to be added to the verification chain in addition to the
+certificate specified in the “ca-cert” property.
Flags: Read / Write
Default value: NULL
@@ -3645,21 +3551,35 @@ to a file containing the certificate or key data
The “client-cert” property
“client-cert” GBytes *
-
+Contains the client certificate if used by the EAP method specified in
+the “eap” property.
+Certificate data is specified using a "scheme"; two are currently
+supported: blob and path. When using the blob scheme (which is backwards
+compatible with NM 0.7.x) this property should be set to the
+certificate's DER encoded data. When using the path scheme, this property
+should be set to the full UTF-8 encoded path of the certificate, prefixed
+with the string "file://" and ending with a terminating NUL byte.
+Setting this property directly is discouraged; use the
+nm_setting_802_1x_set_client_cert() function instead.
Flags: Read / Write
The “eap” property
“eap” GStrv
-
+The allowed EAP method to be used when authenticating to the network with
+802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd",
+and "fast". Each method requires different configuration using the
+properties of this setting; refer to wpa_supplicant documentation for the
+allowed combinations.
Flags: Read / Write
The “identity” property
“identity” gchar *
-
+Identity string for EAP authentication methods. Often the user's user or
+login name.
Flags: Read / Write
Default value: NULL
@@ -3667,7 +3587,7 @@ to a file containing the certificate or key data
The “pac-file” property
“pac-file” gchar *
-
+UTF-8 encoded file path containing PAC for EAP-FAST.
Flags: Read / Write
Default value: NULL
@@ -3675,7 +3595,9 @@ to a file containing the certificate or key data
The “password” property
“password” gchar *
-
+UTF-8 encoded password used for EAP authentication methods. If both the
+“password” property and the “password-raw”
+property are specified, “password” is preferred.
Flags: Read / Write
Default value: NULL
@@ -3683,28 +3605,36 @@ to a file containing the certificate or key data
The “password-flags” property
“password-flags” NMSettingSecretFlags
-
+Flags indicating how to handle the “password” property.
Flags: Read / Write
The “password-raw” property
“password-raw” GBytes *
-
+Password used for EAP authentication methods, given as a byte array to
+allow passwords in other encodings than UTF-8 to be used. If both the
+“password” property and the “password-raw”
+property are specified, “password” is preferred.
Flags: Read / Write
The “password-raw-flags” property
“password-raw-flags” NMSettingSecretFlags
-
+Flags indicating how to handle the “password-raw” property.
Flags: Read / Write
The “phase1-fast-provisioning” property
“phase1-fast-provisioning” gchar *
-
+Enables or disables in-line provisioning of EAP-FAST credentials when
+FAST is specified as the EAP method in the “eap” property.
+Recognized values are "0" (disabled), "1" (allow unauthenticated
+provisioning), "2" (allow authenticated provisioning), and "3" (allow
+both authenticated and unauthenticated provisioning). See the
+wpa_supplicant documentation for more details.
Flags: Read / Write
Default value: NULL
@@ -3712,7 +3642,10 @@ to a file containing the certificate or key data
The “phase1-peaplabel” property
“phase1-peaplabel” gchar *
-
+Forces use of the new PEAP label during key derivation. Some RADIUS
+servers may require forcing the new PEAP label to interoperate with
+PEAPv1. Set to "1" to force use of the new PEAP label. See the
+wpa_supplicant documentation for more details.
Flags: Read / Write
Default value: NULL
@@ -3720,7 +3653,12 @@ to a file containing the certificate or key data
The “phase1-peapver” property
“phase1-peapver” gchar *
-
+Forces which PEAP version is used when PEAP is set as the EAP method in
+the “eap” property. When unset, the version reported by
+the server will be used. Sometimes when using older RADIUS servers, it
+is necessary to force the client to use a particular PEAP version. To do
+so, this property may be set to "0" or "1" to force that specific PEAP
+version.
Flags: Read / Write
Default value: NULL
@@ -3728,14 +3666,22 @@ to a file containing the certificate or key data
The “phase2-altsubject-matches” property
“phase2-altsubject-matches” GStrv
-
+List of strings to be matched against the altSubjectName of the
+certificate presented by the authentication server during the inner
+"phase 2" authentication. If the list is empty, no verification of the
+server certificate's altSubjectName is performed.
Flags: Read / Write
The “phase2-auth” property
“phase2-auth” gchar *
-
+Specifies the allowed "phase 2" inner non-EAP authentication methods when
+an EAP method that uses an inner TLS tunnel is specified in the
+“eap” property. Recognized non-EAP "phase 2" methods are
+"pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls".
+Each "phase 2" inner method requires specific parameters for successful
+authentication; see the wpa_supplicant documentation for more details.
Flags: Read / Write
Default value: NULL
@@ -3743,7 +3689,12 @@ to a file containing the certificate or key data
The “phase2-autheap” property
“phase2-autheap” gchar *
-
+Specifies the allowed "phase 2" inner EAP-based authentication methods
+when an EAP method that uses an inner TLS tunnel is specified in the
+“eap” property. Recognized EAP-based "phase 2" methods are
+"md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method
+requires specific parameters for successful authentication; see the
+wpa_supplicant documentation for more details.
Flags: Read / Write
Default value: NULL
@@ -3751,14 +3702,28 @@ to a file containing the certificate or key data
The “phase2-ca-cert” property
“phase2-ca-cert” GBytes *
-
+Contains the "phase 2" CA certificate if used by the EAP method specified
+in the “phase2-auth” or “phase2-autheap”
+properties.
+Certificate data is specified using a "scheme"; two are currently
+supported: blob and path. When using the blob scheme (which is backwards
+compatible with NM 0.7.x) this property should be set to the
+certificate's DER encoded data. When using the path scheme, this property
+should be set to the full UTF-8 encoded path of the certificate, prefixed
+with the string "file://" and ending with a terminating NUL byte. This
+property can be unset even if the EAP method supports CA certificates,
+but this allows man-in-the-middle attacks and is NOT recommended.
+Setting this property directly is discouraged; use the
+nm_setting_802_1x_set_phase2_ca_cert() function instead.
Flags: Read / Write
The “phase2-ca-path” property
“phase2-ca-path” gchar *
-
+UTF-8 encoded path to a directory containing PEM or DER formatted
+certificates to be added to the verification chain in addition to the
+certificate specified in the “phase2-ca-cert” property.
Flags: Read / Write
Default value: NULL
@@ -3766,21 +3731,58 @@ to a file containing the certificate or key data
The “phase2-client-cert” property
“phase2-client-cert” GBytes *
-
+Contains the "phase 2" client certificate if used by the EAP method
+specified in the “phase2-auth” or
+“phase2-autheap” properties.
+Certificate data is specified using a "scheme"; two are currently
+supported: blob and path. When using the blob scheme (which is backwards
+compatible with NM 0.7.x) this property should be set to the
+certificate's DER encoded data. When using the path scheme, this property
+should be set to the full UTF-8 encoded path of the certificate, prefixed
+with the string "file://" and ending with a terminating NUL byte. This
+property can be unset even if the EAP method supports CA certificates,
+but this allows man-in-the-middle attacks and is NOT recommended.
+Setting this property directly is discouraged; use the
+nm_setting_802_1x_set_phase2_client_cert() function instead.
Flags: Read / Write
The “phase2-private-key” property
“phase2-private-key” GBytes *
-
+Contains the "phase 2" inner private key when the
+“phase2-auth” or “phase2-autheap” property is
+set to "tls".
+Key data is specified using a "scheme"; two are currently supported: blob
+and path. When using the blob scheme and private keys, this property
+should be set to the key's encrypted PEM encoded data. When using private
+keys with the path scheme, this property should be set to the full UTF-8
+encoded path of the key, prefixed with the string "file://" and ending
+with a terminating NUL byte. When using PKCS#12 format private
+keys and the blob scheme, this property should be set to the
+PKCS#12 data and the “phase2-private-key-password”
+property must be set to password used to decrypt the PKCS#12
+certificate and key. When using PKCS#12 files and the path
+scheme, this property should be set to the full UTF-8 encoded path of the
+key, prefixed with the string "file://" and and ending with a terminating
+NUL byte, and as with the blob scheme the
+“phase2-private-key-password” property must be set to the
+password used to decode the PKCS#12 private key and certificate.
+Setting this property directly is discouraged; use the
+nm_setting_802_1x_set_phase2_private_key() function instead.
Flags: Read / Write
The “phase2-private-key-password” property
“phase2-private-key-password” gchar *
-
+The password used to decrypt the "phase 2" private key specified in the
+“phase2-private-key” property when the private key either
+uses the path scheme, or is a PKCS#12 format key. Setting this
+property directly is not generally necessary except when returning
+secrets to NetworkManager; it is generally set automatically when setting
+the private key by the nm_setting_802_1x_set_phase2_private_key()
+function.
Flags: Read / Write
Default value: NULL
@@ -3788,14 +3790,18 @@ to a file containing the certificate or key data
The “phase2-private-key-password-flags” property
“phase2-private-key-password-flags” NMSettingSecretFlags
-
+Flags indicating how to handle the
+“phase2-private-key-password” property.
Flags: Read / Write
The “phase2-subject-match” property
“phase2-subject-match” gchar *
-
+Substring to be matched against the subject of the certificate presented
+by the authentication server during the inner "phase 2"
+authentication. When unset, no verification of the authentication server
+certificate's subject is performed.
Flags: Read / Write
Default value: NULL
@@ -3803,7 +3809,7 @@ to a file containing the certificate or key data
The “pin” property
“pin” gchar *
-
+PIN used for EAP authentication methods.
Flags: Read / Write
Default value: NULL
@@ -3811,21 +3817,49 @@ to a file containing the certificate or key data
The “pin-flags” property
“pin-flags” NMSettingSecretFlags
-
+Flags indicating how to handle the “pin” property.
Flags: Read / Write
The “private-key” property
“private-key” GBytes *
-
+Contains the private key when the “eap” property is set to
+"tls".
+Key data is specified using a "scheme"; two are currently supported: blob
+and path. When using the blob scheme and private keys, this property
+should be set to the key's encrypted PEM encoded data. When using private
+keys with the path scheme, this property should be set to the full UTF-8
+encoded path of the key, prefixed with the string "file://" and ending
+with a terminating NUL byte. When using PKCS#12 format private
+keys and the blob scheme, this property should be set to the
+PKCS#12 data and the “private-key-password”
+property must be set to password used to decrypt the PKCS#12
+certificate and key. When using PKCS#12 files and the path
+scheme, this property should be set to the full UTF-8 encoded path of the
+key, prefixed with the string "file://" and and ending with a terminating
+NUL byte, and as with the blob scheme the "private-key-password" property
+must be set to the password used to decode the PKCS#12 private
+key and certificate.
+Setting this property directly is discouraged; use the
+nm_setting_802_1x_set_private_key() function instead.
+WARNING: “private-key” is not a "secret" property, and thus
+unencrypted private key data using the BLOB scheme may be readable by
+unprivileged users. Private keys should always be encrypted with a
+private key password to prevent unauthorized access to unencrypted
+private key data.
Flags: Read / Write
The “private-key-password” property
“private-key-password” gchar *
-
+The password used to decrypt the private key specified in the
+“private-key” property when the private key either uses the
+path scheme, or if the private key is a PKCS#12 format key. Setting this
+property directly is not generally necessary except when returning
+secrets to NetworkManager; it is generally set automatically when setting
+the private key by the nm_setting_802_1x_set_private_key() function.
Flags: Read / Write
Default value: NULL
@@ -3833,14 +3867,17 @@ to a file containing the certificate or key data
The “private-key-password-flags” property
“private-key-password-flags” NMSettingSecretFlags
-
+Flags indicating how to handle the “private-key-password”
+property.
Flags: Read / Write
The “subject-match” property
“subject-match” gchar *
-
+Substring to be matched against the subject of the certificate presented
+by the authentication server. When unset, no verification of the
+authentication server certificate's subject is performed.
Flags: Read / Write
Default value: NULL
@@ -3848,14 +3885,21 @@ to a file containing the certificate or key data
The “system-ca-certs” property
“system-ca-certs” gboolean
-
+When TRUE, overrides the “ca-path” and
+“phase2-ca-path” properties using the system CA directory
+specified at configure time with the --system-ca-path switch. The
+certificates in this directory are added to the verification chain in
+addition to any certificates specified by the “ca-cert” and
+“phase2-ca-cert” properties. If the path provided with
+--system-ca-path is rather a file name (bundle of trusted CA certificates),
+it overrides “ca-cert” and “phase2-ca-cert”
+properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).
Flags: Read / Write / Construct
Default value: FALSE
+
Generated by GTK-Doc V1.24
\ No newline at end of file
diff --git a/docs/libnm/html/NMSettingAdsl.html b/docs/libnm/html/NMSettingAdsl.html
index f96005af..3b890722 100644
--- a/docs/libnm/html/NMSettingAdsl.html
+++ b/docs/libnm/html/NMSettingAdsl.html
@@ -2,13 +2,13 @@
-libnm Reference Manual: NMSettingAdsl
+NMSettingAdsl: libnm Reference Manual
-
+
@@ -240,7 +240,6 @@ nm_setting_adsl_new (void<
@@ -266,7 +265,6 @@ nm_setting_adsl_get_username (
Returns
the “username” property of the setting
-
@@ -292,7 +290,6 @@ nm_setting_adsl_get_password (
Returns
the “password” property of the setting
-
@@ -318,7 +315,6 @@ nm_setting_adsl_get_protocol (
Returns
the “protocol” property of the setting
-
@@ -344,7 +340,6 @@ nm_setting_adsl_get_encapsulation (
Returns
the “encapsulation” property of the setting
-
@@ -370,7 +365,6 @@ nm_setting_adsl_get_vpi (
Returns
the “vpi” property of the setting
-
@@ -396,7 +390,6 @@ nm_setting_adsl_get_vci (
Returns
the “vci” property of the setting
-
@@ -422,7 +415,6 @@ nm_setting_adsl_get_password_flags (
Returns
the NMSettingSecretFlags pertaining to the “password”
-
@@ -432,104 +424,78 @@ nm_setting_adsl_get_password_flags (NM_SETTING_ADSL_SETTING_NAME
#define NM_SETTING_ADSL_SETTING_NAME "adsl"
-
-
@@ -537,7 +503,7 @@ nm_setting_adsl_get_password_flags (
The “encapsulation” property
“encapsulation” gchar *
-
+Encapsulation of ADSL connection. Can be "vcmux" or "llc".
Flags: Read / Write
Default value: NULL
@@ -545,7 +511,7 @@ nm_setting_adsl_get_password_flags (
The “password” property
“password” gchar *
-
+Password used to authenticate with the ADSL service.
Flags: Read / Write
Default value: NULL
@@ -553,14 +519,14 @@ nm_setting_adsl_get_password_flags (
The