Imported Upstream version 1.0.4 upstream/1.0.4

author: Michael Biebl <biebl@debian.org> 2015-07-14 19:38:58 +0200
committer: Michael Biebl <biebl@debian.org> 2015-07-14 19:38:58 +0200
commit: 50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 (patch)
tree: 6790165f39daee79e2b6c6617483320613493367 /docs/libnm/html/NMSettingWireless.html
parent: f408e27bccfacf347605a8d98649975a68f38a17 (diff)
1 files changed, 48 insertions, 64 deletions
diff --git a/docs/libnm/html/NMSettingWireless.html b/docs/libnm/html/NMSettingWireless.html
index 1c59261b..f4cd0050 100644
--- a/docs/libnm/html/NMSettingWireless.html
+++ b/docs/libnm/html/NMSettingWireless.html
@@ -2,13 +2,13 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>libnm Reference Manual: NMSettingWireless</title>
+<title>NMSettingWireless: libnm Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="libnm Reference Manual">
 <link rel="up" href="ch03.html" title="Connection and Setting API Reference">
 <link rel="prev" href="NMSettingWired.html" title="NMSettingWired">
 <link rel="next" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity">
-<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -456,7 +456,6 @@ nm_setting_wireless_get_mode (<em class="parameter"><code><a class="link" href="
 <div class="refsect3">
 <a name="id-1.4.30.8.4.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mode" title="The “mode” property"><span class="type">“mode”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -482,7 +481,6 @@ nm_setting_wireless_get_band (<em class="parameter"><code><a class="link" href="
 <div class="refsect3">
 <a name="id-1.4.30.8.5.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--band" title="The “band” property"><span class="type">“band”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -508,7 +506,6 @@ nm_setting_wireless_get_channel (<em class="parameter"><code><a class="link" hre
 <div class="refsect3">
 <a name="id-1.4.30.8.6.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--channel" title="The “channel” property"><span class="type">“channel”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -534,7 +531,6 @@ nm_setting_wireless_get_bssid (<em class="parameter"><code><a class="link" href=
 <div class="refsect3">
 <a name="id-1.4.30.8.7.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--bssid" title="The “bssid” property"><span class="type">“bssid”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -560,7 +556,6 @@ nm_setting_wireless_get_rate (<em class="parameter"><code><a class="link" href="
 <div class="refsect3">
 <a name="id-1.4.30.8.8.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--rate" title="The “rate” property"><span class="type">“rate”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -586,7 +581,6 @@ nm_setting_wireless_get_tx_power (<em class="parameter"><code><a class="link" hr
 <div class="refsect3">
 <a name="id-1.4.30.8.9.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--tx-power" title="The “tx-power” property"><span class="type">“tx-power”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -612,7 +606,6 @@ nm_setting_wireless_get_mac_address (<em class="parameter"><code><a class="link"
 <div class="refsect3">
 <a name="id-1.4.30.8.10.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address" title="The “mac-address” property"><span class="type">“mac-address”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -639,7 +632,6 @@ nm_setting_wireless_get_cloned_mac_address
 <div class="refsect3">
 <a name="id-1.4.30.8.11.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--cloned-mac-address" title="The “cloned-mac-address” property"><span class="type">“cloned-mac-address”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -666,7 +658,6 @@ nm_setting_wireless_get_mac_address_blacklist
 <div class="refsect3">
 <a name="id-1.4.30.8.12.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address-blacklist" title="The “mac-address-blacklist” property"><span class="type">“mac-address-blacklist”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -693,7 +684,6 @@ nm_setting_wireless_get_num_mac_blacklist_items
 <div class="refsect3">
 <a name="id-1.4.30.8.13.5"></a><h4>Returns</h4>
 <p> the number of blacklisted MAC addresses</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -730,7 +720,6 @@ nm_setting_wireless_get_mac_blacklist_item
 <p> the blacklisted MAC address string (hex-digits-and-colons notation)
 at index <em class="parameter"><code>idx</code></em>
 </p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -767,7 +756,6 @@ nm_setting_wireless_add_mac_blacklist_item
 <a name="id-1.4.30.8.15.6"></a><h4>Returns</h4>
 <p> <code class="literal">TRUE</code> if the MAC address was added; <code class="literal">FALSE</code> if the MAC address
 is invalid or was already present</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -837,7 +825,6 @@ the blacklist</p></td>
 <div class="refsect3">
 <a name="id-1.4.30.8.17.6"></a><h4>Returns</h4>
 <p> <code class="literal">TRUE</code> if the MAC address was found and removed; <code class="literal">FALSE</code> if it was not.</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -886,7 +873,6 @@ nm_setting_wireless_get_mtu (<em class="parameter"><code><a class="link" href="N
 <div class="refsect3">
 <a name="id-1.4.30.8.19.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mtu" title="The “mtu” property"><span class="type">“mtu”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -912,7 +898,6 @@ nm_setting_wireless_get_hidden (<em class="parameter"><code><a class="link" href
 <div class="refsect3">
 <a name="id-1.4.30.8.20.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--hidden" title="The “hidden” property"><span class="type">“hidden”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -951,7 +936,6 @@ not be preserved.</p>
 <a name="id-1.4.30.8.21.6"></a><h4>Returns</h4>
 <p> <code class="literal">TRUE</code> if <em class="parameter"><code>bssid</code></em>
 was already known, <code class="literal">FALSE</code> if not</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -978,7 +962,6 @@ nm_setting_wireless_get_num_seen_bssids
 <div class="refsect3">
 <a name="id-1.4.30.8.22.5"></a><h4>Returns</h4>
 <p> the number of BSSIDs in the previously seen BSSID list</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -1013,7 +996,6 @@ nm_setting_wireless_get_seen_bssid (<em class="parameter"><code><a class="link"
 <a name="id-1.4.30.8.23.5"></a><h4>Returns</h4>
 <p> the BSSID at index <em class="parameter"><code>i</code></em>
 </p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -1081,7 +1063,6 @@ capabilities</p></td>
 <a name="id-1.4.30.8.24.6"></a><h4>Returns</h4>
 <p> <code class="literal">TRUE</code> if the given settings are compatible with the access point's
 security flags and mode, <code class="literal">FALSE</code> if they are not.</p>
-<p></p>
 </div>
 </div>
 </div>
@@ -1091,112 +1072,84 @@ security flags and mode, <code class="literal">FALSE</code> if they are not.</p>
 <a name="NM-SETTING-WIRELESS-SETTING-NAME:CAPS"></a><h3>NM_SETTING_WIRELESS_SETTING_NAME</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-SSID:CAPS"></a><h3>NM_SETTING_WIRELESS_SSID</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_SSID        "ssid"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-MODE:CAPS"></a><h3>NM_SETTING_WIRELESS_MODE</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_MODE        "mode"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-BAND:CAPS"></a><h3>NM_SETTING_WIRELESS_BAND</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_BAND        "band"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-CHANNEL:CAPS"></a><h3>NM_SETTING_WIRELESS_CHANNEL</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_CHANNEL     "channel"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-BSSID:CAPS"></a><h3>NM_SETTING_WIRELESS_BSSID</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_BSSID       "bssid"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-RATE:CAPS"></a><h3>NM_SETTING_WIRELESS_RATE</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_RATE        "rate"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-TX-POWER:CAPS"></a><h3>NM_SETTING_WIRELESS_TX_POWER</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_TX_POWER    "tx-power"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-MAC-ADDRESS:CAPS"></a><h3>NM_SETTING_WIRELESS_MAC_ADDRESS</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_MAC_ADDRESS "mac-address"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-CLONED-MAC-ADDRESS:CAPS"></a><h3>NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS "cloned-mac-address"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-MAC-ADDRESS-BLACKLIST:CAPS"></a><h3>NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-MTU:CAPS"></a><h3>NM_SETTING_WIRELESS_MTU</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_MTU         "mtu"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-SEEN-BSSIDS:CAPS"></a><h3>NM_SETTING_WIRELESS_SEEN_BSSIDS</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-WIRELESS-HIDDEN:CAPS"></a><h3>NM_SETTING_WIRELESS_HIDDEN</h3>
 <pre class="programlisting">#define NM_SETTING_WIRELESS_HIDDEN      "hidden"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
@@ -1227,7 +1180,12 @@ for this connection.</p>
 <div class="refsect2">
 <a name="NMSettingWireless--band"></a><h3>The <code class="literal">“band”</code> property</h3>
 <pre class="programlisting">  “band”                     <span class="type">gchar</span> *</pre>
-<p></p>
+<p>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.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
 </div>
@@ -1235,7 +1193,10 @@ for this connection.</p>
 <div class="refsect2">
 <a name="NMSettingWireless--bssid"></a><h3>The <code class="literal">“bssid”</code> property</h3>
 <pre class="programlisting">  “bssid”                    <span class="type">gchar</span> *</pre>
-<p></p>
+<p>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.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
 </div>
@@ -1243,7 +1204,10 @@ for this connection.</p>
 <div class="refsect2">
 <a name="NMSettingWireless--channel"></a><h3>The <code class="literal">“channel”</code> property</h3>
 <pre class="programlisting">  “channel”                  <span class="type">guint</span></pre>
-<p></p>
+<p>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.</p>
 <p>Flags: Read / Write / Construct</p>
 <p>Default value: 0</p>
 </div>
@@ -1251,7 +1215,8 @@ for this connection.</p>
 <div class="refsect2">
 <a name="NMSettingWireless--cloned-mac-address"></a><h3>The <code class="literal">“cloned-mac-address”</code> property</h3>
 <pre class="programlisting">  “cloned-mac-address”       <span class="type">gchar</span> *</pre>
-<p></p>
+<p>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.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
 </div>
@@ -1259,7 +1224,11 @@ for this connection.</p>
 <div class="refsect2">
 <a name="NMSettingWireless--hidden"></a><h3>The <code class="literal">“hidden”</code> property</h3>
 <pre class="programlisting">  “hidden”                   <span class="type">gboolean</span></pre>
-<p></p>
+<p>If <code class="literal">TRUE</code>, 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.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: FALSE</p>
 </div>
@@ -1267,7 +1236,9 @@ for this connection.</p>
 <div class="refsect2">
 <a name="NMSettingWireless--mac-address"></a><h3>The <code class="literal">“mac-address”</code> property</h3>
 <pre class="programlisting">  “mac-address”              <span class="type">gchar</span> *</pre>
-<p></p>
+<p>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).</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
 </div>
@@ -1275,14 +1246,17 @@ for this connection.</p>
 <div class="refsect2">
 <a name="NMSettingWireless--mac-address-blacklist"></a><h3>The <code class="literal">“mac-address-blacklist”</code> property</h3>
 <pre class="programlisting">  “mac-address-blacklist”    <span class="type">GStrv</span></pre>
-<p></p>
+<p>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").</p>
 <p>Flags: Read / Write</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NMSettingWireless--mode"></a><h3>The <code class="literal">“mode”</code> property</h3>
 <pre class="programlisting">  “mode”                     <span class="type">gchar</span> *</pre>
-<p></p>
+<p>Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap".  If blank,
+infrastructure is assumed.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
 </div>
@@ -1290,7 +1264,8 @@ for this connection.</p>
 <div class="refsect2">
 <a name="NMSettingWireless--mtu"></a><h3>The <code class="literal">“mtu”</code> property</h3>
 <pre class="programlisting">  “mtu”                      <span class="type">guint</span></pre>
-<p></p>
+<p>If non-zero, only transmit packets of the specified size or smaller,
+breaking larger packets up into multiple Ethernet frames.</p>
 <p>Flags: Read / Write / Construct</p>
 <p>Default value: 0</p>
 </div>
@@ -1298,7 +1273,10 @@ for this connection.</p>
 <div class="refsect2">
 <a name="NMSettingWireless--rate"></a><h3>The <code class="literal">“rate”</code> property</h3>
 <pre class="programlisting">  “rate”                     <span class="type">guint</span></pre>
-<p></p>
+<p>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.</p>
 <p>Flags: Read / Write / Construct</p>
 <p>Default value: 0</p>
 </div>
@@ -1306,28 +1284,34 @@ for this connection.</p>
 <div class="refsect2">
 <a name="NMSettingWireless--seen-bssids"></a><h3>The <code class="literal">“seen-bssids”</code> property</h3>
 <pre class="programlisting">  “seen-bssids”              <span class="type">GStrv</span></pre>
-<p></p>
+<p>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.</p>
 <p>Flags: Read / Write</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NMSettingWireless--ssid"></a><h3>The <code class="literal">“ssid”</code> property</h3>
 <pre class="programlisting">  “ssid”                     <span class="type">GBytes</span> *</pre>
-<p></p>
+<p>SSID of the Wi-Fi network. Must be specified.</p>
 <p>Flags: Read / Write</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NMSettingWireless--tx-power"></a><h3>The <code class="literal">“tx-power”</code> property</h3>
 <pre class="programlisting">  “tx-power”                 <span class="type">guint</span></pre>
-<p></p>
+<p>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.</p>
 <p>Flags: Read / Write / Construct</p>
 <p>Default value: 0</p>
 </div>
 </div>
 </div>
 <div class="footer">
-<hr>
-          Generated by GTK-Doc V1.21</div>
+<hr>Generated by GTK-Doc V1.24</div>
 </body>
 </html>
\ No newline at end of file
author	Michael Biebl <biebl@debian.org>	2015-07-14 19:38:58 +0200
committer	Michael Biebl <biebl@debian.org>	2015-07-14 19:38:58 +0200
commit	50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 (patch)
tree	6790165f39daee79e2b6c6617483320613493367 /docs/libnm/html/NMSettingWireless.html
parent	f408e27bccfacf347605a8d98649975a68f38a17 (diff)