From 50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 14 Jul 2015 19:38:58 +0200 Subject: Imported Upstream version 1.0.4 --- docs/libnm-util/html/NMSettingWireless.html | 137 ++++++++++++---------------- 1 file changed, 59 insertions(+), 78 deletions(-) (limited to 'docs/libnm-util/html/NMSettingWireless.html') diff --git a/docs/libnm-util/html/NMSettingWireless.html b/docs/libnm-util/html/NMSettingWireless.html index f668698a..4642d621 100644 --- a/docs/libnm-util/html/NMSettingWireless.html +++ b/docs/libnm-util/html/NMSettingWireless.html @@ -2,13 +2,13 @@ -libnm-util Reference Manual: NMSettingWireless +NMSettingWireless: libnm-util Reference Manual - + @@ -445,7 +445,6 @@ nm_setting_wireless_error_quark (

Returns

the error quark used for NMSettingWireless errors.

-

@@ -483,7 +482,6 @@ nm_setting_wireless_get_ssid (

Returns

the “ssid” property of the setting

-

@@ -509,7 +507,6 @@ nm_setting_wireless_get_mode (

Returns

the “mode” property of the setting

-

@@ -535,7 +532,6 @@ nm_setting_wireless_get_band (

Returns

the “band” property of the setting

-

@@ -561,7 +557,6 @@ nm_setting_wireless_get_channel (

Returns

the “channel” property of the setting

-

@@ -587,7 +582,6 @@ nm_setting_wireless_get_bssid (

Returns

the “bssid” property of the setting

-

@@ -613,7 +607,6 @@ nm_setting_wireless_get_rate (

Returns

the “rate” property of the setting

-

@@ -639,7 +632,6 @@ nm_setting_wireless_get_tx_power (

Returns

the “tx-power” property of the setting

-

@@ -665,7 +657,6 @@ nm_setting_wireless_get_mac_address (

Returns

the “mac-address” property of the setting

-

@@ -692,7 +683,6 @@ nm_setting_wireless_get_cloned_mac_address

Returns

the “cloned-mac-address” property of the setting

-

@@ -747,9 +737,8 @@ nm_setting_wireless_get_num_mac_blacklist_items

Returns

the number of blacklisted MAC addresses

-

-

Since 0.9.10

+

Since: 0.9.10

@@ -785,9 +774,8 @@ nm_setting_wireless_get_mac_blacklist_item

the blacklisted MAC address string (hex-digits-and-colons notation) at index idx

-

-

Since 0.9.10

+

Since: 0.9.10

@@ -823,9 +811,8 @@ nm_setting_wireless_add_mac_blacklist_item

Returns

TRUE if the MAC address was added; FALSE if the MAC address is invalid or was already present

-

-

Since 0.9.10

+

Since: 0.9.10

@@ -858,7 +845,7 @@ nm_setting_wireless_remove_mac_blacklist_item
-

Since 0.9.10

+

Since: 0.9.10

@@ -895,9 +882,8 @@ the blacklist

Returns

TRUE if the MAC address was found and removed; FALSE if it was not.

-

-

Since 0.9.10

+

Since: 0.9.10

@@ -921,7 +907,7 @@ nm_setting_wireless_clear_mac_blacklist_items
-

Since 0.9.10

+

Since: 0.9.10

@@ -946,7 +932,6 @@ nm_setting_wireless_get_mtu (

Returns

the “mtu” property of the setting

-

@@ -972,7 +957,6 @@ nm_setting_wireless_get_hidden (

Returns

the “hidden” property of the setting

-

@@ -1011,7 +995,6 @@ not be preserved.

Returns

TRUE if bssid was already known, FALSE if not

-

@@ -1038,7 +1021,6 @@ nm_setting_wireless_get_num_seen_bssids

Returns

the number of BSSIDs in the previously seen BSSID list

-

@@ -1073,7 +1055,6 @@ nm_setting_wireless_get_seen_bssid (

Returns

the BSSID at index i

-

@@ -1141,7 +1122,6 @@ capabilities

Returns

TRUE if the given settings are compatible with the access point's security flags and mode, FALSE if they are not.

-

@@ -1172,7 +1152,6 @@ the presence of NM_SETTING_WIRELESS_SECURITY_SETTING_NAME in the connection.

Returns

the “security” property of the setting

-

@@ -1182,8 +1161,6 @@ the presence of NM_SETTING_WIRELESS_SECURITY_SETTING_NAME in the connection.

NM_SETTING_WIRELESS_SETTING_NAME

#define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
-

-

@@ -1244,120 +1221,90 @@ set to a value that requires the

NM_SETTING_WIRELESS_ERROR

#define NM_SETTING_WIRELESS_ERROR nm_setting_wireless_error_quark ()
-

-

NM_SETTING_WIRELESS_SSID

#define NM_SETTING_WIRELESS_SSID        "ssid"
-

-

NM_SETTING_WIRELESS_MODE

#define NM_SETTING_WIRELESS_MODE        "mode"
-

-

NM_SETTING_WIRELESS_BAND

#define NM_SETTING_WIRELESS_BAND        "band"
-

-

NM_SETTING_WIRELESS_CHANNEL

#define NM_SETTING_WIRELESS_CHANNEL     "channel"
-

-

NM_SETTING_WIRELESS_BSSID

#define NM_SETTING_WIRELESS_BSSID       "bssid"
-

-

NM_SETTING_WIRELESS_RATE

#define NM_SETTING_WIRELESS_RATE        "rate"
-

-

NM_SETTING_WIRELESS_TX_POWER

#define NM_SETTING_WIRELESS_TX_POWER    "tx-power"
-

-

NM_SETTING_WIRELESS_MAC_ADDRESS

#define NM_SETTING_WIRELESS_MAC_ADDRESS "mac-address"
-

-

NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS

#define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS "cloned-mac-address"
-

-

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
-

-

NM_SETTING_WIRELESS_MTU

#define NM_SETTING_WIRELESS_MTU         "mtu"
-

-

NM_SETTING_WIRELESS_SEEN_BSSIDS

#define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
-

-

NM_SETTING_WIRELESS_HIDDEN

#define NM_SETTING_WIRELESS_HIDDEN      "hidden"
-

-

NM_SETTING_WIRELESS_SEC

#define NM_SETTING_WIRELESS_SEC         "security"
-

-

@@ -1373,7 +1320,7 @@ set to a value that requires the Since 0.9.8

+

Since: 0.9.8

@@ -1389,7 +1336,12 @@ for this connection.

The “band” property

  “band”                     gchar *
-

+

802.11 frequency band of the network. One of "a" for 5GHz 802.11a or +"bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network +to the specific band, i.e. if "a" is specified, the device will not +associate with the same network in the 2.4GHz band even if the network's +settings are compatible. This setting depends on specific driver +capability and may not work with all drivers.

Flags: Read / Write

Default value: NULL

@@ -1397,14 +1349,20 @@ for this connection.

The “bssid” property

  “bssid”                    GArray_guchar_ *
-

+

If specified, directs the device to only associate with the given access +point. This capability is highly driver dependent and not supported by +all devices. Note: this property does not control the BSSID used when +creating an Ad-Hoc network and is unlikely to in the future.

Flags: Read / Write

The “channel” property

  “channel”                  guint
-

+

Wireless channel to use for the Wi-Fi connection. The device will only +join (or create for Ad-Hoc networks) a Wi-Fi network on the specified +channel. Because channel numbers overlap between bands, this property +also requires the "band" property to be set.

Flags: Read / Write / Construct

Default value: 0

@@ -1412,14 +1370,19 @@ for this connection.

The “cloned-mac-address” property

  “cloned-mac-address”       GArray_guchar_ *
-

+

If specified, request that the Wi-Fi device use this MAC address instead +of its permanent MAC address. This is known as MAC cloning or spoofing.

Flags: Read / Write

The “hidden” property

  “hidden”                   gboolean
-

+

If TRUE, indicates this network is a non-broadcasting network that hides +its SSID. In this case various workarounds may take place, such as +probe-scanning the SSID for more reliable network discovery. However, +these workarounds expose inherent insecurities with hidden SSID networks, +and thus hidden SSID networks should be used with caution.

Flags: Read / Write

Default value: FALSE

@@ -1427,21 +1390,26 @@ for this connection.

The “mac-address” property

  “mac-address”              GArray_guchar_ *
-

+

If specified, this connection will only apply to the Wi-Fi device whose +permanent MAC address matches. This property does not change the MAC +address of the device (i.e. MAC spoofing).

Flags: Read / Write

The “mac-address-blacklist” property

  “mac-address-blacklist”    GSList_gchararray_ *
-

+

A list of permanent MAC addresses of Wi-Fi devices to which this +connection should never apply. Each MAC address should be given in the +standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").

Flags: Read / Write

The “mode” property

  “mode”                     gchar *
-

+

Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, +infrastructure is assumed.

Flags: Read / Write

Default value: NULL

@@ -1449,7 +1417,8 @@ for this connection.

The “mtu” property

  “mtu”                      guint
-

+

If non-zero, only transmit packets of the specified size or smaller, +breaking larger packets up into multiple Ethernet frames.

Flags: Read / Write / Construct

Default value: 0

@@ -1457,7 +1426,10 @@ for this connection.

The “rate” property

  “rate”                     guint
-

+

If non-zero, directs the device to only use the specified bitrate for +communication with the access point. Units are in Kb/s, ie 5500 = 5.5 +Mbit/s. This property is highly driver dependent and not all devices +support setting a static bitrate.

Flags: Read / Write / Construct

Default value: 0

@@ -1465,7 +1437,10 @@ for this connection.

The “security” property

  “security”                 gchar *
-

+

If the wireless connection has any security restrictions, like 802.1x, +WEP, or WPA, set this property to +NM_SETTING_WIRELESS_SECURITY_SETTING_NAME and ensure the connection +contains a valid NMSettingWirelessSecurity setting.

NMSettingWireless:security has been deprecated since version 0.9.10 and should not be used in newly-written code.

No longer used. Security restrictions are recognized @@ -1479,28 +1454,34 @@ connection.

The “seen-bssids” property

  “seen-bssids”              GSList_gchararray_ *
-

+

A list of BSSIDs (each BSSID formatted as a MAC address like +"00:11:22:33:44:55") that have been detected as part of the Wi-Fi +network. NetworkManager internally tracks previously seen BSSIDs. The +property is only meant for reading and reflects the BSSID list of +NetworkManager. The changes you make to this property will not be +preserved.

Flags: Read / Write

The “ssid” property

  “ssid”                     GArray_guchar_ *
-

+

SSID of the Wi-Fi network. Must be specified.

Flags: Read / Write

The “tx-power” property

  “tx-power”                 guint
-

+

If non-zero, directs the device to use the specified transmit power. +Units are dBm. This property is highly driver dependent and not all +devices support setting a static transmit power.

Flags: Read / Write / Construct

Default value: 0

-
- Generated by GTK-Doc V1.21
+
Generated by GTK-Doc V1.24
\ No newline at end of file -- cgit 1.3.0-6-gf8a5