diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingBridge.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingBridge.html | 94 |
1 files changed, 34 insertions, 60 deletions
diff --git a/docs/libnm-util/html/NMSettingBridge.html b/docs/libnm-util/html/NMSettingBridge.html index a3292475..71cdd58f 100644 --- a/docs/libnm-util/html/NMSettingBridge.html +++ b/docs/libnm-util/html/NMSettingBridge.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm-util Reference Manual: NMSettingBridge</title> +<title>NMSettingBridge: libnm-util Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-util Reference Manual"> <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSettingBond.html" title="NMSettingBond"> <link rel="next" href="NMSettingBridgePort.html" title="NMSettingBridgePort"> -<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"> @@ -260,9 +260,8 @@ nm_setting_bridge_error_quark (<em class="parameter"><code><span class="type">vo <div class="refsect3"> <a name="id-1.2.14.9.2.5"></a><h4>Returns</h4> <p> the error quark used for <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> errors.</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -275,7 +274,7 @@ nm_setting_bridge_new (<em class="parameter"><code><span class="type">void</span <p> the new empty <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> object. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -300,9 +299,8 @@ nm_setting_bridge_get_interface_name (<em class="parameter"><code><a class="link <div class="refsect3"> <a name="id-1.2.14.9.4.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--interface-name" title="The “interface-name” property"><span class="type">“interface-name”</span></a> property of the setting</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -327,9 +325,8 @@ nm_setting_bridge_get_mac_address (<em class="parameter"><code><a class="link" h <div class="refsect3"> <a name="id-1.2.14.9.5.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--mac-address" title="The “mac-address” property"><span class="type">“mac-address”</span></a> property of the setting</p> -<p></p> </div> -<p class="since">Since 0.9.10</p> +<p class="since">Since: 0.9.10</p> </div> <hr> <div class="refsect2"> @@ -354,9 +351,8 @@ nm_setting_bridge_get_stp (<em class="parameter"><code><a class="link" href="NMS <div class="refsect3"> <a name="id-1.2.14.9.6.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--stp" title="The “stp” property"><span class="type">“stp”</span></a> property of the setting</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -381,9 +377,8 @@ nm_setting_bridge_get_priority (<em class="parameter"><code><a class="link" href <div class="refsect3"> <a name="id-1.2.14.9.7.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--priority" title="The “priority” property"><span class="type">“priority”</span></a> property of the setting</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -408,9 +403,8 @@ nm_setting_bridge_get_forward_delay (<em class="parameter"><code><a class="link" <div class="refsect3"> <a name="id-1.2.14.9.8.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--forward-delay" title="The “forward-delay” property"><span class="type">“forward-delay”</span></a> property of the setting</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -435,9 +429,8 @@ nm_setting_bridge_get_hello_time (<em class="parameter"><code><a class="link" hr <div class="refsect3"> <a name="id-1.2.14.9.9.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--hello-time" title="The “hello-time” property"><span class="type">“hello-time”</span></a> property of the setting</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -462,9 +455,8 @@ nm_setting_bridge_get_max_age (<em class="parameter"><code><a class="link" href= <div class="refsect3"> <a name="id-1.2.14.9.10.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--max-age" title="The “max-age” property"><span class="type">“max-age”</span></a> property of the setting</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -489,9 +481,8 @@ nm_setting_bridge_get_ageing_time (<em class="parameter"><code><a class="link" h <div class="refsect3"> <a name="id-1.2.14.9.11.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--ageing-time" title="The “ageing-time” property"><span class="type">“ageing-time”</span></a> property of the setting</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> </div> <div class="refsect1"> @@ -500,8 +491,6 @@ nm_setting_bridge_get_ageing_time (<em class="parameter"><code><a class="link" h <a name="NM-SETTING-BRIDGE-SETTING-NAME:CAPS"></a><h3>NM_SETTING_BRIDGE_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_SETTING_NAME "bridge" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -540,79 +529,61 @@ required</p> </tbody> </table></div> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-BRIDGE-ERROR:CAPS"></a><h3>NM_SETTING_BRIDGE_ERROR</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_ERROR nm_setting_bridge_error_quark () </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-BRIDGE-INTERFACE-NAME:CAPS"></a><h3>NM_SETTING_BRIDGE_INTERFACE_NAME</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_INTERFACE_NAME "interface-name" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-BRIDGE-MAC-ADDRESS:CAPS"></a><h3>NM_SETTING_BRIDGE_MAC_ADDRESS</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_MAC_ADDRESS "mac-address" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-BRIDGE-STP:CAPS"></a><h3>NM_SETTING_BRIDGE_STP</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_STP "stp" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-BRIDGE-PRIORITY:CAPS"></a><h3>NM_SETTING_BRIDGE_PRIORITY</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_PRIORITY "priority" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-BRIDGE-FORWARD-DELAY:CAPS"></a><h3>NM_SETTING_BRIDGE_FORWARD_DELAY</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_FORWARD_DELAY "forward-delay" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-BRIDGE-HELLO-TIME:CAPS"></a><h3>NM_SETTING_BRIDGE_HELLO_TIME</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_HELLO_TIME "hello-time" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-BRIDGE-MAX-AGE:CAPS"></a><h3>NM_SETTING_BRIDGE_MAX_AGE</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_MAX_AGE "max-age" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-BRIDGE-AGEING-TIME:CAPS"></a><h3>NM_SETTING_BRIDGE_AGEING_TIME</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_AGEING_TIME "ageing-time" </pre> -<p> -</p> </div> </div> <div class="refsect1"> @@ -620,82 +591,85 @@ required</p> <div class="refsect2"> <a name="NMSettingBridge--ageing-time"></a><h3>The <code class="literal">“ageing-time”</code> property</h3> <pre class="programlisting"> “ageing-time” <span class="type">guint</span></pre> -<p></p> +<p>The Ethernet MAC address aging time, in seconds.</p> <p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 1000000</p> <p>Default value: 300</p> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> <a name="NMSettingBridge--forward-delay"></a><h3>The <code class="literal">“forward-delay”</code> property</h3> <pre class="programlisting"> “forward-delay” <span class="type">guint</span></pre> -<p></p> +<p>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</p> <p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 30</p> <p>Default value: 15</p> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> <a name="NMSettingBridge--hello-time"></a><h3>The <code class="literal">“hello-time”</code> property</h3> <pre class="programlisting"> “hello-time” <span class="type">guint</span></pre> -<p></p> +<p>The Spanning Tree Protocol (STP) hello time, in seconds.</p> <p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 10</p> <p>Default value: 2</p> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> <a name="NMSettingBridge--interface-name"></a><h3>The <code class="literal">“interface-name”</code> property</h3> <pre class="programlisting"> “interface-name” <span class="type">gchar</span> *</pre> -<p></p> +<p>The name of the virtual in-kernel bridging network interface</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> <a name="NMSettingBridge--mac-address"></a><h3>The <code class="literal">“mac-address”</code> property</h3> <pre class="programlisting"> “mac-address” <span class="type">GArray_guchar_</span> *</pre> -<p></p> +<p>If specified, the MAC address of bridge. When creating a new bridge, this +MAC address will be set. When matching an existing (outside +NetworkManager created) bridge, this MAC address must match.</p> <p>Flags: Read / Write</p> -<p class="since">Since 0.9.10</p> +<p class="since">Since: 0.9.10</p> </div> <hr> <div class="refsect2"> <a name="NMSettingBridge--max-age"></a><h3>The <code class="literal">“max-age”</code> property</h3> <pre class="programlisting"> “max-age” <span class="type">guint</span></pre> -<p></p> +<p>The Spanning Tree Protocol (STP) maximum message age, in seconds.</p> <p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 40</p> <p>Default value: 20</p> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> <a name="NMSettingBridge--priority"></a><h3>The <code class="literal">“priority”</code> property</h3> <pre class="programlisting"> “priority” <span class="type">guint</span></pre> -<p></p> +<p>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower +values are "better"; the lowest priority bridge will be elected the root +bridge.</p> <p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 65535</p> <p>Default value: 32768</p> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> <a name="NMSettingBridge--stp"></a><h3>The <code class="literal">“stp”</code> property</h3> <pre class="programlisting"> “stp” <span class="type">gboolean</span></pre> -<p></p> +<p>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: TRUE</p> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</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 |