Imported Upstream version 1.0.4 upstream/1.0.4

author: Michael Biebl <biebl@debian.org> 2015-07-14 19:38:58 +0200
committer: Michael Biebl <biebl@debian.org> 2015-07-14 19:38:58 +0200
commit: 50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 (patch)
tree: 6790165f39daee79e2b6c6617483320613493367 /docs/libnm/html/NMSettingVpn.html
parent: f408e27bccfacf347605a8d98649975a68f38a17 (diff)
1 files changed, 21 insertions, 30 deletions
diff --git a/docs/libnm/html/NMSettingVpn.html b/docs/libnm/html/NMSettingVpn.html
index a55a552a..ba0b0304 100644
--- a/docs/libnm/html/NMSettingVpn.html
+++ b/docs/libnm/html/NMSettingVpn.html
@@ -2,13 +2,13 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>libnm Reference Manual: NMSettingVpn</title>
+<title>NMSettingVpn: libnm Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="libnm Reference Manual">
 <link rel="up" href="ch03.html" title="Connection and Setting API Reference">
 <link rel="prev" href="NMSettingVlan.html" title="NMSettingVlan">
 <link rel="next" href="NMSettingWimax.html" title="NMSettingWimax">
-<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -327,7 +327,6 @@ plugin that should be used to connect to this VPN.</p>
 <div class="refsect3">
 <a name="id-1.4.27.8.4.6"></a><h4>Returns</h4>
 <p> the VPN plugin's service name</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -353,7 +352,6 @@ nm_setting_vpn_get_user_name (<em class="parameter"><code><a class="link" href="
 <div class="refsect3">
 <a name="id-1.4.27.8.5.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingVpn.html#NMSettingVpn--user-name" title="The “user-name” property"><span class="type">“user-name”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -379,7 +377,6 @@ nm_setting_vpn_get_persistent (<em class="parameter"><code><a class="link" href=
 <div class="refsect3">
 <a name="id-1.4.27.8.6.5"></a><h4>Returns</h4>
 <p> the <a class="link" href="NMSettingVpn.html#NMSettingVpn--persistent" title="The “persistent” property"><span class="type">“persistent”</span></a> property of the setting</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -406,7 +403,6 @@ nm_setting_vpn_get_num_data_items (<em class="parameter"><code><a class="link" h
 <div class="refsect3">
 <a name="id-1.4.27.8.7.6"></a><h4>Returns</h4>
 <p> the number of VPN plugin specific configuration data items</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -484,7 +480,6 @@ by <a class="link" href="NMSettingVpn.html#nm-setting-vpn-add-data-item" title="
 <div class="refsect3">
 <a name="id-1.4.27.8.9.6"></a><h4>Returns</h4>
 <p> the data item, if any</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -521,7 +516,6 @@ nm_setting_vpn_remove_data_item (<em class="parameter"><code><a class="link" hre
 <a name="id-1.4.27.8.10.6"></a><h4>Returns</h4>
 <p> <code class="literal">TRUE</code> if the data item was found and removed from the internal list,
 <code class="literal">FALSE</code> if it was not.</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -588,7 +582,6 @@ nm_setting_vpn_get_num_secrets (<em class="parameter"><code><a class="link" href
 <div class="refsect3">
 <a name="id-1.4.27.8.12.6"></a><h4>Returns</h4>
 <p> the number of VPN plugin specific secrets</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -665,7 +658,6 @@ by <a class="link" href="NMSettingVpn.html#nm-setting-vpn-add-secret" title="nm_
 <div class="refsect3">
 <a name="id-1.4.27.8.14.6"></a><h4>Returns</h4>
 <p> the secret, if any</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -702,7 +694,6 @@ nm_setting_vpn_remove_secret (<em class="parameter"><code><a class="link" href="
 <a name="id-1.4.27.8.15.6"></a><h4>Returns</h4>
 <p> <code class="literal">TRUE</code> if the secret was found and removed from the internal list,
 <code class="literal">FALSE</code> if it was not.</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -752,48 +743,36 @@ iteration will not be part of the iteration.</p>
 <a name="NM-SETTING-VPN-SETTING-NAME:CAPS"></a><h3>NM_SETTING_VPN_SETTING_NAME</h3>
 <pre class="programlisting">#define NM_SETTING_VPN_SETTING_NAME "vpn"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-VPN-SERVICE-TYPE:CAPS"></a><h3>NM_SETTING_VPN_SERVICE_TYPE</h3>
 <pre class="programlisting">#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-VPN-USER-NAME:CAPS"></a><h3>NM_SETTING_VPN_USER_NAME</h3>
 <pre class="programlisting">#define NM_SETTING_VPN_USER_NAME    "user-name"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-VPN-PERSISTENT:CAPS"></a><h3>NM_SETTING_VPN_PERSISTENT</h3>
 <pre class="programlisting">#define NM_SETTING_VPN_PERSISTENT   "persistent"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-VPN-DATA:CAPS"></a><h3>NM_SETTING_VPN_DATA</h3>
 <pre class="programlisting">#define NM_SETTING_VPN_DATA         "data"
 </pre>
-<p>
-</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NM-SETTING-VPN-SECRETS:CAPS"></a><h3>NM_SETTING_VPN_SECRETS</h3>
 <pre class="programlisting">#define NM_SETTING_VPN_SECRETS      "secrets"
 </pre>
-<p>
-</p>
 </div>
 </div>
 <div class="refsect1">
@@ -801,14 +780,18 @@ iteration will not be part of the iteration.</p>
 <div class="refsect2">
 <a name="NMSettingVpn--data"></a><h3>The <code class="literal">“data”</code> property</h3>
 <pre class="programlisting">  “data”                     <span class="type">GHashTable</span> *</pre>
-<p></p>
+<p>Dictionary of key/value pairs of VPN plugin specific data.  Both keys and
+values must be strings.</p>
+<p>Type: GHashTable(utf8,utf8)</p>
 <p>Flags: Read / Write</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NMSettingVpn--persistent"></a><h3>The <code class="literal">“persistent”</code> property</h3>
 <pre class="programlisting">  “persistent”               <span class="type">gboolean</span></pre>
-<p></p>
+<p>If the VPN service supports persistence, and this property is <code class="literal">TRUE</code>,
+the VPN will attempt to stay connected across link changes and outages,
+until explicitly disconnected.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: FALSE</p>
 </div>
@@ -816,14 +799,18 @@ iteration will not be part of the iteration.</p>
 <div class="refsect2">
 <a name="NMSettingVpn--secrets"></a><h3>The <code class="literal">“secrets”</code> property</h3>
 <pre class="programlisting">  “secrets”                  <span class="type">GHashTable</span> *</pre>
-<p></p>
+<p>Dictionary of key/value pairs of VPN plugin specific secrets like
+passwords or private keys.  Both keys and values must be strings.</p>
+<p>Type: GHashTable(utf8,utf8)</p>
 <p>Flags: Read / Write</p>
 </div>
 <hr>
 <div class="refsect2">
 <a name="NMSettingVpn--service-type"></a><h3>The <code class="literal">“service-type”</code> property</h3>
 <pre class="programlisting">  “service-type”             <span class="type">gchar</span> *</pre>
-<p></p>
+<p>D-Bus service name of the VPN plugin that this setting uses to connect to
+its network.  i.e. org.freedesktop.NetworkManager.vpnc for the vpnc
+plugin.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
 </div>
@@ -831,14 +818,18 @@ iteration will not be part of the iteration.</p>
 <div class="refsect2">
 <a name="NMSettingVpn--user-name"></a><h3>The <code class="literal">“user-name”</code> property</h3>
 <pre class="programlisting">  “user-name”                <span class="type">gchar</span> *</pre>
-<p></p>
+<p>If the VPN connection requires a user name for authentication, that name
+should be provided here.  If the connection is available to more than one
+user, and the VPN requires each user to supply a different name, then
+leave this property empty.  If this property is empty, NetworkManager
+will automatically supply the username of the user which requested the
+VPN connection.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
 </div>
 </div>
 </div>
 <div class="footer">
-<hr>
-          Generated by GTK-Doc V1.21</div>
+<hr>Generated by GTK-Doc V1.24</div>
 </body>
 </html>
\ No newline at end of file
author	Michael Biebl <biebl@debian.org>	2015-07-14 19:38:58 +0200
committer	Michael Biebl <biebl@debian.org>	2015-07-14 19:38:58 +0200
commit	50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 (patch)
tree	6790165f39daee79e2b6c6617483320613493367 /docs/libnm/html/NMSettingVpn.html
parent	f408e27bccfacf347605a8d98649975a68f38a17 (diff)