about summary refs log tree commit diff
path: root/docs/libnm/html/NMSettingInfiniband.html
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2015-07-14 19:38:58 +0200
committerMichael Biebl <biebl@debian.org>2015-07-14 19:38:58 +0200
commit50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 (patch)
tree6790165f39daee79e2b6c6617483320613493367 /docs/libnm/html/NMSettingInfiniband.html
parentf408e27bccfacf347605a8d98649975a68f38a17 (diff)
Imported Upstream version 1.0.4 upstream/1.0.4
Diffstat (limited to 'docs/libnm/html/NMSettingInfiniband.html')
-rw-r--r--docs/libnm/html/NMSettingInfiniband.html45
1 files changed, 18 insertions, 27 deletions
diff --git a/docs/libnm/html/NMSettingInfiniband.html b/docs/libnm/html/NMSettingInfiniband.html
index d68c9929..4ab10c02 100644
--- a/docs/libnm/html/NMSettingInfiniband.html
+++ b/docs/libnm/html/NMSettingInfiniband.html
@@ -2,13 +2,13 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>libnm Reference Manual: NMSettingInfiniband</title>
+<title>NMSettingInfiniband: 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="NMSettingGsm.html" title="NMSettingGsm">
 <link rel="next" href="NMSettingIPConfig.html" title="NMSettingIPConfig">
-<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">
@@ -219,7 +219,6 @@ nm_setting_infiniband_get_mac_address (<em class="parameter"><code><a class="lin
 <div class="refsect3">
 <a name="id-1.4.16.8.3.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingInfiniband.html#NMSettingInfiniband--mac-address" title="The “mac-address” property"><span class="type">“mac-address”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -245,7 +244,6 @@ nm_setting_infiniband_get_mtu (<em class="parameter"><code><a class="link" href=
 <div class="refsect3">
 <a name="id-1.4.16.8.4.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingInfiniband.html#NMSettingInfiniband--mtu" title="The “mtu” property"><span class="type">“mtu”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -274,7 +272,6 @@ nm_setting_infiniband_get_transport_mode
 <div class="refsect3">
 <a name="id-1.4.16.8.5.6"></a><h4>Returns</h4>
 <p> the IPoIB transport mode</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -303,7 +300,6 @@ a 16-bit unsigned integer.</p>
 <div class="refsect3">
 <a name="id-1.4.16.8.6.6"></a><h4>Returns</h4>
 <p> the IPoIB P_Key</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -330,7 +326,6 @@ nm_setting_infiniband_get_parent (<em class="parameter"><code><a class="link" hr
 <div class="refsect3">
 <a name="id-1.4.16.8.7.6"></a><h4>Returns</h4>
 <p> the parent interface name</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -360,7 +355,6 @@ return <code class="literal">NULL</code>.)</p>
 <div class="refsect3">
 <a name="id-1.4.16.8.8.6"></a><h4>Returns</h4>
 <p> the interface name, or <code class="literal">NULL</code></p>
-<p></p>
 </div>
 </div>
 </div>
@@ -370,48 +364,36 @@ return <code class="literal">NULL</code>.)</p>
 <a name="NM-SETTING-INFINIBAND-SETTING-NAME:CAPS"></a><h3>NM_SETTING_INFINIBAND_SETTING_NAME</h3>
 <pre class="programlisting">#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-INFINIBAND-MAC-ADDRESS:CAPS"></a><h3>NM_SETTING_INFINIBAND_MAC_ADDRESS</h3>
 <pre class="programlisting">#define NM_SETTING_INFINIBAND_MAC_ADDRESS    "mac-address"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-INFINIBAND-MTU:CAPS"></a><h3>NM_SETTING_INFINIBAND_MTU</h3>
 <pre class="programlisting">#define NM_SETTING_INFINIBAND_MTU            "mtu"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-INFINIBAND-TRANSPORT-MODE:CAPS"></a><h3>NM_SETTING_INFINIBAND_TRANSPORT_MODE</h3>
 <pre class="programlisting">#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-INFINIBAND-P-KEY:CAPS"></a><h3>NM_SETTING_INFINIBAND_P_KEY</h3>
 <pre class="programlisting">#define NM_SETTING_INFINIBAND_P_KEY          "p-key"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-INFINIBAND-PARENT:CAPS"></a><h3>NM_SETTING_INFINIBAND_PARENT</h3>
 <pre class="programlisting">#define NM_SETTING_INFINIBAND_PARENT         "parent"
 </pre>
-<p>
-</p>
 </div>
 </div>
 <div class="refsect1">
@@ -419,7 +401,9 @@ return <code class="literal">NULL</code>.)</p>
 <div class="refsect2">
 <a name="NMSettingInfiniband--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 IPoIB 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>
@@ -427,7 +411,8 @@ return <code class="literal">NULL</code>.)</p>
 <div class="refsect2">
 <a name="NMSettingInfiniband--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 frames.</p>
 <p>Flags: Read / Write / Construct</p>
 <p>Default value: 0</p>
 </div>
@@ -435,7 +420,10 @@ return <code class="literal">NULL</code>.)</p>
 <div class="refsect2">
 <a name="NMSettingInfiniband--p-key"></a><h3>The <code class="literal">“p-key”</code> property</h3>
 <pre class="programlisting">  “p-key”                    <span class="type">gint</span></pre>
-<p></p>
+<p>The InfiniBand P_Key to use for this device. A value of -1 means to use
+the default P_Key (aka "the P_Key at index 0").  Otherwise it is a 16-bit
+unsigned integer, whose high bit is set if it is a "full membership"
+P_Key.</p>
 <p>Flags: Read / Write / Construct</p>
 <p>Allowed values: [-1,65535]</p>
 <p>Default value: -1</p>
@@ -444,7 +432,10 @@ return <code class="literal">NULL</code>.)</p>
 <div class="refsect2">
 <a name="NMSettingInfiniband--parent"></a><h3>The <code class="literal">“parent”</code> property</h3>
 <pre class="programlisting">  “parent”                   <span class="type">gchar</span> *</pre>
-<p></p>
+<p>The interface name of the parent device of this device. Normally <code class="literal">NULL</code>,
+but if the <a class="link" href="NMSettingInfiniband.html#NMSettingInfiniband--p-key" title="The “p-key” property"><span class="type">“p_key”</span></a> property is set, then you must
+specify the base device by setting either this property or
+<a class="link" href="NMSettingInfiniband.html#NMSettingInfiniband--mac-address" title="The “mac-address” property"><span class="type">“mac-address”</span></a>.</p>
 <p>Flags: Read / Write / Construct</p>
 <p>Default value: NULL</p>
 </div>
@@ -452,14 +443,14 @@ return <code class="literal">NULL</code>.)</p>
 <div class="refsect2">
 <a name="NMSettingInfiniband--transport-mode"></a><h3>The <code class="literal">“transport-mode”</code> property</h3>
 <pre class="programlisting">  “transport-mode”           <span class="type">gchar</span> *</pre>
-<p></p>
+<p>The IP-over-InfiniBand transport mode. Either "datagram" or
+"connected".</p>
 <p>Flags: Read / Write / Construct</p>
 <p>Default value: NULL</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