diff options
Diffstat (limited to 'docs/api/html')
| -rw-r--r-- | docs/api/html/home.png | bin | 256 -> 654 bytes | |||
| -rw-r--r-- | docs/api/html/index.html | 8 | ||||
| -rw-r--r-- | docs/api/html/ix01.html | 18 | ||||
| -rw-r--r-- | docs/api/html/left-insensitive.png | bin | 395 -> 0 bytes | |||
| -rw-r--r-- | docs/api/html/left.png | bin | 262 -> 459 bytes | |||
| -rw-r--r-- | docs/api/html/license.html | 18 | ||||
| -rw-r--r-- | docs/api/html/ref-dbus.html | 18 | ||||
| -rw-r--r-- | docs/api/html/ref-migrating.html | 24 | ||||
| -rw-r--r-- | docs/api/html/ref-settings.html | 369 | ||||
| -rw-r--r-- | docs/api/html/right-insensitive.png | bin | 373 -> 0 bytes | |||
| -rw-r--r-- | docs/api/html/right.png | bin | 261 -> 472 bytes | |||
| -rw-r--r-- | docs/api/html/secrets-flags.html | 18 | ||||
| -rw-r--r-- | docs/api/html/spec.html | 596 | ||||
| -rw-r--r-- | docs/api/html/style.css | 247 | ||||
| -rw-r--r-- | docs/api/html/up-insensitive.png | bin | 374 -> 0 bytes | |||
| -rw-r--r-- | docs/api/html/up.png | bin | 260 -> 406 bytes |
16 files changed, 903 insertions, 413 deletions
diff --git a/docs/api/html/home.png b/docs/api/html/home.png Binary files differindex 9346b336a..17003611d 100644 --- a/docs/api/html/home.png +++ b/docs/api/html/home.png diff --git a/docs/api/html/index.html b/docs/api/html/index.html index 778d86ae2..08c517de8 100644 --- a/docs/api/html/index.html +++ b/docs/api/html/index.html @@ -2,11 +2,11 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NetworkManager D-Bus Reference Manual: NetworkManager D-Bus Reference Manual</title> +<title>NetworkManager D-Bus Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="next" href="ref-dbus.html" title="D-Bus API Reference"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -14,7 +14,7 @@ <div class="titlepage"> <div> <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">NetworkManager D-Bus Reference Manual</p></th></tr></table></div> -<div><p class="releaseinfo">Version 0.9.8.10 +<div><p class="releaseinfo">Version 0.9.10.0 </p></div> <div><p class="copyright">Copyright © 2012 The NetworkManager Authors</p></div> <div><div class="legalnotice"> @@ -73,6 +73,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.20</div> + Generated by GTK-Doc V1.19</div> </body> </html>
\ No newline at end of file diff --git a/docs/api/html/ix01.html b/docs/api/html/ix01.html index 31506c915..ae39f8505 100644 --- a/docs/api/html/ix01.html +++ b/docs/api/html/ix01.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NetworkManager D-Bus Reference Manual: Index</title> +<title>Index</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="prev" href="ref-migrating.html" title="Migrating from NetworkManager 0.8 to NetworkManager 0.9"> <link rel="next" href="license.html" title="Appendix A. License"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="ref-migrating.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="license.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ref-migrating.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="license.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr></table> <div class="index"> <div class="titlepage"><div><div><h1 class="title"> @@ -26,6 +26,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.20</div> + Generated by GTK-Doc V1.19</div> </body> </html>
\ No newline at end of file diff --git a/docs/api/html/left-insensitive.png b/docs/api/html/left-insensitive.png Binary files differdeleted file mode 100644 index 3269393a7..000000000 --- a/docs/api/html/left-insensitive.png +++ /dev/null diff --git a/docs/api/html/left.png b/docs/api/html/left.png Binary files differindex 2abde032b..2d05b3d5b 100644 --- a/docs/api/html/left.png +++ b/docs/api/html/left.png diff --git a/docs/api/html/license.html b/docs/api/html/license.html index 10c38b2ec..6cd55c467 100644 --- a/docs/api/html/license.html +++ b/docs/api/html/license.html @@ -2,21 +2,21 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NetworkManager D-Bus Reference Manual: Appendix A. License</title> +<title>Appendix A. License</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="prev" href="ix01.html" title="Index"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="ix01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><img src="right-insensitive.png" width="16" height="16" border="0"></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ix01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td> </td> </tr></table> <div class="appendix"> <div class="titlepage"><div><div><h1 class="title"> @@ -380,6 +380,6 @@ Public License instead of this License. </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.20</div> + Generated by GTK-Doc V1.19</div> </body> </html>
\ No newline at end of file diff --git a/docs/api/html/ref-dbus.html b/docs/api/html/ref-dbus.html index dff6d1c97..353bfa5b8 100644 --- a/docs/api/html/ref-dbus.html +++ b/docs/api/html/ref-dbus.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NetworkManager D-Bus Reference Manual: D-Bus API Reference</title> +<title>D-Bus API Reference</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="prev" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="next" href="ref-settings.html" title="Network Configuration Setting Specification"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="ref-settings.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="ref-settings.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h1 class="title"> @@ -30,6 +30,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.20</div> + Generated by GTK-Doc V1.19</div> </body> </html>
\ No newline at end of file diff --git a/docs/api/html/ref-migrating.html b/docs/api/html/ref-migrating.html index 2ea302242..00545851b 100644 --- a/docs/api/html/ref-migrating.html +++ b/docs/api/html/ref-migrating.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NetworkManager D-Bus Reference Manual: Migrating from NetworkManager 0.8 to NetworkManager 0.9</title> +<title>Migrating from NetworkManager 0.8 to NetworkManager 0.9</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="prev" href="secrets-flags.html" title="Secret flag types"> <link rel="next" href="ix01.html" title="Index"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="secrets-flags.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="ix01.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="secrets-flags.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h1 class="title"> @@ -256,7 +256,7 @@ are now string-based permissions. The mapping is as follows: </p> <div class="table"> -<a name="id-1.4.3.7.3.2"></a><p class="title"><b>Table 23. </b></p> +<a name="id-1.4.3.7.3.2"></a><p class="title"><b>Table 26. </b></p> <div class="table-contents"><table border="1"> <colgroup> <col> @@ -424,7 +424,7 @@ following values: </p> <div class="table"> -<a name="id-1.4.3.13.2.1"></a><p class="title"><b>Table 24. </b></p> +<a name="id-1.4.3.13.2.1"></a><p class="title"><b>Table 27. </b></p> <div class="table-contents"><table border="1"> <colgroup> <col> @@ -496,7 +496,7 @@ their replacements: </p> <div class="table"> -<a name="id-1.4.3.14.2.2"></a><p class="title"><b>Table 25. </b></p> +<a name="id-1.4.3.14.2.2"></a><p class="title"><b>Table 28. </b></p> <div class="table-contents"><table border="1"> <colgroup> <col> @@ -536,6 +536,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.20</div> + Generated by GTK-Doc V1.19</div> </body> </html>
\ No newline at end of file diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html index b32f6b015..dbaf10d24 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NetworkManager D-Bus Reference Manual: Network Configuration Setting Specification</title> +<title>Network Configuration Setting Specification</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="prev" href="ref-dbus.html" title="D-Bus API Reference"> <link rel="next" href="secrets-flags.html" title="Secret flag types"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="ref-dbus.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="secrets-flags.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ref-dbus.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="secrets-flags.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h1 class="title"> @@ -63,8 +63,8 @@ <tr> <td><pre class="screen">eap</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> -<td>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: 'leap', 'md5', 'tls', 'peap', 'ttls', and 'fast'. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> <td><pre class="screen">identity</pre></td> @@ -105,7 +105,7 @@ <tr> <td><pre class="screen">altsubject-matches</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>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.</td> </tr> <tr> @@ -165,7 +165,7 @@ <tr> <td><pre class="screen">phase2-altsubject-matches</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>List of strings to be matched against 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.</td> </tr> <tr> @@ -396,7 +396,7 @@ <tr> <td><pre class="screen">options</pre></td> <td><pre class="screen">dict of (string::string)</pre></td> -<td><pre class="screen">[ ]</pre></td> +<td><pre class="screen"></pre></td> <td>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</td> </tr> </tbody> @@ -433,6 +433,12 @@ <td>The name of the virtual in-kernel bridging network interface</td> </tr> <tr> +<td><pre class="screen">mac-address</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>The MAC address of the bridge</td> +</tr> +<tr> <td><pre class="screen">stp</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> @@ -466,7 +472,7 @@ <td><pre class="screen">ageing-time</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">300</pre></td> -<td>The ethernet MAC address aging time, in seconds.</td> +<td>The Ethernet MAC address aging time, in seconds.</td> </tr> </tbody> </table></div> @@ -601,7 +607,13 @@ <td><pre class="screen">uuid</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Universally unique connection identifier. Must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' (ie, contains only hexadecimal characters and '-'). The UUID should be assigned when the connection is created and never changed as long as the connection still applies to the same network. For example, it should not be changed when the user changes the connection's 'id', but should be recreated when the WiFi SSID, mobile broadband network provider, or the connection type changes.</td> +<td>Universally unique connection identifier. Must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' (ie, contains only hexadecimal characters and '-'). The UUID should be assigned when the connection is created and never changed as long as the connection still applies to the same network. For example, it should not be changed when the user changes the connection's 'id', but should be recreated when the Wi-Fi SSID, mobile broadband network provider, or the connection type changes.</td> +</tr> +<tr> +<td><pre class="screen">interface-name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Interface name this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.</td> </tr> <tr> <td><pre class="screen">type</pre></td> @@ -612,7 +624,7 @@ <tr> <td><pre class="screen">permissions</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection. Otherwise a user is allowed to access this connection if and only if they are in this array. Each entry is of the form "[type]:[id]:[reserved]", for example: "user:dcbw:blah" At this time only the 'user' [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ':' character. Any [reserved] information (if present) must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</td> </tr> <tr> @@ -625,7 +637,7 @@ <td><pre class="screen">timestamp</pre></td> <td><pre class="screen">uint64</pre></td> <td><pre class="screen">0</pre></td> -<td>Timestamp (in seconds since the Unix Epoch) that the connection was last successfully activated. Settings services should update the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp.</td> +<td>Timestamp (in seconds since the Unix Epoch) that the connection was last successfully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</td> </tr> <tr> <td><pre class="screen">read-only</pre></td> @@ -654,8 +666,131 @@ <tr> <td><pre class="screen">secondaries</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> -<td>List of connection UUIDs that should be activated when the base connection itself is activated.</td> +<td><pre class="screen"></pre></td> +<td>List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.</td> +</tr> +<tr> +<td><pre class="screen">gateway-ping-timeout</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id-1.3.3.2.9"></a><p class="title"><b>Table 9. dcb setting</b></p> +<div class="table-contents"><table summary="dcb setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">dcb</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">app-fcoe-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Specifies the flags for the DCB FCoE application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">app-fcoe-priority</pre></td> +<td><pre class="screen">int32</pre></td> +<td><pre class="screen">-1</pre></td> +<td>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the 'app-fcoe-flags' property includes the 'enabled' flag.</td> +</tr> +<tr> +<td><pre class="screen">app-fcoe-mode</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">"fabric"</pre></td> +<td>The FCoe controller mode; either 'fabric' (default) or 'vn2vn'.</td> +</tr> +<tr> +<td><pre class="screen">app-iscsi-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Specifies the flags for the DCB iSCSI application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">app-iscsi-priority</pre></td> +<td><pre class="screen">int32</pre></td> +<td><pre class="screen">-1</pre></td> +<td>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the 'app-iscsi-flags' property includes the 'enabled' flag.</td> +</tr> +<tr> +<td><pre class="screen">app-fip-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Specifies the flags for the DCB FIP application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">app-fip-priority</pre></td> +<td><pre class="screen">int32</pre></td> +<td><pre class="screen">-1</pre></td> +<td>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the 'app-fip-flags' property includes the 'enabled' flag.</td> +</tr> +<tr> +<td><pre class="screen">priority-flow-control-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Specifies the flags for DCB Priority Flow Control. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">priority-flow-control</pre></td> +<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen"></pre></td> +<td>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause. Allowed values are 0 (do not transmit pause) and 1 (transmit pause).</td> +</tr> +<tr> +<td><pre class="screen">priority-group-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Specifies the flags for DCB Priority Groups. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">priority-group-id</pre></td> +<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen"></pre></td> +<td>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</td> +</tr> +<tr> +<td><pre class="screen">priority-group-bandwidth</pre></td> +<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen"></pre></td> +<td>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percent.</td> +</tr> +<tr> +<td><pre class="screen">priority-bandwidth</pre></td> +<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen"></pre></td> +<td>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percent.</td> +</tr> +<tr> +<td><pre class="screen">priority-strict-bandwidth</pre></td> +<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen"></pre></td> +<td>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group. Allowed values are 0 (the priority may not utilize all bandwidth) or 1 (the priority may utilize all bandwidth).</td> +</tr> +<tr> +<td><pre class="screen">priority-traffic-class</pre></td> +<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen"></pre></td> +<td>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</td> </tr> </tbody> </table></div> @@ -663,7 +798,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.9"></a><p class="title"><b>Table 9. gsm setting</b></p> +<a name="id-1.3.3.2.10"></a><p class="title"><b>Table 10. gsm setting</b></p> <div class="table-contents"><table summary="gsm setting" border="1"> <colgroup> <col> @@ -724,7 +859,7 @@ <td><pre class="screen">network-type</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td>Network preference to force the device to only use specific network technologies. The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. Note that not all devices allow network preference control.</td> +<td>Network preference to force the device to only use specific network technologies. The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. Notes: This property is deprecated and NetworkManager from 0.9.10 onwards doesn't use this property when talking to ModemManager.Also, not all devices allow network preference control.</td> </tr> <tr> <td><pre class="screen">pin</pre></td> @@ -742,7 +877,7 @@ <td><pre class="screen">allowed-bands</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">1</pre></td> -<td>Bitfield of allowed frequency bands. Note that not all devices allow frequency band control.</td> +<td>Bitfield of allowed frequency bands.Notes: This property is deprecated and NetworkManager from 0.9.10 onwards doesn't use this property when talking to ModemManager.Also, not all devices allow frequency band control.</td> </tr> <tr> <td><pre class="screen">home-only</pre></td> @@ -756,7 +891,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.10"></a><p class="title"><b>Table 10. infiniband setting</b></p> +<a name="id-1.3.3.2.11"></a><p class="title"><b>Table 11. infiniband setting</b></p> <div class="table-contents"><table summary="infiniband setting" border="1"> <colgroup> <col> @@ -795,13 +930,25 @@ <td><pre class="screen"></pre></td> <td>The IPoIB transport mode. Either 'datagram' or 'connected'.</td> </tr> +<tr> +<td><pre class="screen">p-key</pre></td> +<td><pre class="screen">int32</pre></td> +<td><pre class="screen">-1</pre></td> +<td>The InfiniBand P_Key. Either -1 for the default, or a 16-bit unsigned integer.</td> +</tr> +<tr> +<td><pre class="screen">parent</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The interface name of the parent device, or NULL</td> +</tr> </tbody> </table></div> </div> <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.11"></a><p class="title"><b>Table 11. ipv4 setting</b></p> +<a name="id-1.3.3.2.12"></a><p class="title"><b>Table 12. ipv4 setting</b></p> <div class="table-contents"><table summary="ipv4 setting" border="1"> <colgroup> <col> @@ -831,25 +978,31 @@ <tr> <td><pre class="screen">dns</pre></td> <td><pre class="screen">array of uint32</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>List of DNS servers (network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</td> </tr> <tr> <td><pre class="screen">dns-search</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</td> </tr> <tr> <td><pre class="screen">addresses</pre></td> <td><pre class="screen">array of array of uint32</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared', 'link-local', or 'disabled' methods as addressing is either automatic or disabled with these methods.</td> </tr> <tr> +<td><pre class="screen">address-labels</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen"></pre></td> +<td>Internal use only</td> +</tr> +<tr> <td><pre class="screen">routes</pre></td> <td><pre class="screen">array of array of uint32</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared', 'link-local', or 'disabled', methods as there is no upstream network.</td> </tr> <tr> @@ -900,7 +1053,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.12"></a><p class="title"><b>Table 12. ipv6 setting</b></p> +<a name="id-1.3.3.2.13"></a><p class="title"><b>Table 13. ipv6 setting</b></p> <div class="table-contents"><table summary="ipv6 setting" border="1"> <colgroup> <col> @@ -925,7 +1078,7 @@ <td><pre class="screen">method</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset. To force the use of DHCP only, specify 'dhcp'; this method is only valid for ethernet-based hardware. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'ignore' is specified, IPv6 configuration is not done. This property must be set. NOTE: the 'shared' methodis not yet supported.</td> +<td>IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset. To force the use of DHCP only, specify 'dhcp'; this method is only valid for Ethernet-based hardware. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'ignore' is specified, IPv6 configuration is not done. This property must be set. Note: the 'shared' method is not yet supported.</td> </tr> <tr> <td><pre class="screen">dhcp-hostname</pre></td> @@ -936,25 +1089,25 @@ <tr> <td><pre class="screen">dns</pre></td> <td><pre class="screen">array of byte array</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>Array of DNS servers, where each member of the array is a byte array containing the IPv6 address of the DNS server (in network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared' or 'link-local' methods as there is no usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</td> </tr> <tr> <td><pre class="screen">dns-search</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared' or 'link-local' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</td> </tr> <tr> <td><pre class="screen">addresses</pre></td> <td><pre class="screen">array of (byte array, uint32, byte array)</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>Array of IPv6 address structures. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any. If no gateway is given, the third element should be given as all zeros. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared' or 'link-local' methods as the interface is automatically assigned an address with these methods.</td> </tr> <tr> <td><pre class="screen">routes</pre></td> <td><pre class="screen">array of (byte array, uint32, byte array, uint32)</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>Array of IPv6 route structures. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next-hop IPv6 address (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared' or 'link-local' methods because there is no upstream network.</td> </tr> <tr> @@ -993,7 +1146,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.13"></a><p class="title"><b>Table 13. 802-11-olpc-mesh setting</b></p> +<a name="id-1.3.3.2.14"></a><p class="title"><b>Table 14. 802-11-olpc-mesh setting</b></p> <div class="table-contents"><table summary="802-11-olpc-mesh setting" border="1"> <colgroup> <col> @@ -1038,7 +1191,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.14"></a><p class="title"><b>Table 14. ppp setting</b></p> +<a name="id-1.3.3.2.15"></a><p class="title"><b>Table 15. ppp setting</b></p> <div class="table-contents"><table summary="ppp setting" border="1"> <colgroup> <col> @@ -1173,7 +1326,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.15"></a><p class="title"><b>Table 15. pppoe setting</b></p> +<a name="id-1.3.3.2.16"></a><p class="title"><b>Table 16. pppoe setting</b></p> <div class="table-contents"><table summary="pppoe setting" border="1"> <colgroup> <col> @@ -1198,7 +1351,7 @@ <td><pre class="screen">service</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified serivce. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</td> +<td>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</td> </tr> <tr> <td><pre class="screen">username</pre></td> @@ -1224,7 +1377,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.16"></a><p class="title"><b>Table 16. serial setting</b></p> +<a name="id-1.3.3.2.17"></a><p class="title"><b>Table 17. serial setting</b></p> <div class="table-contents"><table summary="serial setting" border="1"> <colgroup> <col> @@ -1281,7 +1434,79 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.17"></a><p class="title"><b>Table 17. vlan setting</b></p> +<a name="id-1.3.3.2.18"></a><p class="title"><b>Table 18. team setting</b></p> +<div class="table-contents"><table summary="team setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">team</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">interface-name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The name of the virtual in-kernel team network interface</td> +</tr> +<tr> +<td><pre class="screen">config</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id-1.3.3.2.19"></a><p class="title"><b>Table 19. team-port setting</b></p> +<div class="table-contents"><table summary="team-port setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">team-port</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">config</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the dafault configuration is used. See man teamd.conf for the format details.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id-1.3.3.2.20"></a><p class="title"><b>Table 20. vlan setting</b></p> <div class="table-contents"><table summary="vlan setting" border="1"> <colgroup> <col> @@ -1306,13 +1531,13 @@ <td><pre class="screen">interface-name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by a hardware address property, eg the 'wired' settings' 'mac-address' property.</td> +<td>If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by the 'mac-address' property of a 'wired' setting.</td> </tr> <tr> <td><pre class="screen">parent</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain a hardware address in a hardware-specific setting, like the 'wired' settings' 'mac-address' property.</td> +<td>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain a 'wired' setting with a 'mac-address' property.</td> </tr> <tr> <td><pre class="screen">id</pre></td> @@ -1329,13 +1554,13 @@ <tr> <td><pre class="screen">ingress-priority-map</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.</td> </tr> <tr> <td><pre class="screen">egress-priority-map</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.</td> </tr> </tbody> @@ -1344,7 +1569,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.18"></a><p class="title"><b>Table 18. vpn setting</b></p> +<a name="id-1.3.3.2.21"></a><p class="title"><b>Table 21. vpn setting</b></p> <div class="table-contents"><table summary="vpn setting" border="1"> <colgroup> <col> @@ -1380,13 +1605,13 @@ <tr> <td><pre class="screen">data</pre></td> <td><pre class="screen">dict of (string::string)</pre></td> -<td><pre class="screen">[ ]</pre></td> +<td><pre class="screen"></pre></td> <td>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</td> </tr> <tr> <td><pre class="screen">secrets</pre></td> <td><pre class="screen">dict of (string::string)</pre></td> -<td><pre class="screen">[ ]</pre></td> +<td><pre class="screen"></pre></td> <td>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</td> </tr> </tbody> @@ -1395,7 +1620,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.19"></a><p class="title"><b>Table 19. wimax setting</b></p> +<a name="id-1.3.3.2.22"></a><p class="title"><b>Table 22. wimax setting</b></p> <div class="table-contents"><table summary="wimax setting" border="1"> <colgroup> <col> @@ -1434,7 +1659,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.20"></a><p class="title"><b>Table 20. 802-3-ethernet setting</b></p> +<a name="id-1.3.3.2.23"></a><p class="title"><b>Table 23. 802-3-ethernet setting</b></p> <div class="table-contents"><table summary="802-3-ethernet setting" border="1"> <colgroup> <col> @@ -1483,7 +1708,7 @@ <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen">[]</pre></td> -<td>If specified, this connection will only apply to the ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</td> +<td>If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</td> </tr> <tr> <td><pre class="screen">cloned-mac-address</pre></td> @@ -1494,8 +1719,8 @@ <tr> <td><pre class="screen">mac-address-blacklist</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> -<td>If specified, this connection will never apply to the ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</td> +<td><pre class="screen"></pre></td> +<td>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> @@ -1506,7 +1731,7 @@ <tr> <td><pre class="screen">s390-subchannels</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>Identifies specific subchannels that this network device uses for communcation with z/VM or s390 host. Like the 'mac-address' property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</td> </tr> <tr> @@ -1518,7 +1743,7 @@ <tr> <td><pre class="screen">s390-options</pre></td> <td><pre class="screen">dict of (string::string)</pre></td> -<td><pre class="screen">[ ]</pre></td> +<td><pre class="screen"></pre></td> <td>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include 'portno', 'layer2', 'portname', 'protocol', among others.</td> </tr> </tbody> @@ -1527,7 +1752,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.21"></a><p class="title"><b>Table 21. 802-11-wireless setting</b></p> +<a name="id-1.3.3.2.24"></a><p class="title"><b>Table 24. 802-11-wireless setting</b></p> <div class="table-contents"><table summary="802-11-wireless setting" border="1"> <colgroup> <col> @@ -1552,25 +1777,25 @@ <td><pre class="screen">ssid</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen">[]</pre></td> -<td>SSID of the WiFi network. Must be specified.</td> +<td>SSID of the Wi-Fi network. Must be specified.</td> </tr> <tr> <td><pre class="screen">mode</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>WiFi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, infrastructure is assumed.</td> +<td>Wi-Fi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, infrastructure is assumed.</td> </tr> <tr> <td><pre class="screen">band</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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 WiFi 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.</td> +<td>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.</td> </tr> <tr> <td><pre class="screen">channel</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td>Wireless channel to use for the WiFi connection. The device will only join (or create for Ad-Hoc networks) a WiFi network on the specified channel. Because channel numbers overlap between bands, this property also requires the 'band' property to be set.</td> +<td>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.</td> </tr> <tr> <td><pre class="screen">bssid</pre></td> @@ -1594,18 +1819,18 @@ <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen">[]</pre></td> -<td>If specified, this connection will only apply to the WiFi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</td> +<td>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).</td> </tr> <tr> <td><pre class="screen">cloned-mac-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen">[]</pre></td> -<td>If specified, request that the WiFi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</td> +<td>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.</td> </tr> <tr> <td><pre class="screen">mac-address-blacklist</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>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').</td> </tr> <tr> @@ -1617,8 +1842,8 @@ <tr> <td><pre class="screen">seen-bssids</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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 WiFI network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BBSID list of NetworkManager. The changes you make to this property will not be preserved.</td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> <td><pre class="screen">security</pre></td> @@ -1638,7 +1863,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id-1.3.3.2.22"></a><p class="title"><b>Table 22. 802-11-wireless-security setting</b></p> +<a name="id-1.3.3.2.25"></a><p class="title"><b>Table 25. 802-11-wireless-security setting</b></p> <div class="table-contents"><table summary="802-11-wireless-security setting" border="1"> <colgroup> <col> @@ -1663,7 +1888,7 @@ <td><pre class="screen">key-mgmt</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Key management used for the connection. One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for any WiFi connection that uses security.</td> +<td>Key management used for the connection. One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security.</td> </tr> <tr> <td><pre class="screen">wep-tx-keyidx</pre></td> @@ -1680,19 +1905,19 @@ <tr> <td><pre class="screen">proto</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>List of strings specifying the allowed WPA protocol versions to use. Each element may be one 'wpa' (allow WPA) or 'rsn' (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</td> </tr> <tr> <td><pre class="screen">pairwise</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> -<td>A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of 'wep40', 'wep104', 'tkip' or 'ccmp'.</td> +<td><pre class="screen"></pre></td> +<td>A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of 'tkip' or 'ccmp'.</td> </tr> <tr> <td><pre class="screen">group</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen">[]</pre></td> +<td><pre class="screen"></pre></td> <td>A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</td> </tr> <tr> @@ -1741,7 +1966,7 @@ <td><pre class="screen">psk</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the WiFi network.</td> +<td>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the Wi-Fi network.</td> </tr> <tr> <td><pre class="screen">psk-flags</pre></td> @@ -1770,6 +1995,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.20</div> + Generated by GTK-Doc V1.19</div> </body> </html>
\ No newline at end of file diff --git a/docs/api/html/right-insensitive.png b/docs/api/html/right-insensitive.png Binary files differdeleted file mode 100644 index 4c95785b9..000000000 --- a/docs/api/html/right-insensitive.png +++ /dev/null diff --git a/docs/api/html/right.png b/docs/api/html/right.png Binary files differindex 76260ec88..92832e3a4 100644 --- a/docs/api/html/right.png +++ b/docs/api/html/right.png diff --git a/docs/api/html/secrets-flags.html b/docs/api/html/secrets-flags.html index 91d40d5de..4948a0a42 100644 --- a/docs/api/html/secrets-flags.html +++ b/docs/api/html/secrets-flags.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NetworkManager D-Bus Reference Manual: Secret flag types</title> +<title>Secret flag types</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> <link rel="up" href="ref-settings.html" title="Network Configuration Setting Specification"> <link rel="prev" href="ref-settings.html" title="Network Configuration Setting Specification"> <link rel="next" href="ref-migrating.html" title="Migrating from NetworkManager 0.8 to NetworkManager 0.9"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><a accesskey="u" href="ref-settings.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="ref-settings.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="ref-migrating.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ref-settings.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ref-settings.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="ref-migrating.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr></table> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> @@ -59,6 +59,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.20</div> + Generated by GTK-Doc V1.19</div> </body> </html>
\ No newline at end of file diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html index 0573bc4fa..84819cabc 100644 --- a/docs/api/html/spec.html +++ b/docs/api/html/spec.html @@ -1,4 +1,4 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>NetworkManager D-Bus Interface Specification version 0.9.8.10</title><style type="text/css"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>NetworkManager D-Bus Interface Specification version 0.9.10.0</title><style type="text/css"> body { font-family: sans-serif; @@ -97,7 +97,7 @@ margin-right: 4em; } - </style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 0.9.8.10</h2><div>Copyright (C) 2008 - 2011 Red Hat, Inc.</div><div>Copyright (C) 2008 - 2009 Novell, Inc.</div><div class="license"> + </style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 0.9.10.0</h2><div>Copyright (C) 2008 - 2011 Red Hat, Inc.</div><div>Copyright (C) 2008 - 2009 Novell, Inc.</div><div class="license"> <p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or @@ -111,7 +111,7 @@ General Public License for more details.</p> <p>You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p> -</div><h2>Interfaces</h2><ul><li><code><a href="#org.freedesktop.NetworkManager">org.freedesktop.NetworkManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AccessPoint">org.freedesktop.NetworkManager.AccessPoint</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device">org.freedesktop.NetworkManager.Device</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wired">org.freedesktop.NetworkManager.Device.Wired</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wireless">org.freedesktop.NetworkManager.Device.Wireless</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Modem">org.freedesktop.NetworkManager.Device.Modem</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bluetooth">org.freedesktop.NetworkManager.Device.Bluetooth</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.OlpcMesh">org.freedesktop.NetworkManager.Device.OlpcMesh</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.WiMax">org.freedesktop.NetworkManager.Device.WiMax</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Infiniband">org.freedesktop.NetworkManager.Device.Infiniband</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bond">org.freedesktop.NetworkManager.Device.Bond</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bridge">org.freedesktop.NetworkManager.Device.Bridge</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Vlan">org.freedesktop.NetworkManager.Device.Vlan</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Adsl">org.freedesktop.NetworkManager.Device.Adsl</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.WiMax.Nsp">org.freedesktop.NetworkManager.WiMax.Nsp</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP4Config">org.freedesktop.NetworkManager.IP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP6Config">org.freedesktop.NetworkManager.IP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP4Config">org.freedesktop.NetworkManager.DHCP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP6Config">org.freedesktop.NetworkManager.DHCP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings">org.freedesktop.NetworkManager.Settings</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings.Connection">org.freedesktop.NetworkManager.Settings.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Connection.Active">org.freedesktop.NetworkManager.Connection.Active</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AgentManager">org.freedesktop.NetworkManager.AgentManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.SecretAgent">org.freedesktop.NetworkManager.SecretAgent</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Connection">org.freedesktop.NetworkManager.VPN.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Plugin">org.freedesktop.NetworkManager.VPN.Plugin</a></code></li></ul> +</div><h2>Interfaces</h2><ul><li><code><a href="#org.freedesktop.NetworkManager">org.freedesktop.NetworkManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AccessPoint">org.freedesktop.NetworkManager.AccessPoint</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device">org.freedesktop.NetworkManager.Device</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wired">org.freedesktop.NetworkManager.Device.Wired</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wireless">org.freedesktop.NetworkManager.Device.Wireless</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Modem">org.freedesktop.NetworkManager.Device.Modem</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bluetooth">org.freedesktop.NetworkManager.Device.Bluetooth</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.OlpcMesh">org.freedesktop.NetworkManager.Device.OlpcMesh</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.WiMax">org.freedesktop.NetworkManager.Device.WiMax</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Infiniband">org.freedesktop.NetworkManager.Device.Infiniband</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bond">org.freedesktop.NetworkManager.Device.Bond</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bridge">org.freedesktop.NetworkManager.Device.Bridge</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Team">org.freedesktop.NetworkManager.Device.Team</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Generic">org.freedesktop.NetworkManager.Device.Generic</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Vlan">org.freedesktop.NetworkManager.Device.Vlan</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Adsl">org.freedesktop.NetworkManager.Device.Adsl</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.WiMax.Nsp">org.freedesktop.NetworkManager.WiMax.Nsp</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP4Config">org.freedesktop.NetworkManager.IP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP6Config">org.freedesktop.NetworkManager.IP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP4Config">org.freedesktop.NetworkManager.DHCP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP6Config">org.freedesktop.NetworkManager.DHCP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings">org.freedesktop.NetworkManager.Settings</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings.Connection">org.freedesktop.NetworkManager.Settings.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Connection.Active">org.freedesktop.NetworkManager.Connection.Active</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AgentManager">org.freedesktop.NetworkManager.AgentManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.SecretAgent">org.freedesktop.NetworkManager.SecretAgent</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Connection">org.freedesktop.NetworkManager.VPN.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Plugin">org.freedesktop.NetworkManager.VPN.Plugin</a></code></li></ul> <h1><a name="org.freedesktop.NetworkManager" id="org.freedesktop.NetworkManager"></a>org.freedesktop.NetworkManager</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetDevices" id="org.freedesktop.NetworkManager.GetDevices">GetDevices</a> ( ) → @@ -140,17 +140,22 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ Activate a connection using the supplied device. </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - <code>o</code></dt><dd> - The connection to activate the devices with. + The connection to activate. If "/" is given, a valid device path must + be given, and NetworkManager picks the best connection to activate for + the given device. VPN connections must always pass a valid connection + path. </dd><dt><code>device</code> - <code>o</code></dt><dd> - The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use. + The object path of device to be activated for physical connections. + This parameter is ignored for VPN connections, because the + specific_object (if provided) specifies the device to use. </dd><dt><code>specific_object</code> - <code>o</code></dt><dd> The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan - list, or "/" to pick and AP automatically. For VPN connections, pass + list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device. @@ -254,13 +259,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <code>s</code></dt><dd> A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations - related to that domain. Available domains are: [HW, RFKILL, ETHER, + related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, - OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN]. In addition to - these domains, the following special domains can be used: [NONE, ALL, - DEFAULT, DHCP, IP]. If an empty string is given, the log level is - changed but the current set of log domains remains unchanged. + OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, + TEAM, CONCHECK, DCB, DISPATCH]. + In addition to these domains, the following special domains can be used: + [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains + should log at a different level from the default by appending a colon (':') + and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the + log level is changed but the current set of log domains remains + unchanged. </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetLogging" id="org.freedesktop.NetworkManager.GetLogging">GetLogging</a> ( ) → @@ -328,7 +337,11 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </div><div><h4>Parameters</h4><dl><dt><code>device_path</code> - <code>o</code></dt><dd> The object path of the device that was just removed. - </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>NetworkingEnabled</code> - + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Devices</code> - + <code>ao</code> - + <code>(read)</code></dt><dd> + The list of network devices/interfaces NetworkManager knows about. + </dd><dt><code>NetworkingEnabled</code> - <code>b</code> - <code>(read)</code></dt><dd> Indicates if overall networking is currently enabled or not. See the @@ -376,6 +389,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ The object path of an active connection that is currently being activated and which is expected to become the new PrimaryConnection when it finishes activating. + </dd><dt><code>Startup</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + Indicates whether NM is still starting up; this becomes FALSE + when NM has finished attempting to activate every connection + that it might be able to activate at startup. </dd><dt><code>Version</code> - <code>s</code> - <code>(read)</code></dt><dd> @@ -534,9 +553,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dt><dd> Flags describing the capabilities of the device. </dd><dt><code>Ip4Address</code> - - <code>i</code> - + <code>u</code> - <code>(read)</code></dt><dd> - The IPv4 address bound to the device. FIXME: what about devices with >1 IP address? + DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object instead. </dd><dt><code>State</code> - <code>u</code> - <code>(read)</code> @@ -600,6 +619,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <code>ao</code> - <code>(read)</code></dt><dd> An array of object paths of every configured connection that is currently 'available' through this device. + </dd><dt><code>PhysicalPortId</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + If non-empty, an (opaque) indicator of the physical network + port associated with the device. This can be used to recognize + when two seemingly-separate hardware devices are actually just + different virtual interfaces to the same physical port. + </dd><dt><code>Mtu</code> - + <code>u</code> - + <code>(read)</code></dt><dd> + The device MTU (maximum transmission unit). </dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_DEVICE_STATE" id="type-NM_DEVICE_STATE">NM_DEVICE_STATE</a></h3><dl><dt><code>NM_DEVICE_STATE_UNKNOWN = 0</code></dt><dd> The device is in an unknown state. </dd><dt><code>NM_DEVICE_STATE_UNMANAGED = 10</code></dt><dd> @@ -652,6 +682,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ The device is an ADSL device supporting PPPoE and PPPoATM protocols. </dd><dt><code>NM_DEVICE_TYPE_BRIDGE = 13</code></dt><dd> The device is a bridge interface. + </dd><dt><code>NM_DEVICE_TYPE_GENERIC = 14</code></dt><dd> + The device is a generic interface type unrecognized by NetworkManager. + </dd><dt><code>NM_DEVICE_TYPE_TEAM = 15</code></dt><dd> + The device is a team master interface. </dd></dl><h3><a name="type-NM_DEVICE_STATE_REASON" id="type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a></h3><dl><dt><code>NM_DEVICE_STATE_REASON_UNKNOWN = 0</code></dt><dd> The reason for the device state change is unknown. </dd><dt><code>NM_DEVICE_STATE_REASON_NONE = 1</code></dt><dd> @@ -762,6 +796,16 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ The 802.11 Wi-Fi network could not be found. </dd><dt><code>NM_DEVICE_STATE_REASON_SECONDARY_CONNECTION_FAILED = 54</code></dt><dd> A secondary connection of the base connection failed. + </dd><dt><code>NM_DEVICE_STATE_REASON_DCB_FCOE_FAILED = 55</code></dt><dd> + DCB or FCoE setup failed. + </dd><dt><code>NM_DEVICE_STATE_REASON_TEAMD_CONTROL_FAILED = 56</code></dt><dd> + teamd control failed. + </dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_FAILED = 57</code></dt><dd> + Modem failed or no longer available. + </dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_AVAILABLE = 58</code></dt><dd> + Modem now ready and available. + </dd><dt><code>NM_DEVICE_STATE_REASON_SIM_PIN_INCORRECT = 59</code></dt><dd> + The SIM PIN was incorrect. </dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_DEVICE_CAP" id="type-NM_DEVICE_CAP">NM_DEVICE_CAP</a></h3><dl><dt><code>NM_DEVICE_CAP_NONE = 0x0</code></dt><dd>Null capability.</dd><dt><code>NM_DEVICE_CAP_NM_SUPPORTED = 0x1</code></dt><dd>The device is supported by NetworkManager.</dd><dt><code>NM_DEVICE_CAP_CARRIER_DETECT = 0x2</code></dt><dd>The device supports carrier detection.</dd></dl><h2>Structure types:</h2><div class="struct"><h3><a name="type-NM_DEVICE_STATE_REASON_STRUCT" id="type-NM_DEVICE_STATE_REASON_STRUCT">NM_DEVICE_STATE_REASON_STRUCT</a> - ( u: state, u: reason ) @@ -807,10 +851,22 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ ) → ao</h3><div class="docstring"> - Get the list of access points visible to this device. + DEPRECATED. Get the list of access points visible to this device. Note + that this list does not include access points which hide their SSID. To + retrieve a list of all access points (including hidden ones) use the + GetAllAccessPoints() method. + </div><div><h4>Returns</h4><dl><dt><code>access_points</code> - + <code>ao</code></dt><dd> + List of access point object paths. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.GetAllAccessPoints" id="org.freedesktop.NetworkManager.Device.Wireless.GetAllAccessPoints">GetAllAccessPoints</a> ( + + ) → + ao</h3><div class="docstring"> + Get the list of all access points visible to this device, including + hidden ones for which the SSID is not yet known. </div><div><h4>Returns</h4><dl><dt><code>access_points</code> - <code>ao</code></dt><dd> - List of access point object paths + List of access point object paths. </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.RequestScan" id="org.freedesktop.NetworkManager.Device.Wireless.RequestScan">RequestScan</a> ( a{sv}: options ) → @@ -860,6 +916,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <code>u</code> - <code>(read)</code></dt><dd> The bit rate currently used by the wireless device, in kilobits/second (Kb/s). + </dd><dt><code>AccessPoints</code> - + <code>ao</code> - + <code>(read)</code></dt><dd> + List of object paths of access point visible to this wireless device. </dd><dt><code>ActiveAccessPoint</code> - <code>o</code> - <code>(read)</code></dt><dd> @@ -992,7 +1052,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </div><div><h4>Parameters</h4><dl><dt><code>nsp</code> - <code>o</code></dt><dd> The object path of the NSP that has disappeared. - </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> - + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Nsps</code> - + <code>ao</code> - + <code>(read)</code></dt><dd> + List of object paths of Network Service Providers (NSPs) visible to this + WiMAX device. + </dd><dt><code>HwAddress</code> - <code>s</code> - <code>(read)</code></dt><dd> Hardware address of the device. @@ -1093,6 +1158,45 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ slaved to this device. </dd></dl> + <h1><a name="org.freedesktop.NetworkManager.Device.Team" id="org.freedesktop.NetworkManager.Device.Team"></a>org.freedesktop.NetworkManager.Device.Team</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Team.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Team.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + Hardware address of the device. + </dd><dt><code>Carrier</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). + </dd><dt><code>Slaves</code> - + <code>ao</code> - + <code>(read)</code></dt><dd> + Array of object paths representing devices which are currently + slaved to this device. + </dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.Device.Generic" id="org.freedesktop.NetworkManager.Device.Generic"></a>org.freedesktop.NetworkManager.Device.Generic</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Generic.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Generic.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + Hardware address of the device. + </dd><dt><code>TypeDescription</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + A (non-localized) description of the interface type, if known. + </dd></dl> + <h1><a name="org.freedesktop.NetworkManager.Device.Vlan" id="org.freedesktop.NetworkManager.Device.Vlan"></a>org.freedesktop.NetworkManager.Device.Vlan</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Vlan.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Vlan.PropertiesChanged">PropertiesChanged</a> ( a{sv}: properties )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - @@ -1146,34 +1250,56 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ Network type of the NSP. <dl><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN = 0x0</code></dt><dd>Unknown network.</dd><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_HOME = 0x1</code></dt><dd>Home network.</dd><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_PARTNER = 0x2</code></dt><dd>Partner network.</dd><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER = 0x3</code></dt><dd>Roaming partner network.</dd></dl> - <h1><a name="org.freedesktop.NetworkManager.IP4Config" id="org.freedesktop.NetworkManager.IP4Config"></a>org.freedesktop.NetworkManager.IP4Config</h1><p>Interface has no methods.</p><p>Interface has no signals.</p><h2>Properties:</h2><dl><dt><code>Addresses</code> - + <h1><a name="org.freedesktop.NetworkManager.IP4Config" id="org.freedesktop.NetworkManager.IP4Config"></a>org.freedesktop.NetworkManager.IP4Config</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.IP4Config.PropertiesChanged" id="org.freedesktop.NetworkManager.IP4Config.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Gateway</code> - + <code>s</code> - + <code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Addresses</code> - <code>aau</code> - <code>(read)</code></dt><dd>Array of tuples of IPv4 address/prefix/gateway. All 3 elements of each tuple are in network byte order. Essentially: [(addr, prefix, gateway), (addr, prefix, gateway), ...] - </dd><dt><code>Nameservers</code> - - <code>au</code> - - <code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>WinsServers</code> - - <code>au</code> - - <code>(read)</code></dt><dd>The Windows Internet Name Service servers associated with the connection. Each address is in network byte order.</dd><dt><code>Domains</code> - - <code>as</code> - - <code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Routes</code> - + </dd><dt><code>Routes</code> - <code>aau</code> - <code>(read)</code></dt><dd>Tuples of IPv4 route/prefix/next-hop/metric. All 4 elements of each tuple are in network byte order. 'route' and 'next hop' are IPv4 addresses, while prefix and metric are simple unsigned integers. Essentially: [(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), ...] - </dd></dl> + </dd><dt><code>Nameservers</code> - + <code>au</code> - + <code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>Domains</code> - + <code>as</code> - + <code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Searches</code> - + <code>as</code> - + <code>(read)</code></dt><dd>A list of dns searches.</dd><dt><code>WinsServers</code> - + <code>au</code> - + <code>(read)</code></dt><dd>The Windows Internet Name Service servers associated with the connection. Each address is in network byte order.</dd></dl> - <h1><a name="org.freedesktop.NetworkManager.IP6Config" id="org.freedesktop.NetworkManager.IP6Config"></a>org.freedesktop.NetworkManager.IP6Config</h1><p>Interface has no methods.</p><p>Interface has no signals.</p><h2>Properties:</h2><dl><dt><code>Addresses</code> - + <h1><a name="org.freedesktop.NetworkManager.IP6Config" id="org.freedesktop.NetworkManager.IP6Config"></a>org.freedesktop.NetworkManager.IP6Config</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.IP6Config.PropertiesChanged" id="org.freedesktop.NetworkManager.IP6Config.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Gateway</code> - + <code>s</code> - + <code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Addresses</code> - <code>a(ayuay)</code> - - <code>(read)</code></dt><dd>Tuples of IPv6 address/prefix/gateway.</dd><dt><code>Nameservers</code> - + <code>(read)</code></dt><dd>Tuples of IPv6 address/prefix/gateway.</dd><dt><code>Routes</code> - + <code>a(ayuayu)</code> - + <code>(read)</code></dt><dd>Tuples of IPv6 route/prefix/next-hop/metric.</dd><dt><code>Nameservers</code> - <code>aay</code> - <code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>Domains</code> - <code>as</code> - - <code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Routes</code> - - <code>a(ayuayu)</code> - - <code>(read)</code></dt><dd>Tuples of IPv6 route/prefix/next-hop/metric.</dd></dl> + <code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Searches</code> - + <code>as</code> - + <code>(read)</code></dt><dd>A list of dns searches.</dd></dl> <h1><a name="org.freedesktop.NetworkManager.DHCP4Config" id="org.freedesktop.NetworkManager.DHCP4Config"></a>org.freedesktop.NetworkManager.DHCP4Config</h1> Options and configuration returned by the IPv4 DHCP server. @@ -1236,6 +1362,62 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dd></dl></div><div><h4>Returns</h4><dl><dt><code>path</code> - <code>o</code></dt><dd> Object path of the new connection that was just added. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.AddConnectionUnsaved" id="org.freedesktop.NetworkManager.Settings.AddConnectionUnsaved">AddConnectionUnsaved</a> ( + a{sa{sv}}: connection + ) → + o</h3><div class="docstring"> + Add new connection but do not save it to disk immediately. This + operation does not start the network connection unless (1) device is + idle and able to connect to the network described by the new connection, + and (2) the connection is allowed to be started automatically. + + Use the 'Save' method on the connection to save these changes + to disk. Note that unsaved changes will be lost if the + connection is reloaded from disk (either automatically on file + change or due to an explicit ReloadConnections call). + </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - + <code>a{sa{sv}}</code></dt><dd> + Connection settings and properties. + </dd></dl></div><div><h4>Returns</h4><dl><dt><code>path</code> - + <code>o</code></dt><dd> + Object path of the new connection that was just added. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.LoadConnections" id="org.freedesktop.NetworkManager.Settings.LoadConnections">LoadConnections</a> ( + as: filenames + ) → + b, as</h3><div class="docstring"> + Loads or reloads the indicated connections from disk. You + should call this after making changes directly to an on-disk + connection file to make sure that NetworkManager sees the + changes. (If "monitor-connection-files" in NetworkManager.conf + is "true", then this will have no real effect, but is + harmless.) As with AddConnection(), this operation does not + necessarily start the network connection. + </div><div><h4>Parameters</h4><dl><dt><code>filenames</code> - + <code>as</code></dt><dd> + Array of paths to on-disk connection profiles in directories + monitored by NetworkManager. + </dd></dl></div><div><h4>Returns</h4><dl><dt><code>status</code> - + <code>b</code></dt><dd> + Success or failure of the operation as a whole. True if + NetworkManager at least tried to load the indicated + connections, even if it did not succeed. False if an error + occurred before trying to load the connections (eg, + permission denied). + </dd><dt><code>failures</code> - + <code>as</code></dt><dd> + Paths of connection files that could not be loaded. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.ReloadConnections" id="org.freedesktop.NetworkManager.Settings.ReloadConnections">ReloadConnections</a> ( + + ) → + b</h3><div class="docstring"> + Tells NetworkManager to reload all connection files from disk, + including noticing any added or deleted connection files. By + default, connections are re-read automatically any time they + change, so you only need to use this command if you have set + "monitor-connection-files=false" in NetworkManager.conf. + </div><div><h4>Returns</h4><dl><dt><code>status</code> - + <code>b</code></dt><dd> + Success or failure. </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.SaveHostname" id="org.freedesktop.NetworkManager.Settings.SaveHostname">SaveHostname</a> ( s: hostname ) → @@ -1265,7 +1447,22 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - <code>o</code></dt><dd> Object path of the new connection. - </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Hostname</code> - + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.ConnectionRemoved" id="org.freedesktop.NetworkManager.Settings.ConnectionRemoved">ConnectionRemoved</a> ( + o: connection + )</h3><div class="docstring"> + Emitted when a connection is no longer available. This happens when + the connection is deleted or if it is no longer accessible by any of + the system's logged-in users. After receipt of this signal, the + connection no longer exists and cannot be used. Also see the + Settings.Connection.Removed signal. + </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - + <code>o</code></dt><dd> + Object path of the removed connection. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Connections</code> - + <code>ao</code> - + <code>(read)</code></dt><dd> + List of object paths of available network connection profiles. + </dd><dt><code>Hostname</code> - <code>s</code> - <code>(read)</code></dt><dd> The machine hostname stored in persistent configuration. @@ -1282,10 +1479,28 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ a{sa{sv}}: properties ) → nothing</h3><div class="docstring"> - Update the connection with new settings and properties, replacing - all previous settings and properties. Secrets may be part of the - update request, and will be either stored in persistent storage or - given to a Secret Agent for storage, depending on the request. + Update the connection with new settings and properties (replacing + all previous settings and properties) and save the connection to + disk. Secrets may be part of the update request, and will be either + stored in persistent storage or sent to a Secret Agent for storage, + depending on the flags associated with each secret. + </div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sa{sv}}</code></dt><dd> + New connection settings, properties, and (optionally) secrets. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.UpdateUnsaved" id="org.freedesktop.NetworkManager.Settings.Connection.UpdateUnsaved">UpdateUnsaved</a> ( + a{sa{sv}}: properties + ) → + nothing</h3><div class="docstring"> + Update the connection with new settings and properties (replacing + all previous settings and properties) but do not immediately save + the connection to disk. Secrets may be part of the update request + and may sent to a Secret Agent for storage, depending on the + flags associated with each secret. + + Use the 'Save' method to save these changes to disk. Note + that unsaved changes will be lost if the connection is + reloaded from disk (either automatically on file change or + due to an explicit ReloadConnections call). </div><div><h4>Parameters</h4><dl><dt><code>properties</code> - <code>a{sa{sv}}</code></dt><dd> New connection settings, properties, and (optionally) secrets. @@ -1324,7 +1539,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) </dt><dd> Nested settings maps containing secrets. - </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Updated" id="org.freedesktop.NetworkManager.Settings.Connection.Updated">Updated</a> ( + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Save" id="org.freedesktop.NetworkManager.Settings.Connection.Save">Save</a> ( + + ) → + nothing</h3><div class="docstring"> + Saves a "dirty" connection (that had previously been + updated with UpdateUnsaved) to persistent storage. + </div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Updated" id="org.freedesktop.NetworkManager.Settings.Connection.Updated">Updated</a> ( )</h3><div class="docstring"> Emitted when any settings or permissions change. When handling @@ -1336,9 +1557,25 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ )</h3><div class="docstring"> Emitted when this connection is no longer available. This happens when the connection is deleted or if it is no longer - accessable by any of the system's logged-in users. After - receipt of this signal, the object no longer exists. - </div></div><p>Interface has no properties.</p> + accessible by any of the system's logged-in users. After + receipt of this signal, the object no longer exists. Also + see the Settings.ConnectionRemoved signal. + </div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.PropertiesChanged" id="org.freedesktop.NetworkManager.Settings.Connection.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Unsaved</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + If set, indicates that the in-memory state of the + connection does not match the on-disk state. This flag + will be set when UpdateUnsaved() is called or when any + connection details change, and cleared when the connection + is saved to disk via Save() or from internal operations. + </dd></dl> <h1><a name="org.freedesktop.NetworkManager.Connection.Active" id="org.freedesktop.NetworkManager.Connection.Active"></a>org.freedesktop.NetworkManager.Connection.Active</h1> @@ -1356,32 +1593,85 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ A dictionary mapping property names to variant boxed values </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Connection</code> - <code>o</code> - - <code>(read)</code></dt><dd>The path of the connection.</dd><dt><code>SpecificObject</code> - + <code>(read)</code></dt><dd> + The path of the connection. + </dd><dt><code>SpecificObject</code> - <code>o</code> - <code>(read)</code></dt><dd> A specific object associated with the active connection. This property reflects the specific object used during connection activation, and will not change over the lifetime of the ActiveConnection once set. + </dd><dt><code>Id</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + The ID of the connection, provided as a convenience so that clients + do not have to retrieve all connection details. </dd><dt><code>Uuid</code> - <code>s</code> - <code>(read)</code></dt><dd> The UUID of the connection, provided as a convenience so that clients do not have to retrieve all connection details. + </dd><dt><code>Type</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + The type of the connection, provided as a convenience so that clients + do not have to retrieve all connection details. </dd><dt><code>Devices</code> - <code>ao</code> - - <code>(read)</code></dt><dd>Array of object paths representing devices which are part of this active connection.</dd><dt><code>State</code> - + <code>(read)</code></dt><dd> + Array of object paths representing devices which are part of this active + connection. + </dd><dt><code>State</code> - <code>u</code> - <code>(read)</code> (<a xmlns="" href="#type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a>) - </dt><dd>The state of this active connection.</dd><dt><code>Default</code> - + </dt><dd> + The state of this active connection. + </dd><dt><code>Default</code> - <code>b</code> - - <code>(read)</code></dt><dd>Whether this active connection is the default IPv4 connection, i.e. whether it currently owns the default IPv4 route.</dd><dt><code>Default6</code> - + <code>(read)</code></dt><dd> + Whether this active connection is the default IPv4 connection, i.e. + whether it currently owns the default IPv4 route. + </dd><dt><code>Ip4Config</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the Ip4Config object describing the configuration of the + connection. Only valid when the connection is in the + NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. + </dd><dt><code>Dhcp4Config</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the Dhcp4Config object describing the DHCP options + returned by the DHCP server (assuming the connection used DHCP). Only + valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED + state. + </dd><dt><code>Default6</code> - <code>b</code> - - <code>(read)</code></dt><dd>Whether this active connection is the default IPv6 connection, i.e. whether it currently owns the default IPv6 route.</dd><dt><code>Vpn</code> - + <code>(read)</code></dt><dd> + Whether this active connection is the default IPv6 connection, i.e. + whether it currently owns the default IPv6 route. + </dd><dt><code>Ip6Config</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the Ip6Config object describing the configuration of the + connection. Only valid when the connection is in the + NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. + </dd><dt><code>Dhcp6Config</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the Dhcp6Config object describing the DHCP options + returned by the DHCP server (assuming the connection used DHCP). Only + valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED + state. + </dd><dt><code>Vpn</code> - <code>b</code> - - <code>(read)</code></dt><dd>Whether this active connection is also a VPN connection.</dd><dt><code>Master</code> - + <code>(read)</code></dt><dd> + Whether this active connection is also a VPN connection. + </dd><dt><code>Master</code> - <code>o</code> - - <code>(read)</code></dt><dd>The path to the master device if the connection is a slave.</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_ACTIVE_CONNECTION_STATE" id="type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a></h3><dl><dt><code>NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0</code></dt><dd> + <code>(read)</code></dt><dd> + The path to the master device if the connection is a slave. + </dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_ACTIVE_CONNECTION_STATE" id="type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a></h3><dl><dt><code>NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0</code></dt><dd> The active connection is in an unknown state. </dd><dt><code>NM_ACTIVE_CONNECTION_STATE_ACTIVATING = 1</code></dt><dd> The connection is activating. @@ -1408,6 +1698,19 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ 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). + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AgentManager.RegisterWithCapabilities" id="org.freedesktop.NetworkManager.AgentManager.RegisterWithCapabilities">RegisterWithCapabilities</a> ( + s: identifier, u: capabilities + ) → + nothing</h3><div class="docstring"> + Like Register() but indicates agent capabilities to NetworkManager. + </div><div><h4>Parameters</h4><dl><dt><code>identifier</code> - + <code>s</code></dt><dd> + See the Register() method's identifier argument. + </dd><dt><code>capabilities</code> - + <code>u</code> + (<a xmlns="" href="#type-NM_SECRET_AGENT_CAPABILITIES">NM_SECRET_AGENT_CAPABILITIES</a>) + </dt><dd> + Indicates various agent capabilities to NetworkManager. </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AgentManager.Unregister" id="org.freedesktop.NetworkManager.AgentManager.Unregister">Unregister</a> ( ) → @@ -1426,7 +1729,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ itself and should not expect its SaveSecrets() method to be called. SaveSecrets() will be called eg if some program other than the agent itself (like a connection editor) changes the secrets out of - band. + band. The agent should implement this D-Bus interface on an object + with the path /org/freedesktop/NetworkManager/SecretAgent. <h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.SecretAgent.GetSecrets" id="org.freedesktop.NetworkManager.SecretAgent.GetSecrets">GetSecrets</a> ( a{sa{sv}}: connection, o: connection_path, s: setting_name, as: hints, u: flags ) → @@ -1436,7 +1740,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ and the user enters new secrets, the agent is expected to save the new secrets to persistent storage (if the secret's flags include AGENT_OWNED) as NetworkManager will not send these - secrets back to the same agent via a SaveSecrets() call. + secrets back to the same agent via a SaveSecrets() call. If + the user canceled any interaction, the agent should return the + UserCanceled error (see below). </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - <code>a{sa{sv}}</code> (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) @@ -1463,7 +1769,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends - in this request. + in this request. Some hints have special prefixes that + provide information to the agent; for example, VPN requests + may send server-specific messages prefixed with + "x-vpn-message:". </dd><dt><code>flags</code> - <code>u</code> (<a xmlns="" href="#type-NM_SECRET_AGENT_GET_SECRETS_FLAGS">NM_SECRET_AGENT_GET_SECRETS_FLAGS</a>) @@ -1480,7 +1789,25 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets. - </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.SecretAgent.CancelGetSecrets" id="org.freedesktop.NetworkManager.SecretAgent.CancelGetSecrets">CancelGetSecrets</a> ( + </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.SecretAgent.NotAuthorized</code></dt><dd> + Should be returned when the process requesting secrets is + not authorized to do so (like if the caller is not root + or not NetworkManager). + </dd><dt><code>org.freedesktop.NetworkManager.SecretAgent.InvalidConnection</code></dt><dd> + Should be returned if the 'connection' argument is invalid. + </dd><dt><code>org.freedesktop.NetworkManager.SecretAgent.UserCanceled</code></dt><dd> + Should be returned when the user has canceled the request. + </dd><dt><code>org.freedesktop.NetworkManager.SecretAgent.AgentCanceled</code></dt><dd> + Should be returned when NetworkManager has requested that + the agent cancel the request. + </dd><dt><code>org.freedesktop.NetworkManager.SecretAgent.InternalError</code></dt><dd> + Should be returned if the agent has encountered some internal + error processing the request. + </dd><dt><code>org.freedesktop.NetworkManager.SecretAgent.NoSecrets</code></dt><dd> + Should be returned if there are no available secrets, for + example if user interaction is not allowed and there are + no secrets stored by the agent for this connection. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.SecretAgent.CancelGetSecrets" id="org.freedesktop.NetworkManager.SecretAgent.CancelGetSecrets">CancelGetSecrets</a> ( o: connection_path, s: setting_name ) → nothing</h3><div class="docstring"> @@ -1551,7 +1878,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ D-Bus interface, as opposed to automatically initiated by NetworkManager in response to (for example) scan results or carrier changes. - </dd></dl> + </dd></dl><h3 xmlns=""><a name="type-NM_SECRET_AGENT_CAPABILITIES" id="type-NM_SECRET_AGENT_CAPABILITIES">NM_SECRET_AGENT_CAPABILITIES</a></h3><dl><dt><code>NM_SECRET_AGENT_CAPABILITY_NONE = 0x0</code></dt><dd>No special capabilities.</dd><dt><code>NM_SECRET_AGENT_CAPABILITY_VPN_HINTS = 0x1</code></dt><dd> + The agent supports passing hints to VPN plugin authentication + dialogs. + </dd></dl> <h1><a name="org.freedesktop.NetworkManager.VPN.Connection" id="org.freedesktop.NetworkManager.VPN.Connection"></a>org.freedesktop.NetworkManager.VPN.Connection</h1> @@ -1631,13 +1961,67 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ a{sa{sv}}: connection ) → nothing</h3><div class="docstring"> - Tells the plugin to connect. + Tells the plugin to connect. Interactive secrets requests (eg, emitting + the SecretsRequired signal) are not allowed. + </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - + <code>a{sa{sv}}</code> + (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) + </dt><dd> + Describes the connection to be established. + </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</code></dt><dd> + The plugin is already starting, and another connect request was received. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</code></dt><dd> + The plugin is already connected, and another connect request was received. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd> + The plugin is already stopping, and another stop request was received. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.BadArguments</code></dt><dd> + The request could not be processed because it contained malformed + arguments, or arguments of unexpected type. It usually means that one of + the VPN setting data items or secrets was not of the expected type (i.e. + int, string, bool, etc). + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</code></dt><dd> + A binary providing the service failed to launch. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.WrongState</code></dt><dd> + The request could not be processed because the VPN plugin is in the wrong + state for this type of request. + <em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.ConnectInteractive" id="org.freedesktop.NetworkManager.VPN.Plugin.ConnectInteractive">ConnectInteractive</a> ( + a{sa{sv}}: connection, a{sv}: details + ) → + nothing</h3><div class="docstring"> + Tells the plugin to connect, allowing interactive secrets requests (eg + the plugin is allowed to emit the SecretsRequired signal if the VPN + service indicates that it needs additional secrets during the connect + process). </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - <code>a{sa{sv}}</code> (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) </dt><dd> Describes the connection to be established. - </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</code></dt><dd>The request could not be processed because the VPN connection is already being started.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</code></dt><dd>The request could not be processed because a VPN connection was already active.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd>The request could not be processed because the VPN connection is already being stopped.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.BadArguments</code></dt><dd>Invalid arguments were passed with the request. FIXME: too general.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</code></dt><dd>A binary providing the service failed to launch.<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets" id="org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets">NeedSecrets</a> ( + </dd><dt><code>details</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + Additional details about the Connect process. + </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</code></dt><dd> + The plugin is already starting, and another connect request was received. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</code></dt><dd> + The plugin is already connected, and another connect request was received. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd> + The plugin is already stopping, and another stop request was received. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.BadArguments</code></dt><dd> + The request could not be processed because it contained malformed + arguments, or arguments of unexpected type. It usually means that one of + the VPN setting data items or secrets was not of the expected type (i.e. + int, string, bool, etc). + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</code></dt><dd> + A binary providing the service failed to launch. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.WrongState</code></dt><dd> + The request could not be processed because the VPN plugin is in the wrong + state for this type of request. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported</code></dt><dd> + The request could not be processed because the plugin does not support + interactive operations, such as ConnectInteractive() or NewSecrets(). + <em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets" id="org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets">NeedSecrets</a> ( a{sa{sv}}: settings ) → s</h3><div class="docstring"> @@ -1650,12 +2034,20 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dd></dl></div><div><h4>Returns</h4><dl><dt><code>setting_name</code> - <code>s</code></dt><dd> The setting name within the provided connection that requires secrets, if any. - </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid</code></dt><dd>The request could not be processed because the VPN connection settings were invalid.<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Disconnect" id="org.freedesktop.NetworkManager.VPN.Plugin.Disconnect">Disconnect</a> ( + </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid</code></dt><dd> + The request could not be processed because the connection was invalid. It + usually means that the connection's VPN setting was missing some required + data item or secret. + <em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Disconnect" id="org.freedesktop.NetworkManager.VPN.Plugin.Disconnect">Disconnect</a> ( ) → nothing</h3><div class="docstring"> Disconnect the plugin. - </div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd>The request could not be processed because the VPN connection is already being stopped.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped</code></dt><dd>The request could not be processed because the VPN connection was already stopped.<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SetConfig" id="org.freedesktop.NetworkManager.VPN.Plugin.SetConfig">SetConfig</a> ( + </div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd> + The plugin is already stopping, and another stop request was received. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped</code></dt><dd> + The plugin is already stopped, and another disconnect request was received. + <em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SetConfig" id="org.freedesktop.NetworkManager.VPN.Plugin.SetConfig">SetConfig</a> ( a{sv}: config ) → nothing</h3><div class="docstring"> @@ -1695,7 +2087,31 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </div><div><h4>Parameters</h4><dl><dt><code>reason</code> - <code>s</code></dt><dd> The reason for the failure. - </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.StateChanged" id="org.freedesktop.NetworkManager.VPN.Plugin.StateChanged">StateChanged</a> ( + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.NewSecrets" id="org.freedesktop.NetworkManager.VPN.Plugin.NewSecrets">NewSecrets</a> ( + a{sa{sv}}: connection + ) → + nothing</h3><div class="docstring"> + Called in response to a SecretsRequired signal to deliver updated secrets + or other information to the plugin. + </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - + <code>a{sa{sv}}</code> + (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) + </dt><dd> + Describes the connection including the new secrets. + </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.WrongState</code></dt><dd> + The request could not be processed because the VPN plugin is in the wrong + state for this type of request. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.BadArguments</code></dt><dd> + The request could not be processed because it contained malformed + arguments, or arguments of unexpected type. It usually means that one of + the VPN setting data items or secrets was not of the expected type (i.e. + int, string, bool, etc). + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</code></dt><dd> + A binary providing the service failed to launch. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported</code></dt><dd> + The request could not be processed because the plugin does not support + interactive operations, such as ConnectInteractive() or NewSecrets(). + <em>(generic description)</em></dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.StateChanged" id="org.freedesktop.NetworkManager.VPN.Plugin.StateChanged">StateChanged</a> ( u: state )</h3><div class="docstring"> Emitted when the plugin state changes. @@ -1704,7 +2120,24 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ (<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>) </dt><dd> The new state of the plugin. - </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Config" id="org.freedesktop.NetworkManager.VPN.Plugin.Config">Config</a> ( + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SecretsRequired" id="org.freedesktop.NetworkManager.VPN.Plugin.SecretsRequired">SecretsRequired</a> ( + s: message, as: secrets + )</h3><div class="docstring"> + Emitted during an ongoing ConnectInteractive() request when the plugin + has determined that new secrets are required. NetworkManager will then + call the NewSecrets() method with a connection hash including the new + secrets. + </div><div><h4>Parameters</h4><dl><dt><code>message</code> - + <code>s</code></dt><dd> + Informational message, if any, about the request. For example, if + a second PIN is required, could indicate to the user to wait for + the token code to change until entering the next PIN. + </dd><dt><code>secrets</code> - + <code>as</code></dt><dd> + Array of strings of VPN secret names which the plugin thinks + secrets may be required for, or other VPN-specific data to be + processed by the VPN's front-end. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Config" id="org.freedesktop.NetworkManager.VPN.Plugin.Config">Config</a> ( a{sv}: config )</h3><div class="docstring"> The plugin obtained generic configuration information. @@ -1807,16 +2240,42 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <h1>Errors:</h1> - <h2><a name="org.freedesktop.NetworkManager.VPN.Error.General" id="org.freedesktop.NetworkManager.VPN.Error.General"></a>org.freedesktop.NetworkManager.VPN.Error.General</h2>This is a drab, nondescript error. - <h2><a name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress" id="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"></a>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</h2>The request could not be processed because the VPN connection is already being started. - <h2><a name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted" id="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"></a>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</h2>The request could not be processed because a VPN connection was already active. - <h2><a name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress" id="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"></a>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</h2>The request could not be processed because the VPN connection is already being stopped. - <h2><a name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped" id="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped"></a>org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped</h2>The request could not be processed because the VPN connection was already stopped. - <h2><a name="org.freedesktop.NetworkManager.VPN.Error.WrongState" id="org.freedesktop.NetworkManager.VPN.Error.WrongState"></a>org.freedesktop.NetworkManager.VPN.Error.WrongState</h2>The request could not be processed because the VPN connection is in the wrong state for this type of request. FIXME: too general? - <h2><a name="org.freedesktop.NetworkManager.VPN.Error.BadArguments" id="org.freedesktop.NetworkManager.VPN.Error.BadArguments"></a>org.freedesktop.NetworkManager.VPN.Error.BadArguments</h2>Invalid arguments were passed with the request. FIXME: too general. - <h2><a name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed" id="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"></a>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</h2>A binary providing the service failed to launch. - <h2><a name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid" id="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"></a>org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid</h2>The request could not be processed because the VPN connection settings were invalid. -<h1>Index</h1><h2>Index of interfaces</h2><ul><li><code><a href="#org.freedesktop.NetworkManager">org.freedesktop.NetworkManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AccessPoint">org.freedesktop.NetworkManager.AccessPoint</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device">org.freedesktop.NetworkManager.Device</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wired">org.freedesktop.NetworkManager.Device.Wired</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wireless">org.freedesktop.NetworkManager.Device.Wireless</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Modem">org.freedesktop.NetworkManager.Device.Modem</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bluetooth">org.freedesktop.NetworkManager.Device.Bluetooth</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.OlpcMesh">org.freedesktop.NetworkManager.Device.OlpcMesh</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.WiMax">org.freedesktop.NetworkManager.Device.WiMax</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Infiniband">org.freedesktop.NetworkManager.Device.Infiniband</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bond">org.freedesktop.NetworkManager.Device.Bond</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bridge">org.freedesktop.NetworkManager.Device.Bridge</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Vlan">org.freedesktop.NetworkManager.Device.Vlan</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Adsl">org.freedesktop.NetworkManager.Device.Adsl</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.WiMax.Nsp">org.freedesktop.NetworkManager.WiMax.Nsp</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP4Config">org.freedesktop.NetworkManager.IP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP6Config">org.freedesktop.NetworkManager.IP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP4Config">org.freedesktop.NetworkManager.DHCP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP6Config">org.freedesktop.NetworkManager.DHCP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings">org.freedesktop.NetworkManager.Settings</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings.Connection">org.freedesktop.NetworkManager.Settings.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Connection.Active">org.freedesktop.NetworkManager.Connection.Active</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AgentManager">org.freedesktop.NetworkManager.AgentManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.SecretAgent">org.freedesktop.NetworkManager.SecretAgent</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Connection">org.freedesktop.NetworkManager.VPN.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Plugin">org.freedesktop.NetworkManager.VPN.Plugin</a></code></li></ul><h2>Index of types</h2><ul><li><code><a href="#type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a></code> + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.General" id="org.freedesktop.NetworkManager.VPN.Error.General"></a>org.freedesktop.NetworkManager.VPN.Error.General</h2>General failure without further details. + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress" id="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"></a>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</h2> + The plugin is already starting, and another connect request was received. + + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted" id="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"></a>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</h2> + The plugin is already connected, and another connect request was received. + + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress" id="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"></a>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</h2> + The plugin is already stopping, and another stop request was received. + + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped" id="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped"></a>org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped</h2> + The plugin is already stopped, and another disconnect request was received. + + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.WrongState" id="org.freedesktop.NetworkManager.VPN.Error.WrongState"></a>org.freedesktop.NetworkManager.VPN.Error.WrongState</h2> + The request could not be processed because the VPN plugin is in the wrong + state for this type of request. + + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.BadArguments" id="org.freedesktop.NetworkManager.VPN.Error.BadArguments"></a>org.freedesktop.NetworkManager.VPN.Error.BadArguments</h2> + The request could not be processed because it contained malformed + arguments, or arguments of unexpected type. It usually means that one of + the VPN setting data items or secrets was not of the expected type (i.e. + int, string, bool, etc). + + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed" id="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"></a>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</h2> + A binary providing the service failed to launch. + + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid" id="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"></a>org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid</h2> + The request could not be processed because the connection was invalid. It + usually means that the connection's VPN setting was missing some required + data item or secret. + + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported" id="org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported"></a>org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported</h2> + The request could not be processed because the plugin does not support + interactive operations, such as ConnectInteractive() or NewSecrets(). + +<h1>Index</h1><h2>Index of interfaces</h2><ul><li><code><a href="#org.freedesktop.NetworkManager">org.freedesktop.NetworkManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AccessPoint">org.freedesktop.NetworkManager.AccessPoint</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device">org.freedesktop.NetworkManager.Device</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wired">org.freedesktop.NetworkManager.Device.Wired</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wireless">org.freedesktop.NetworkManager.Device.Wireless</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Modem">org.freedesktop.NetworkManager.Device.Modem</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bluetooth">org.freedesktop.NetworkManager.Device.Bluetooth</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.OlpcMesh">org.freedesktop.NetworkManager.Device.OlpcMesh</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.WiMax">org.freedesktop.NetworkManager.Device.WiMax</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Infiniband">org.freedesktop.NetworkManager.Device.Infiniband</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bond">org.freedesktop.NetworkManager.Device.Bond</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bridge">org.freedesktop.NetworkManager.Device.Bridge</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Team">org.freedesktop.NetworkManager.Device.Team</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Generic">org.freedesktop.NetworkManager.Device.Generic</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Vlan">org.freedesktop.NetworkManager.Device.Vlan</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Adsl">org.freedesktop.NetworkManager.Device.Adsl</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.WiMax.Nsp">org.freedesktop.NetworkManager.WiMax.Nsp</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP4Config">org.freedesktop.NetworkManager.IP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP6Config">org.freedesktop.NetworkManager.IP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP4Config">org.freedesktop.NetworkManager.DHCP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP6Config">org.freedesktop.NetworkManager.DHCP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings">org.freedesktop.NetworkManager.Settings</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings.Connection">org.freedesktop.NetworkManager.Settings.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Connection.Active">org.freedesktop.NetworkManager.Connection.Active</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AgentManager">org.freedesktop.NetworkManager.AgentManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.SecretAgent">org.freedesktop.NetworkManager.SecretAgent</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Connection">org.freedesktop.NetworkManager.VPN.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Plugin">org.freedesktop.NetworkManager.VPN.Plugin</a></code></li></ul><h2>Index of types</h2><ul><li><code><a href="#type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a></code> - u</li><li><code><a href="#type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a></code> - u</li><li><code><a href="#type-NM_802_11_DEVICE_CAP">NM_802_11_DEVICE_CAP</a></code> - u</li><li><code><a href="#type-NM_802_11_MODE">NM_802_11_MODE</a></code> @@ -1830,6 +2289,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ - u</li><li><code><a href="#type-NM_DEVICE_STATE_REASON_STRUCT">NM_DEVICE_STATE_REASON_STRUCT</a></code> - ( u, u ) </li><li><code><a href="#type-NM_DEVICE_TYPE">NM_DEVICE_TYPE</a></code> + - u</li><li><code><a href="#type-NM_SECRET_AGENT_CAPABILITIES">NM_SECRET_AGENT_CAPABILITIES</a></code> - u</li><li><code><a href="#type-NM_SECRET_AGENT_GET_SECRETS_FLAGS">NM_SECRET_AGENT_GET_SECRETS_FLAGS</a></code> - u</li><li><code><a href="#type-NM_STATE">NM_STATE</a></code> - u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a></code> diff --git a/docs/api/html/style.css b/docs/api/html/style.css index 705a5c9ad..d6f6c26ec 100644 --- a/docs/api/html/style.css +++ b/docs/api/html/style.css @@ -1,23 +1,15 @@ -body -{ - font-family: cantarell, sans-serif; -} .synopsis, .classsynopsis { /* tango:aluminium 1/2 */ background: #eeeeec; - background: rgba(238, 238, 236, 0.5); - border: solid 1px rgb(238, 238, 236); + border: solid 1px #d3d7cf; padding: 0.5em; } .programlisting { /* tango:sky blue 0/1 */ - /* fallback for no rgba support */ background: #e6f3ff; border: solid 1px #729fcf; - background: rgba(114, 159, 207, 0.1); - border: solid 1px rgba(114, 159, 207, 0.2); padding: 0.5em; } .variablelist @@ -35,6 +27,7 @@ body { position: relative; top: 0em ! important; + } /* this is needed so that the local anchors are displayed below the naviagtion */ div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] @@ -53,20 +46,16 @@ body */ body { - padding-top: 5em; - padding-bottom: 500px; - max-width: 60em; - } - p - { - max-width: 60em; + padding-top: 3.2em; + padding-bottom: 20em; } /* style and size the navigation bar */ table.navigation#top { position: fixed; - background: #e2e2e2; - border-bottom: solid 1px #babdb6; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; margin-top: 0; margin-bottom: 0; top: 0; @@ -76,57 +65,21 @@ body } .navigation a, .navigation a:visited { - /* tango:sky blue 3 */ - color: #204a87; + /* tango:scarlet red 3 */ + color: #a40000; } .navigation a:hover { - /* tango:sky blue 2 */ - color: #3465a4; + /* tango:scarlet red 1 */ + color: #ef2929; } td.shortcuts { - /* tango:sky blue 2 */ - color: #3465a4; + /* tango:scarlet red 1 */ + color: #ef2929; font-size: 80%; white-space: nowrap; } - td.shortcuts .dim - { - color: #babdb6; - } -} -@media screen and (min-width: 60em) { - /* screen larger than 60em */ - body { margin: auto; } -} -@media screen and (max-width: 60em) { - /* screen less than 60em */ - #nav_hierarchy { display: none; } - #nav_interfaces { display: none; } - #nav_prerequisites { display: none; } - #nav_derived_interfaces { display: none; } - #nav_implementations { display: none; } - #nav_child_properties { display: none; } - #nav_style_properties { display: none; } - #nav_index { display: none; } - #nav_glossary { display: none; } - .gallery_image { display: none; } - .property_flags { display: none; } - .signal_flags { display: none; } - .parameter_annotations { display: none; } - .enum_member_annotations { display: none; } - .struct_member_annotations { display: none; } - .union_member_annotations { display: none; } - /* now that a column is hidden, optimize space */ - col.parameters_name { width: auto; } - col.parameters_description { width: auto; } - col.struct_members_name { width: auto; } - col.struct_members_description { width: auto; } - col.enum_members_name { width: auto; } - col.enum_members_description { width: auto; } - col.union_members_name { width: auto; } - col.union_members_description { width: auto; } } @media print { table.navigation { @@ -136,8 +89,9 @@ body div.titlepage table.navigation { visibility: visible; display: table; - background: #e2e2e2; - border: solid 1px #babdb6; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; margin-top: 0; margin-bottom: 0; top: 0; @@ -148,7 +102,7 @@ body .navigation .title { - font-size: 120%; + font-size: 200%; } div.gallery-float @@ -178,67 +132,6 @@ a:hover color: #729fcf; } -div.informaltable table -{ - border-collapse: separate; - border-spacing: 20px 3px; - border: none; -} - -div.informaltable table td, div.informaltable table th -{ - vertical-align: top; -} - -.function_type, -.variable_type, -.property_type, -.signal_type, -.parameter_name, -.struct_member_name, -.union_member_name, -.define_keyword, -.datatype_keyword, -.typedef_keyword -{ - text-align: right; -} - -/* dim non-primary columns */ -.c_punctuation, -.function_type, -.variable_type, -.property_type, -.signal_type, -.define_keyword, -.datatype_keyword, -.typedef_keyword, -.property_flags, -.signal_flags, -.parameter_annotations, -.enum_member_annotations, -.struct_member_annotations, -.union_member_annotations -{ - color: #888a85; -} - -.function_type a, -.function_type a:visited, -.function_type a:hover, -.property_type a, -.property_type a:visited, -.property_type a:hover, -.signal_type a, -.signal_type a:visited, -.signal_type a:hover, -.signal_flags a, -.signal_flags a:visited, -.signal_flags a:hover -{ - color: #729fcf; -} - div.table table { border-collapse: collapse; @@ -261,43 +154,14 @@ div.table table th background-color: #d3d7cf; } -h4 -{ - color: #555753; -} - hr { - /* tango:aluminium 1 */ - color: #d3d7cf; - background: #d3d7cf; + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; border: none 0px; height: 1px; clear: both; - margin: 2.0em 0em 2.0em 0em; -} - -dl.toc dt -{ - padding-bottom: 0.25em; -} - -dl.toc > dd > dl > dt -{ - padding-top: 0.25em; - padding-bottom: 0.25em; -} - -dl.toc > dt -{ - padding-top: 1em; - padding-bottom: 0.5em; - font-weight: bold; -} - -.parameter -{ - font-style: normal; } .footer @@ -309,70 +173,31 @@ dl.toc > dt font-size: 80%; } -.informalfigure, -.figure -{ - margin: 1em; -} - -.informalexample, -.example -{ - margin-top: 1em; - margin-bottom: 1em; -} - .warning { /* tango:orange 0/1 */ background: #ffeed9; - background: rgba(252, 175, 62, 0.1); border-color: #ffb04f; - border-color: rgba(252, 175, 62, 0.2); } .note { /* tango:chameleon 0/0.5 */ background: #d8ffb2; - background: rgba(138, 226, 52, 0.1); border-color: #abf562; - border-color: rgba(138, 226, 52, 0.2); } -div.blockquote -{ - border-color: #eeeeec; -} -.note, .warning, div.blockquote +.note, .warning { padding: 0.5em; border-width: 1px; border-style: solid; - margin: 2em; } -.note p, .warning p +.note h3, .warning h3 { - margin: 0; + margin-top: 0.0em } - -div.warning h3.title, -div.note h3.title -{ - display: none; -} - -p + div.section -{ - margin-top: 1em; -} - -div.refnamediv, -div.refsynopsisdiv, -div.refsect1, -div.refsect2, -div.toc, -div.section +.note p, .warning p { - margin-bottom: 1em; + margin-bottom: 0.0em } /* blob links */ @@ -385,22 +210,11 @@ h2 .extralinks, h3 .extralinks font-weight: normal; } -.lineart -{ - color: #d3d7cf; - font-weight: normal; -} - .annotation { /* tango:aluminium 5 */ color: #555753; - font-weight: normal; -} - -.structfield -{ - font-style: normal; + font-size: 80%; font-weight: normal; } @@ -423,7 +237,6 @@ h2 .extralinks, h3 .extralinks .listing_frame { /* tango:sky blue 1 */ border: solid 1px #729fcf; - border: solid 1px rgba(114, 159, 207, 0.2); padding: 0px; } @@ -433,27 +246,19 @@ h2 .extralinks, h3 .extralinks padding: 0.5em; } .listing_lines { - /* this just adds visual clutter and - takes precious room from small screens */ - display: none; -} -.listing_lines { /* tango:sky blue 0.5 */ background: #a6c5e3; - background: rgba(114, 159, 207, 0.2); /* tango:aluminium 6 */ color: #2e3436; } .listing_code { /* tango:sky blue 0 */ background: #e6f3ff; - background: rgba(114, 159, 207, 0.1); } .listing_code .programlisting { /* override from previous */ border: none 0px; padding: 0px; - background: none; } .listing_lines pre, .listing_code pre { margin: 0px; diff --git a/docs/api/html/up-insensitive.png b/docs/api/html/up-insensitive.png Binary files differdeleted file mode 100644 index f40498606..000000000 --- a/docs/api/html/up-insensitive.png +++ /dev/null diff --git a/docs/api/html/up.png b/docs/api/html/up.png Binary files differindex 80b4b37e9..85b3e2a27 100644 --- a/docs/api/html/up.png +++ b/docs/api/html/up.png |
