From 8c98b34228abb4dfde822ad89106b4d8b2287639 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 7 Aug 2012 22:16:03 +0200 Subject: Imported Upstream version 0.9.6.0 --- docs/libnm-util/html/NMConnection.html | 10 +- docs/libnm-util/html/NMSetting.html | 2 +- docs/libnm-util/html/NMSetting8021x.html | 4 +- docs/libnm-util/html/NMSettingAdsl.html | 511 ++++++++++++++++++++++++++++ docs/libnm-util/html/NMSettingOlpcMesh.html | 27 +- docs/libnm-util/html/NMSettingVlan.html | 6 +- docs/libnm-util/html/api-index-full.html | 66 ++-- docs/libnm-util/html/ch01.html | 5 +- docs/libnm-util/html/index.html | 29 +- docs/libnm-util/html/index.sgml | 47 +++ docs/libnm-util/html/libnm-util.devhelp2 | 40 +++ docs/libnm-util/html/object-tree.html | 4 +- 12 files changed, 698 insertions(+), 53 deletions(-) create mode 100644 docs/libnm-util/html/NMSettingAdsl.html (limited to 'docs/libnm-util/html') diff --git a/docs/libnm-util/html/NMConnection.html b/docs/libnm-util/html/NMConnection.html index c1bd42e1..9e62ec8a 100644 --- a/docs/libnm-util/html/NMConnection.html +++ b/docs/libnm-util/html/NMConnection.html @@ -78,7 +78,7 @@ const char * NMSetting * nm_connection_get_setting (NMConnection *connection, GType setting_type); NMSetting8021x * nm_connection_get_setting_802_1x (NMConnection *connection); -NMSettingAdsl * nm_connection_get_setting_adsl (NMConnection *connection); +NMSettingAdsl * nm_connection_get_setting_adsl (NMConnection *connection); NMSettingBluetooth * nm_connection_get_setting_bluetooth (NMConnection *connection); NMSettingBond * nm_connection_get_setting_bond (NMConnection *connection); @@ -631,9 +631,9 @@ A shortcut to return any

nm_connection_get_setting_adsl ()

-
NMSettingAdsl *     nm_connection_get_setting_adsl      (NMConnection *connection);
+
NMSettingAdsl *     nm_connection_get_setting_adsl      (NMConnection *connection);

-A shortcut to return any NMSettingAdsl the connection might contain. +A shortcut to return any NMSettingAdsl the connection might contain.

@@ -645,7 +645,7 @@ A shortcut to return any NMSettingAdsl the connection - @@ -921,7 +921,7 @@ A shortcut to return any

nm_connection_get_setting_pppoe ()

NMSettingPPPOE *    nm_connection_get_setting_pppoe     (NMConnection *connection);

-A shortcut to return any NMSettingPPOE the connection might contain. +A shortcut to return any NMSettingPPPOE the connection might contain.

Returns :

an NMSettingAdsl if the connection contains one, otherwise NULL. [transfer none] +an NMSettingAdsl if the connection contains one, otherwise NULL. [transfer none]
diff --git a/docs/libnm-util/html/NMSetting.html b/docs/libnm-util/html/NMSetting.html index cccfd00b..8a8b2b8c 100644 --- a/docs/libnm-util/html/NMSetting.html +++ b/docs/libnm-util/html/NMSetting.html @@ -113,7 +113,7 @@ const char * GObject +----NMSetting +----NMSetting8021x - +----NMSettingAdsl + +----NMSettingAdsl +----NMSettingBluetooth +----NMSettingBond +----NMSettingCdma diff --git a/docs/libnm-util/html/NMSetting8021x.html b/docs/libnm-util/html/NMSetting8021x.html index ba179c4a..a81f903d 100644 --- a/docs/libnm-util/html/NMSetting8021x.html +++ b/docs/libnm-util/html/NMSetting8021x.html @@ -6,7 +6,7 @@ - + @@ -14,7 +14,7 @@
- + diff --git a/docs/libnm-util/html/NMSettingAdsl.html b/docs/libnm-util/html/NMSettingAdsl.html new file mode 100644 index 00000000..c7289a0a --- /dev/null +++ b/docs/libnm-util/html/NMSettingAdsl.html @@ -0,0 +1,511 @@ + + + + +NMSettingAdsl + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingAdsl

+

NMSettingAdsl — Describes ADSL-based properties

+
+
+

Synopsis

+
+#include <nm-setting-adsl.h>
+
+                    NMSettingAdsl;
+                    NMSettingAdslClass;
+enum                NMSettingAdslError;
+#define             NM_SETTING_ADSL_ENCAPSULATION
+#define             NM_SETTING_ADSL_ENCAPSULATION_LLC
+#define             NM_SETTING_ADSL_ENCAPSULATION_VCMUX
+#define             NM_SETTING_ADSL_ERROR
+#define             NM_SETTING_ADSL_PASSWORD
+#define             NM_SETTING_ADSL_PASSWORD_FLAGS
+#define             NM_SETTING_ADSL_PROTOCOL
+#define             NM_SETTING_ADSL_PROTOCOL_IPOATM
+#define             NM_SETTING_ADSL_PROTOCOL_PPPOA
+#define             NM_SETTING_ADSL_PROTOCOL_PPPOE
+#define             NM_SETTING_ADSL_SETTING_NAME
+#define             NM_SETTING_ADSL_USERNAME
+#define             NM_SETTING_ADSL_VCI
+#define             NM_SETTING_ADSL_VPI
+GQuark              nm_setting_adsl_error_quark         (void);
+const char *        nm_setting_adsl_get_encapsulation   (NMSettingAdsl *setting);
+const char *        nm_setting_adsl_get_password        (NMSettingAdsl *setting);
+NMSettingSecretFlags nm_setting_adsl_get_password_flags (NMSettingAdsl *setting);
+const char *        nm_setting_adsl_get_protocol        (NMSettingAdsl *setting);
+const char *        nm_setting_adsl_get_username        (NMSettingAdsl *setting);
+guint32             nm_setting_adsl_get_vci             (NMSettingAdsl *setting);
+guint32             nm_setting_adsl_get_vpi             (NMSettingAdsl *setting);
+NMSetting *         nm_setting_adsl_new                 (void);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingAdsl
+
+
+  GEnum
+   +----NMSettingAdslError
+
+
+
+

Properties

+
+  "encapsulation"            gchar*                : Read / Write
+  "password"                 gchar*                : Read / Write
+  "password-flags"           guint                 : Read / Write
+  "protocol"                 gchar*                : Read / Write
+  "username"                 gchar*                : Read / Write
+  "vci"                      guint                 : Read / Write
+  "vpi"                      guint                 : Read / Write
+
+
+
+

Description

+

+The NMSettingAdsl object is a NMSetting subclass that describes +properties of ADSL connections. +

+
+
+

Details

+
+

NMSettingAdsl

+
typedef struct _NMSettingAdsl NMSettingAdsl;
+

+

+
+
+
+

NMSettingAdslClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingAdslClass;
+
+

+

+
+
+
+

enum NMSettingAdslError

+
typedef enum {
+	NM_SETTING_ADSL_ERROR_UNKNOWN = 0,              /*< nick=UnknownError >*/
+	NM_SETTING_ADSL_ERROR_INVALID_PROPERTY,         /*< nick=InvalidProperty >*/
+	NM_SETTING_ADSL_ERROR_MISSING_PROPERTY          /*< nick=MissingProperty >*/
+} NMSettingAdslError;
+
+
++ + + + + + + + + + + + + + +

NM_SETTING_ADSL_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_ADSL_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_ADSL_ERROR_MISSING_PROPERTY

the property was missing and is +required +
+
+
+
+

NM_SETTING_ADSL_ENCAPSULATION

+
#define NM_SETTING_ADSL_ENCAPSULATION       "encapsulation"
+
+

+

+
+
+
+

NM_SETTING_ADSL_ENCAPSULATION_LLC

+
#define NM_SETTING_ADSL_ENCAPSULATION_LLC   "llc"
+
+

+

+
+
+
+

NM_SETTING_ADSL_ENCAPSULATION_VCMUX

+
#define NM_SETTING_ADSL_ENCAPSULATION_VCMUX "vcmux"
+
+

+

+
+
+
+

NM_SETTING_ADSL_ERROR

+
#define NM_SETTING_ADSL_ERROR nm_setting_adsl_error_quark ()
+
+

+

+
+
+
+

NM_SETTING_ADSL_PASSWORD

+
#define NM_SETTING_ADSL_PASSWORD            "password"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PASSWORD_FLAGS

+
#define NM_SETTING_ADSL_PASSWORD_FLAGS      "password-flags"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PROTOCOL

+
#define NM_SETTING_ADSL_PROTOCOL            "protocol"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PROTOCOL_IPOATM

+
#define NM_SETTING_ADSL_PROTOCOL_IPOATM     "ipoatm"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PROTOCOL_PPPOA

+
#define NM_SETTING_ADSL_PROTOCOL_PPPOA      "pppoa"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PROTOCOL_PPPOE

+
#define NM_SETTING_ADSL_PROTOCOL_PPPOE      "pppoe"
+
+

+

+
+
+
+

NM_SETTING_ADSL_SETTING_NAME

+
#define NM_SETTING_ADSL_SETTING_NAME "adsl"
+
+

+

+
+
+
+

NM_SETTING_ADSL_USERNAME

+
#define NM_SETTING_ADSL_USERNAME            "username"
+
+

+

+
+
+
+

NM_SETTING_ADSL_VCI

+
#define NM_SETTING_ADSL_VCI                 "vci"
+
+

+

+
+
+
+

NM_SETTING_ADSL_VPI

+
#define NM_SETTING_ADSL_VPI                 "vpi"
+
+

+

+
+
+
+

nm_setting_adsl_error_quark ()

+
GQuark              nm_setting_adsl_error_quark         (void);
+

+Registers an error quark for NMSettingAdsl if necessary. +

+
++ + + + +

Returns :

the error quark used for NMSettingAdsl errors.
+
+
+
+

nm_setting_adsl_get_encapsulation ()

+
const char *        nm_setting_adsl_get_encapsulation   (NMSettingAdsl *setting);
+
++ + + + + + + + + + +

setting :

the NMSettingAdsl +

Returns :

the "encapsulation" property of the setting
+
+
+
+

nm_setting_adsl_get_password ()

+
const char *        nm_setting_adsl_get_password        (NMSettingAdsl *setting);
+
++ + + + + + + + + + +

setting :

the NMSettingAdsl +

Returns :

the "password" property of the setting
+
+
+
+

nm_setting_adsl_get_password_flags ()

+
NMSettingSecretFlags nm_setting_adsl_get_password_flags (NMSettingAdsl *setting);
+
++ + + + + + + + + + +

setting :

the NMSettingAdsl +

Returns :

the NMSettingSecretFlags pertaining to the "password" +
+
+
+
+

nm_setting_adsl_get_protocol ()

+
const char *        nm_setting_adsl_get_protocol        (NMSettingAdsl *setting);
+
++ + + + + + + + + + +

setting :

the NMSettingAdsl +

Returns :

the "protocol" property of the setting
+
+
+
+

nm_setting_adsl_get_username ()

+
const char *        nm_setting_adsl_get_username        (NMSettingAdsl *setting);
+
++ + + + + + + + + + +

setting :

the NMSettingAdsl +

Returns :

the "username" property of the setting
+
+
+
+

nm_setting_adsl_get_vci ()

+
guint32             nm_setting_adsl_get_vci             (NMSettingAdsl *setting);
+
++ + + + + + + + + + +

setting :

the NMSettingAdsl +

Returns :

the "vci" property of the setting
+
+
+
+

nm_setting_adsl_get_vpi ()

+
guint32             nm_setting_adsl_get_vpi             (NMSettingAdsl *setting);
+
++ + + + + + + + + + +

setting :

the NMSettingAdsl +

Returns :

the "vpi" property of the setting
+
+
+
+

nm_setting_adsl_new ()

+
NMSetting *         nm_setting_adsl_new                 (void);
+

+Creates a new NMSettingAdsl object with default values. +

+
++ + + + +

Returns :

the new empty NMSettingAdsl object
+
+
+
+

Property Details

+
+

The "encapsulation" property

+
  "encapsulation"            gchar*                : Read / Write
+

+ADSL connection encapsulation, can be vcmux or llc. +

+

Default value: NULL

+
+
+
+

The "password" property

+
  "password"                 gchar*                : Read / Write
+

+Password used to authenticate with the ADSL service. +

+

Default value: NULL

+
+
+
+

The "password-flags" property

+
  "password-flags"           guint                 : Read / Write
+

+Flags indicating how to handle "password":. +

+

Allowed values: <= 7

+

Default value: 0

+
+
+
+

The "protocol" property

+
  "protocol"                 gchar*                : Read / Write
+

+ADSL connection protocol, can be pppoa, pppoe or ipoatm. +

+

Default value: NULL

+
+
+
+

The "username" property

+
  "username"                 gchar*                : Read / Write
+

+Username used to authenticate with the ADSL service. +

+

Default value: NULL

+
+
+
+

The "vci" property

+
  "vci"                      guint                 : Read / Write
+

+ADSL connection vci. +

+

Allowed values: <= 65536

+

Default value: 0

+
+
+
+

The "vpi" property

+
  "vpi"                      guint                 : Read / Write
+

+ADSL connection vpi. +

+

Allowed values: <= 65536

+

Default value: 0

+
+
+
+
+
+ Generated by GTK-Doc V1.18
+ + \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingOlpcMesh.html b/docs/libnm-util/html/NMSettingOlpcMesh.html index 53ee169c..fe2fa095 100644 --- a/docs/libnm-util/html/NMSettingOlpcMesh.html +++ b/docs/libnm-util/html/NMSettingOlpcMesh.html @@ -7,7 +7,7 @@ - + @@ -18,7 +18,7 @@ Up Home libnm-util Reference Manual -Next +Next Top @@ -115,8 +115,27 @@ const ++ + + + + + + + + + + + + + +

NM_SETTING_OLPC_MESH_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY

the property was missing and is +required +
diff --git a/docs/libnm-util/html/NMSettingVlan.html b/docs/libnm-util/html/NMSettingVlan.html index cc50161e..013c31f1 100644 --- a/docs/libnm-util/html/NMSettingVlan.html +++ b/docs/libnm-util/html/NMSettingVlan.html @@ -681,8 +681,7 @@ 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" , ex 'eth2.1'. The parent interface may be given by the "parent" property or by a -hardware address property, eg "mac-address" or -"mac-address". +hardware address property, eg "mac-address".

Default value: NULL

@@ -694,8 +693,7 @@ hardware address property, eg "mac-address" or -"mac-address". +hardware-specific setting, like "mac-address".

Default value: NULL

diff --git a/docs/libnm-util/html/api-index-full.html b/docs/libnm-util/html/api-index-full.html index 053cb332..2e5d124d 100644 --- a/docs/libnm-util/html/api-index-full.html +++ b/docs/libnm-util/html/api-index-full.html @@ -621,43 +621,43 @@
-NMSettingAdsl, struct in NMSettingAdsl +NMSettingAdsl, struct in NMSettingAdsl
-NMSettingAdsl:encapsulation, object property in NMSettingAdsl +NMSettingAdsl:encapsulation, object property in NMSettingAdsl
-NMSettingAdsl:password, object property in NMSettingAdsl +NMSettingAdsl:password, object property in NMSettingAdsl
-NMSettingAdsl:password-flags, object property in NMSettingAdsl +NMSettingAdsl:password-flags, object property in NMSettingAdsl
-NMSettingAdsl:protocol, object property in NMSettingAdsl +NMSettingAdsl:protocol, object property in NMSettingAdsl
-NMSettingAdsl:username, object property in NMSettingAdsl +NMSettingAdsl:username, object property in NMSettingAdsl
-NMSettingAdsl:vci, object property in NMSettingAdsl +NMSettingAdsl:vci, object property in NMSettingAdsl
-NMSettingAdsl:vpi, object property in NMSettingAdsl +NMSettingAdsl:vpi, object property in NMSettingAdsl
-NMSettingAdslClass, struct in NMSettingAdsl +NMSettingAdslClass, struct in NMSettingAdsl
-NMSettingAdslError, enum in NMSettingAdsl +NMSettingAdslError, enum in NMSettingAdsl
@@ -1873,95 +1873,95 @@ NMSettingAdslError, enum in NMSettingAdsl
-NM_SETTING_ADSL_ENCAPSULATION, macro in NMSettingAdsl +NM_SETTING_ADSL_ENCAPSULATION, macro in NMSettingAdsl
-NM_SETTING_ADSL_ENCAPSULATION_LLC, macro in NMSettingAdsl +NM_SETTING_ADSL_ENCAPSULATION_LLC, macro in NMSettingAdsl
-NM_SETTING_ADSL_ENCAPSULATION_VCMUX, macro in NMSettingAdsl +NM_SETTING_ADSL_ENCAPSULATION_VCMUX, macro in NMSettingAdsl
-NM_SETTING_ADSL_ERROR, macro in NMSettingAdsl +NM_SETTING_ADSL_ERROR, macro in NMSettingAdsl
-nm_setting_adsl_error_quark, function in NMSettingAdsl +nm_setting_adsl_error_quark, function in NMSettingAdsl
-nm_setting_adsl_get_encapsulation, function in NMSettingAdsl +nm_setting_adsl_get_encapsulation, function in NMSettingAdsl
-nm_setting_adsl_get_password, function in NMSettingAdsl +nm_setting_adsl_get_password, function in NMSettingAdsl
-nm_setting_adsl_get_password_flags, function in NMSettingAdsl +nm_setting_adsl_get_password_flags, function in NMSettingAdsl
-nm_setting_adsl_get_protocol, function in NMSettingAdsl +nm_setting_adsl_get_protocol, function in NMSettingAdsl
-nm_setting_adsl_get_username, function in NMSettingAdsl +nm_setting_adsl_get_username, function in NMSettingAdsl
-nm_setting_adsl_get_vci, function in NMSettingAdsl +nm_setting_adsl_get_vci, function in NMSettingAdsl
-nm_setting_adsl_get_vpi, function in NMSettingAdsl +nm_setting_adsl_get_vpi, function in NMSettingAdsl
-nm_setting_adsl_new, function in NMSettingAdsl +nm_setting_adsl_new, function in NMSettingAdsl
-NM_SETTING_ADSL_PASSWORD, macro in NMSettingAdsl +NM_SETTING_ADSL_PASSWORD, macro in NMSettingAdsl
-NM_SETTING_ADSL_PASSWORD_FLAGS, macro in NMSettingAdsl +NM_SETTING_ADSL_PASSWORD_FLAGS, macro in NMSettingAdsl
-NM_SETTING_ADSL_PROTOCOL, macro in NMSettingAdsl +NM_SETTING_ADSL_PROTOCOL, macro in NMSettingAdsl
-NM_SETTING_ADSL_PROTOCOL_IPOATM, macro in NMSettingAdsl +NM_SETTING_ADSL_PROTOCOL_IPOATM, macro in NMSettingAdsl
-NM_SETTING_ADSL_PROTOCOL_PPPOA, macro in NMSettingAdsl +NM_SETTING_ADSL_PROTOCOL_PPPOA, macro in NMSettingAdsl
-NM_SETTING_ADSL_PROTOCOL_PPPOE, macro in NMSettingAdsl +NM_SETTING_ADSL_PROTOCOL_PPPOE, macro in NMSettingAdsl
-NM_SETTING_ADSL_SETTING_NAME, macro in NMSettingAdsl +NM_SETTING_ADSL_SETTING_NAME, macro in NMSettingAdsl
-NM_SETTING_ADSL_USERNAME, macro in NMSettingAdsl +NM_SETTING_ADSL_USERNAME, macro in NMSettingAdsl
-NM_SETTING_ADSL_VCI, macro in NMSettingAdsl +NM_SETTING_ADSL_VCI, macro in NMSettingAdsl
-NM_SETTING_ADSL_VPI, macro in NMSettingAdsl +NM_SETTING_ADSL_VPI, macro in NMSettingAdsl
diff --git a/docs/libnm-util/html/ch01.html b/docs/libnm-util/html/ch01.html index 39768bae..6f1e37fe 100644 --- a/docs/libnm-util/html/ch01.html +++ b/docs/libnm-util/html/ch01.html @@ -21,7 +21,7 @@

-libnm-util API Reference

+libnm-util API Reference
NMConnection — Describes a connection to specific network or provider @@ -71,6 +71,9 @@ serial communications NMSettingOlpcMesh
+NMSettingAdsl — Describes ADSL-based properties +
+
NMSetting8021x — Describes 802.1x-authenticated connection properties
diff --git a/docs/libnm-util/html/index.html b/docs/libnm-util/html/index.html index dea375f6..a97eb48a 100644 --- a/docs/libnm-util/html/index.html +++ b/docs/libnm-util/html/index.html @@ -15,10 +15,34 @@

- for libnm-util 0.9 + for libnm-util 0.9.6.0 + The latest version of this documentation can be found on-line at http://projects.gnome.org/NetworkManager/developers/libnm-util/09/.

+

Copyright © 2012 The NetworkManager Authors

+
+

+ Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free + Documentation License, Version 1.1 or any later + version published by the Free Software Foundation with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. You may obtain a copy of the GNU Free + Documentation License from the Free Software + Foundation by visiting their Web site or by writing + to: + +

+


+   The Free Software Foundation, Inc.,
+   51 Franklin Street - Fifth Floor,
+   Boston, MA 02110-1301,
+   USA
+

+

+

+
@@ -73,6 +97,9 @@ serial communications NMSettingOlpcMesh
+NMSettingAdsl — Describes ADSL-based properties +
+
NMSetting8021x — Describes 802.1x-authenticated connection properties
diff --git a/docs/libnm-util/html/index.sgml b/docs/libnm-util/html/index.sgml index e8f2d4ea..2fa04eaf 100644 --- a/docs/libnm-util/html/index.sgml +++ b/docs/libnm-util/html/index.sgml @@ -716,6 +716,9 @@ + + + @@ -730,6 +733,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/libnm-util/html/libnm-util.devhelp2 b/docs/libnm-util/html/libnm-util.devhelp2 index 93646eec..5b50abff 100644 --- a/docs/libnm-util/html/libnm-util.devhelp2 +++ b/docs/libnm-util/html/libnm-util.devhelp2 @@ -18,6 +18,7 @@ + @@ -528,6 +529,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1087,6 +1121,12 @@ + + + + + + diff --git a/docs/libnm-util/html/object-tree.html b/docs/libnm-util/html/object-tree.html index edb82a82..ea1caff3 100644 --- a/docs/libnm-util/html/object-tree.html +++ b/docs/libnm-util/html/object-tree.html @@ -27,7 +27,7 @@ NMConnection NMSetting NMSetting8021x - NMSettingAdsl + NMSettingAdsl NMSettingBluetooth NMSettingBond NMSettingCdma @@ -51,7 +51,7 @@ NMSetting8021xCKFormat NMSetting8021xCKScheme NMSetting8021xError - NMSettingAdslError + NMSettingAdslError NMSettingBluetoothError NMSettingBondError NMSettingCdmaError -- cgit 1.3.0-6-gf8a5