diff options
| author | Michael Biebl <biebl@debian.org> | 2010-11-29 00:47:11 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2010-11-29 00:47:11 +0100 |
| commit | 9fae01fa351805b2903e535736e06971bc0b925e (patch) | |
| tree | c19bccf84c9f894e50fae678ba6ee2b2044e2d30 /docs/libnm-util/tmpl | |
Imported Upstream version 0.8.1 upstream/0.8.1
Diffstat (limited to 'docs/libnm-util/tmpl')
21 files changed, 7619 insertions, 0 deletions
diff --git a/docs/libnm-util/tmpl/libnm-util-unused.sgml b/docs/libnm-util/tmpl/libnm-util-unused.sgml new file mode 100644 index 00000000..ea59da27 --- /dev/null +++ b/docs/libnm-util/tmpl/libnm-util-unused.sgml @@ -0,0 +1,695 @@ +<!-- ##### SECTION ./tmpl/nm-setting-bridge.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/nm-setting-bridge.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/nm-setting-bridge.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/nm-setting-bridge.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/nm-setting-bridge.sgml:Title ##### --> +NMSettingBridge + + +<!-- ##### SECTION ./tmpl/nm-setting-wimax.sgml:Image ##### --> + + + +<!-- ##### SECTION ./tmpl/nm-setting-wimax.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/nm-setting-wimax.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/nm-setting-wimax.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/nm-setting-wimax.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/nm-setting-wimax.sgml:Title ##### --> +NMSettingWimax + + +<!-- ##### ARG NMSetting8021x:ca-cert-path ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting8021x:client-cert-path ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting8021x:phase2-ca-cert-path ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting8021x:phase2-client-cert-path ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting8021x:phase2-private-key-path ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting8021x:private-key-path ##### --> +<para> + +</para> + + +<!-- ##### STRUCT NMSettingBridge ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingBridge:ifname ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingBridge:members ##### --> +<para> + +</para> + + +<!-- ##### ENUM NMSettingBridgeError ##### --> +<para> + +</para> + +@NM_SETTING_BRIDGE_ERROR_UNKNOWN: +@NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY: +@NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY: + +<!-- ##### ENUM NMSettingGsmNetworkMode ##### --> +<para> + +</para> + +@NM_SETTING_GSM_NETWORK_ANY: +@NM_SETTING_GSM_NETWORK_UMTS_HSPA: +@NM_SETTING_GSM_NETWORK_GPRS_EDGE: +@NM_SETTING_GSM_NETWORK_PREFER_UMTS_HSPA: +@NM_SETTING_GSM_NETWORK_PREFER_GPRS_EDGE: + +<!-- ##### STRUCT NMSettingWimax ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWimax:mac-address ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWimax:network-name ##### --> +<para> + +</para> + + +<!-- ##### STRUCT NMSettingWimaxClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### ENUM NMSettingWimaxError ##### --> +<para> + +</para> + +@NM_SETTING_WIMAX_ERROR_UNKNOWN: +@NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY: +@NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY: + +<!-- ##### ARG NMSettingWired:cloned-mac-address ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWired:s390-nettype ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWired:s390-options ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWired:s390-port-name ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWired:s390-port-number ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWired:s390-qeth-layer ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWired:s390-subchannels ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWired:zvm-subchannels ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWireless:cloned-mac-address ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_802_1X_CA_CERT_PATH ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_802_1X_CLIENT_CERT_PATH ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CA_CERT_PATH ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CLIENT_CERT_PATH ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PATH ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_802_1X_PRIVATE_KEY_PATH ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_BRIDGE_ERROR ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_BRIDGE_IFNAME ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_BRIDGE_MEMBERS ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_BRIDGE_SETTING_NAME ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_DHCP ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIMAX_ERROR ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIMAX_MAC_ADDRESS ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIMAX_NETWORK_NAME ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIMAX_SETTING_NAME ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIRED_CLONED_MAC_ADDRESS ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIRED_S390_NETTYPE ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIRED_S390_OPTIONS ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIRED_S390_PORT_NAME ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIRED_S390_PORT_NUMBER ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIRED_S390_QETH_LAYER ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIRED_S390_SUBCHANNELS ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIRED_ZVM_SUBCHANNELS ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_TYPE_SETTING_BRIDGE_ERROR ##### --> +<para> + +</para> + + +<!-- ##### MACRO NM_TYPE_SETTING_WIMAX_ERROR ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION nm_setting_802_1x_set_ca_cert_path ##### --> +<para> + +</para> + +@setting: +@path_to_cert: +@out_ck_type: +@error: +@Returns: + +<!-- ##### FUNCTION nm_setting_802_1x_set_client_cert_path ##### --> +<para> + +</para> + +@setting: +@path_to_cert: +@out_ck_type: +@error: +@Returns: + +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_ca_cert_path ##### --> +<para> + +</para> + +@setting: +@path_to_cert: +@out_ck_type: +@error: +@Returns: + +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_client_cert_path ##### --> +<para> + +</para> + +@setting: +@path_to_cert: +@out_ck_type: +@error: +@Returns: + +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_private_key_path ##### --> +<para> + +</para> + +@setting: +@path_to_file: +@password: +@out_ck_type: +@error: +@Returns: + +<!-- ##### FUNCTION nm_setting_802_1x_set_private_key_path ##### --> +<para> + +</para> + +@setting: +@path_to_file: +@password: +@out_ck_type: +@error: +@Returns: + +<!-- ##### FUNCTION nm_setting_bridge_add_member ##### --> +<para> + +</para> + +@setting: +@uuid: +@Returns: + +<!-- ##### FUNCTION nm_setting_bridge_clear_members ##### --> +<para> + +</para> + +@setting: + +<!-- ##### FUNCTION nm_setting_bridge_error_quark ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION nm_setting_bridge_get_ifname ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_bridge_get_member ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + +<!-- ##### FUNCTION nm_setting_bridge_get_num_members ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_bridge_get_type ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION nm_setting_bridge_new ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION nm_setting_bridge_remove_member ##### --> +<para> + +</para> + +@setting: +@i: + +<!-- ##### FUNCTION nm_setting_wimax_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION nm_setting_wimax_get_mac_address ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_wimax_get_network_name ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_wimax_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION nm_setting_wimax_new ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_add_s390_option ##### --> +<para> + +</para> + +@setting: +@key: +@item: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_get_cloned_mac_address ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_get_num_s390_options ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_get_s390_nettype ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_get_s390_option ##### --> +<para> + +</para> + +@setting: +@idx: +@out_key: +@out_value: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_get_s390_option_by_key ##### --> +<para> + +</para> + +@setting: +@key: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_get_s390_port_name ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_get_s390_port_number ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_get_s390_qeth_layer ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_get_s390_subchannels ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_get_zvm_subchannels ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_setting_wired_remove_s390_option ##### --> +<para> + +</para> + +@setting: +@key: +@Returns: + +<!-- ##### FUNCTION nm_setting_wireless_get_cloned_mac_address ##### --> +<para> + +</para> + +@setting: +@Returns: + +<!-- ##### FUNCTION nm_utils_wifi_channel_to_freq ##### --> +<para> + +</para> + +@channel: +@band: +@Returns: + +<!-- ##### FUNCTION nm_utils_wifi_find_next_channel ##### --> +<para> + +</para> + +@channel: +@direction: +@band: +@Returns: + +<!-- ##### FUNCTION nm_utils_wifi_freq_to_channel ##### --> +<para> + +</para> + +@freq: +@Returns: + +<!-- ##### FUNCTION nm_utils_wifi_is_channel_valid ##### --> +<para> + +</para> + +@channel: +@band: +@Returns: + diff --git a/docs/libnm-util/tmpl/nm-connection.sgml b/docs/libnm-util/tmpl/nm-connection.sgml new file mode 100644 index 00000000..649e62c7 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-connection.sgml @@ -0,0 +1,335 @@ +<!-- ##### SECTION Title ##### --> +NMConnection + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM NMConnectionScope ##### --> +<para> + +</para> + +@NM_CONNECTION_SCOPE_UNKNOWN: +@NM_CONNECTION_SCOPE_SYSTEM: +@NM_CONNECTION_SCOPE_USER: + +<!-- ##### ENUM NMConnectionError ##### --> +<para> + +</para> + +@NM_CONNECTION_ERROR_UNKNOWN: +@NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND: + +<!-- ##### MACRO NM_TYPE_CONNECTION_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CONNECTION_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_connection_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_CONNECTION_SCOPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CONNECTION_PATH ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMConnection ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL NMConnection::secrets-updated ##### --> +<para> + +</para> + +@nmconnection: the object which received the signal. +@arg1: + +<!-- ##### ARG NMConnection:path ##### --> +<para> + +</para> + +<!-- ##### ARG NMConnection:scope ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMConnectionClass ##### --> +<para> + +</para> + +@parent: +@secrets_updated: + +<!-- ##### FUNCTION nm_connection_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_connection_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_connection_new_from_hash ##### --> +<para> + +</para> + +@hash: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_connection_duplicate ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_add_setting ##### --> +<para> + +</para> + +@connection: +@setting: + + +<!-- ##### FUNCTION nm_connection_remove_setting ##### --> +<para> + +</para> + +@connection: +@setting_type: + + +<!-- ##### FUNCTION nm_connection_get_setting ##### --> +<para> + +</para> + +@connection: +@setting_type: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_by_name ##### --> +<para> + +</para> + +@connection: +@name: +@Returns: + + +<!-- ##### FUNCTION nm_connection_replace_settings ##### --> +<para> + +</para> + +@connection: +@new_settings: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_connection_compare ##### --> +<para> + +</para> + +@a: +@b: +@flags: +@Returns: + + +<!-- ##### FUNCTION nm_connection_verify ##### --> +<para> + +</para> + +@connection: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_connection_need_secrets ##### --> +<para> + +</para> + +@connection: +@hints: +@Returns: + + +<!-- ##### FUNCTION nm_connection_clear_secrets ##### --> +<para> + +</para> + +@connection: + + +<!-- ##### FUNCTION nm_connection_update_secrets ##### --> +<para> + +</para> + +@connection: +@setting_name: +@secrets: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_connection_set_scope ##### --> +<para> + +</para> + +@connection: +@scope: + + +<!-- ##### FUNCTION nm_connection_get_scope ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_set_path ##### --> +<para> + +</para> + +@connection: +@path: + + +<!-- ##### FUNCTION nm_connection_get_path ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_for_each_setting_value ##### --> +<para> + +</para> + +@connection: +@func: +@user_data: + + +<!-- ##### FUNCTION nm_connection_to_hash ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_dump ##### --> +<para> + +</para> + +@connection: + + +<!-- ##### FUNCTION nm_connection_create_setting ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION nm_connection_lookup_setting_type ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION nm_connection_lookup_setting_type_by_quark ##### --> +<para> + +</para> + +@error_quark: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-8021x.sgml b/docs/libnm-util/tmpl/nm-setting-8021x.sgml new file mode 100644 index 00000000..d759e94f --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-8021x.sgml @@ -0,0 +1,966 @@ +<!-- ##### SECTION Title ##### --> +NMSetting8021x + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM NMSetting8021xCKFormat ##### --> +<para> + +</para> + +@NM_SETTING_802_1X_CK_FORMAT_UNKNOWN: +@NM_SETTING_802_1X_CK_FORMAT_X509: +@NM_SETTING_802_1X_CK_FORMAT_RAW_KEY: +@NM_SETTING_802_1X_CK_FORMAT_PKCS12: + +<!-- ##### ENUM NMSetting8021xCKScheme ##### --> +<para> + +</para> + +@NM_SETTING_802_1X_CK_SCHEME_UNKNOWN: +@NM_SETTING_802_1X_CK_SCHEME_BLOB: +@NM_SETTING_802_1X_CK_SCHEME_PATH: + +<!-- ##### MACRO NM_SETTING_802_1X_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSetting8021xError ##### --> +<para> + +</para> + +@NM_SETTING_802_1X_ERROR_UNKNOWN: +@NM_SETTING_802_1X_ERROR_INVALID_PROPERTY: +@NM_SETTING_802_1X_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_TYPE_SETTING_802_1X_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_802_1x_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_802_1X_EAP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_IDENTITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_ANONYMOUS_IDENTITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_CA_CERT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_CA_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_CLIENT_CERT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE1_PEAPVER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE1_PEAPLABEL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_AUTH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_AUTHEAP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CA_CERT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CA_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CLIENT_CERT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PRIVATE_KEY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_PRIVATE_KEY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PSK ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_SYSTEM_CA_CERTS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSetting8021x ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting8021x:anonymous-identity ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:ca-cert ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:ca-path ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:client-cert ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:eap ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:identity ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase1-fast-provisioning ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase1-peaplabel ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase1-peapver ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase2-auth ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase2-autheap ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase2-ca-cert ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase2-ca-path ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase2-client-cert ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase2-private-key ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase2-private-key-password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:private-key ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:private-key-password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:system-ca-certs ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSetting8021xClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_802_1x_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_num_eap_methods ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_eap_method ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_add_eap_method ##### --> +<para> + +</para> + +@setting: +@eap: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_remove_eap_method ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_802_1x_clear_eap_methods ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_identity ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_anonymous_identity ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_system_ca_certs ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_ca_path ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_path ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_ca_cert_scheme ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_ca_cert_blob ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_ca_cert_path ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_ca_cert ##### --> +<para> + +</para> + +@setting: +@value: +@scheme: +@out_format: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_client_cert_scheme ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_client_cert_blob ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_client_cert_path ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_client_cert ##### --> +<para> + +</para> + +@setting: +@value: +@scheme: +@out_format: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase1_peapver ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase1_peaplabel ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase1_fast_provisioning ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_auth ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_autheap ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_cert_scheme ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_cert_blob ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_cert_path ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_ca_cert ##### --> +<para> + +</para> + +@setting: +@value: +@scheme: +@out_format: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_client_cert_scheme ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_client_cert_blob ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_client_cert_path ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_client_cert ##### --> +<para> + +</para> + +@setting: +@value: +@scheme: +@out_format: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_password ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_pin ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_psk ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_scheme ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_blob ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_path ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_private_key ##### --> +<para> + +</para> + +@setting: +@value: +@password: +@scheme: +@out_format: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_password ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_format ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_scheme ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_blob ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_path ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_private_key ##### --> +<para> + +</para> + +@setting: +@value: +@password: +@scheme: +@out_format: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_password ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_format ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### ENUM NMSetting8021xCKType ##### --> +<para> + +</para> + +@NM_SETTING_802_1X_CK_TYPE_UNKNOWN: +@NM_SETTING_802_1X_CK_TYPE_X509: +@NM_SETTING_802_1X_CK_TYPE_RAW_KEY: +@NM_SETTING_802_1X_CK_TYPE_PKCS12: + +<!-- ##### FUNCTION nm_setting_802_1x_get_ca_cert ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_ca_cert_from_file ##### --> +<para> + +</para> + +@setting: +@filename: +@out_ck_type: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_client_cert ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_client_cert_from_file ##### --> +<para> + +</para> + +@setting: +@filename: +@out_ck_type: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_cert ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_ca_cert_from_file ##### --> +<para> + +</para> + +@setting: +@filename: +@out_ck_type: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_client_cert ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_client_cert_from_file ##### --> +<para> + +</para> + +@setting: +@filename: +@out_ck_type: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_private_key_from_file ##### --> +<para> + +</para> + +@setting: +@filename: +@password: +@out_ck_type: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_type ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_private_key_from_file ##### --> +<para> + +</para> + +@setting: +@filename: +@password: +@out_ck_type: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_type ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml b/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml new file mode 100644 index 00000000..255435e8 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml @@ -0,0 +1,153 @@ +<!-- ##### SECTION Title ##### --> +NMSettingBluetooth + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_BLUETOOTH_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingBluetoothError ##### --> +<para> + +</para> + +@NM_SETTING_BLUETOOTH_ERROR_UNKNOWN: +@NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY: +@NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY: +@NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND: + +<!-- ##### MACRO NM_TYPE_SETTING_BLUETOOTH_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BLUETOOTH_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_bluetooth_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_BLUETOOTH_BDADDR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BLUETOOTH_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BLUETOOTH_TYPE_DUN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BLUETOOTH_TYPE_PANU ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingBluetooth ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingBluetooth:bdaddr ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingBluetooth:type ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingBluetoothClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_bluetooth_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bluetooth_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bluetooth_get_bdaddr ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bluetooth_get_connection_type ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-bridge.sgml b/docs/libnm-util/tmpl/nm-setting-bridge.sgml new file mode 100644 index 00000000..15d757c3 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-bridge.sgml @@ -0,0 +1,160 @@ +<!-- ##### SECTION Title ##### --> +NMSettingBridge + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO NM_SETTING_BRIDGE_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingBridgeError ##### --> +<para> + +</para> + +@NM_SETTING_BRIDGE_ERROR_UNKNOWN: +@NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY: +@NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_TYPE_SETTING_BRIDGE_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_bridge_error_quark ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### MACRO NM_SETTING_BRIDGE_IFNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_MEMBERS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingBridge ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingBridge:ifname ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingBridge:members ##### --> +<para> + +</para> + +<!-- ##### FUNCTION nm_setting_bridge_get_type ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_get_ifname ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_get_num_members ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_get_member ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_add_member ##### --> +<para> + +</para> + +@setting: +@uuid: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_remove_member ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_bridge_clear_members ##### --> +<para> + +</para> + +@setting: + + diff --git a/docs/libnm-util/tmpl/nm-setting-cdma.sgml b/docs/libnm-util/tmpl/nm-setting-cdma.sgml new file mode 100644 index 00000000..21fa4c35 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-cdma.sgml @@ -0,0 +1,160 @@ +<!-- ##### SECTION Title ##### --> +NMSettingCdma + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_CDMA_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingCdmaError ##### --> +<para> + +</para> + +@NM_SETTING_CDMA_ERROR_UNKNOWN: +@NM_SETTING_CDMA_ERROR_INVALID_PROPERTY: +@NM_SETTING_CDMA_ERROR_MISSING_PROPERTY: +@NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING: + +<!-- ##### MACRO NM_TYPE_SETTING_CDMA_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CDMA_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_cdma_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_CDMA_NUMBER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CDMA_USERNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CDMA_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingCdma ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingCdma:number ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingCdma:password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingCdma:username ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingCdmaClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_cdma_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_cdma_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_cdma_get_number ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_cdma_get_username ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_cdma_get_password ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-connection.sgml b/docs/libnm-util/tmpl/nm-setting-connection.sgml new file mode 100644 index 00000000..58473e01 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-connection.sgml @@ -0,0 +1,223 @@ +<!-- ##### SECTION Title ##### --> +NMSettingConnection + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_CONNECTION_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingConnectionError ##### --> +<para> + +</para> + +@NM_SETTING_CONNECTION_ERROR_UNKNOWN: +@NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY: +@NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY: +@NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND: + +<!-- ##### MACRO NM_TYPE_SETTING_CONNECTION_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_connection_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_CONNECTION_ID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_UUID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_AUTOCONNECT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_TIMESTAMP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_READ_ONLY ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingConnection ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingConnection:autoconnect ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:id ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:read-only ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:timestamp ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:type ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:uuid ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingConnectionClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_connection_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_id ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_uuid ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_connection_type ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_autoconnect ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_timestamp ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_read_only ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-gsm.sgml b/docs/libnm-util/tmpl/nm-setting-gsm.sgml new file mode 100644 index 00000000..fe91c082 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-gsm.sgml @@ -0,0 +1,394 @@ +<!-- ##### SECTION Title ##### --> +NMSettingGsm + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_GSM_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingGsmError ##### --> +<para> + +</para> + +@NM_SETTING_GSM_ERROR_UNKNOWN: +@NM_SETTING_GSM_ERROR_INVALID_PROPERTY: +@NM_SETTING_GSM_ERROR_MISSING_PROPERTY: +@NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING: + +<!-- ##### MACRO NM_TYPE_SETTING_GSM_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_gsm_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_GSM_NUMBER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_USERNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_APN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_NETWORK_ID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_NETWORK_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_ALLOWED_BANDS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_PIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_HOME_ONLY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_PUK ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_BAND ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_GSM_NETWORK_ANY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_GSM_NETWORK_UMTS_HSPA ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_GSM_NETWORK_GPRS_EDGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_GSM_NETWORK_PREFER_UMTS_HSPA ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_GSM_NETWORK_PREFER_GPRS_EDGE ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingGsmNetworkType ##### --> +<para> + +</para> + +@NM_SETTING_GSM_NETWORK_TYPE_ANY: +@NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA: +@NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE: +@NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA: +@NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE: + +<!-- ##### ENUM NMSettingGsmNetworkBand ##### --> +<para> + +</para> + +@NM_SETTING_GSM_BAND_UNKNOWN: +@NM_SETTING_GSM_BAND_ANY: +@NM_SETTING_GSM_BAND_EGSM: +@NM_SETTING_GSM_BAND_DCS: +@NM_SETTING_GSM_BAND_PCS: +@NM_SETTING_GSM_BAND_G850: +@NM_SETTING_GSM_BAND_U2100: +@NM_SETTING_GSM_BAND_U1800: +@NM_SETTING_GSM_BAND_U17IV: +@NM_SETTING_GSM_BAND_U800: +@NM_SETTING_GSM_BAND_U850: +@NM_SETTING_GSM_BAND_U900: +@NM_SETTING_GSM_BAND_U17IX: +@NM_SETTING_GSM_BAND_U1900: + +<!-- ##### STRUCT NMSettingGsm ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingGsm:allowed-bands ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:apn ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:band ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:home-only ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:network-id ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:network-type ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:number ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:pin ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:puk ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:username ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingGsmClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_gsm_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_number ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_username ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_password ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_apn ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_network_id ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_network_type ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_allowed_bands ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_pin ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_home_only ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_puk ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_band ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml b/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml new file mode 100644 index 00000000..b374a2b1 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml @@ -0,0 +1,758 @@ +<!-- ##### SECTION Title ##### --> +NMSettingIP4Config + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingIP4ConfigError ##### --> +<para> + +</para> + +@NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN: +@NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY: +@NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY: +@NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD: + +<!-- ##### MACRO NM_TYPE_SETTING_IP4_CONFIG_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_ip4_config_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DNS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DNS_SEARCH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_ADDRESSES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_ROUTES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_NEVER_DEFAULT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_MAY_FAIL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_AUTO ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_MANUAL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_SHARED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_DISABLED ##### --> +<para> + +</para> + + + +<!-- ##### TYPEDEF NMIP4Address ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION nm_ip4_address_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_address_dup ##### --> +<para> + +</para> + +@source: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_address_ref ##### --> +<para> + +</para> + +@address: + + +<!-- ##### FUNCTION nm_ip4_address_unref ##### --> +<para> + +</para> + +@address: + + +<!-- ##### FUNCTION nm_ip4_address_compare ##### --> +<para> + +</para> + +@address: +@other: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_address_get_address ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_address_set_address ##### --> +<para> + +</para> + +@address: +@addr: + + +<!-- ##### FUNCTION nm_ip4_address_get_prefix ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_address_set_prefix ##### --> +<para> + +</para> + +@address: +@prefix: + + +<!-- ##### FUNCTION nm_ip4_address_get_gateway ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_address_set_gateway ##### --> +<para> + +</para> + +@address: +@gateway: + + +<!-- ##### TYPEDEF NMIP4Route ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION nm_ip4_route_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_route_dup ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_route_ref ##### --> +<para> + +</para> + +@route: + + +<!-- ##### FUNCTION nm_ip4_route_unref ##### --> +<para> + +</para> + +@route: + + +<!-- ##### FUNCTION nm_ip4_route_compare ##### --> +<para> + +</para> + +@route: +@other: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_route_get_dest ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_route_set_dest ##### --> +<para> + +</para> + +@route: +@dest: + + +<!-- ##### FUNCTION nm_ip4_route_get_prefix ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_route_set_prefix ##### --> +<para> + +</para> + +@route: +@prefix: + + +<!-- ##### FUNCTION nm_ip4_route_get_next_hop ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_route_set_next_hop ##### --> +<para> + +</para> + +@route: +@next_hop: + + +<!-- ##### FUNCTION nm_ip4_route_get_metric ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip4_route_set_metric ##### --> +<para> + +</para> + +@route: +@metric: + + +<!-- ##### STRUCT NMSettingIP4Config ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingIP4Config:addresses ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:dhcp-client-id ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:dhcp-hostname ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:dhcp-send-hostname ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:dns ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:dns-search ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:ignore-auto-dns ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:ignore-auto-routes ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:may-fail ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:method ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:never-default ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP4Config:routes ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingIP4ConfigClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_ip4_config_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_method ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_num_dns ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_dns ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_add_dns ##### --> +<para> + +</para> + +@setting: +@dns: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_remove_dns ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip4_config_clear_dns ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_num_dns_searches ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_dns_search ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_add_dns_search ##### --> +<para> + +</para> + +@setting: +@dns_search: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_remove_dns_search ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip4_config_clear_dns_searches ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_num_addresses ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_address ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_add_address ##### --> +<para> + +</para> + +@setting: +@address: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_remove_address ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip4_config_clear_addresses ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_num_routes ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_route ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_add_route ##### --> +<para> + +</para> + +@setting: +@route: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_remove_route ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip4_config_clear_routes ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_ignore_auto_routes ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_ignore_auto_dns ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_dhcp_client_id ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_dhcp_send_hostname ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_dhcp_hostname ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_never_default ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_may_fail ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml b/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml new file mode 100644 index 00000000..aabe6d24 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml @@ -0,0 +1,695 @@ +<!-- ##### SECTION Title ##### --> +NMSettingIP6Config + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingIP6ConfigError ##### --> +<para> + +</para> + +@NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN: +@NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY: +@NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY: +@NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD: + +<!-- ##### MACRO NM_TYPE_SETTING_IP6_CONFIG_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_ip6_config_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_DNS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_DNS_SEARCH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_ADDRESSES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_ROUTES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_NEVER_DEFAULT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_MAY_FAIL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_IGNORE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_AUTO ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_MANUAL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_SHARED ##### --> +<para> + +</para> + + + +<!-- ##### TYPEDEF NMIP6Address ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION nm_ip6_address_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_address_dup ##### --> +<para> + +</para> + +@source: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_address_ref ##### --> +<para> + +</para> + +@address: + + +<!-- ##### FUNCTION nm_ip6_address_unref ##### --> +<para> + +</para> + +@address: + + +<!-- ##### FUNCTION nm_ip6_address_compare ##### --> +<para> + +</para> + +@address: +@other: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_address_get_address ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_address_set_address ##### --> +<para> + +</para> + +@address: +@addr: + + +<!-- ##### FUNCTION nm_ip6_address_get_prefix ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_address_set_prefix ##### --> +<para> + +</para> + +@address: +@prefix: + + +<!-- ##### FUNCTION nm_ip6_address_get_gateway ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_address_set_gateway ##### --> +<para> + +</para> + +@address: +@gw: + + +<!-- ##### TYPEDEF NMIP6Route ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION nm_ip6_route_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_route_dup ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_route_ref ##### --> +<para> + +</para> + +@route: + + +<!-- ##### FUNCTION nm_ip6_route_unref ##### --> +<para> + +</para> + +@route: + + +<!-- ##### FUNCTION nm_ip6_route_compare ##### --> +<para> + +</para> + +@route: +@other: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_route_get_dest ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_route_set_dest ##### --> +<para> + +</para> + +@route: +@dest: + + +<!-- ##### FUNCTION nm_ip6_route_get_prefix ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_route_set_prefix ##### --> +<para> + +</para> + +@route: +@prefix: + + +<!-- ##### FUNCTION nm_ip6_route_get_next_hop ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_route_set_next_hop ##### --> +<para> + +</para> + +@route: +@next_hop: + + +<!-- ##### FUNCTION nm_ip6_route_get_metric ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip6_route_set_metric ##### --> +<para> + +</para> + +@route: +@metric: + + +<!-- ##### STRUCT NMSettingIP6Config ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingIP6Config:addresses ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP6Config:dns ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP6Config:dns-search ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP6Config:ignore-auto-dns ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP6Config:ignore-auto-routes ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP6Config:may-fail ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP6Config:method ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP6Config:never-default ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIP6Config:routes ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingIP6ConfigClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_ip6_config_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_method ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_num_dns ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_dns ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_add_dns ##### --> +<para> + +</para> + +@setting: +@dns: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_remove_dns ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip6_config_clear_dns ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_num_dns_searches ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_dns_search ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_add_dns_search ##### --> +<para> + +</para> + +@setting: +@dns_search: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_remove_dns_search ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip6_config_clear_dns_searches ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_num_addresses ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_address ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_add_address ##### --> +<para> + +</para> + +@setting: +@address: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_remove_address ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip6_config_clear_addresses ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_num_routes ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_route ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_add_route ##### --> +<para> + +</para> + +@setting: +@route: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_remove_route ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip6_config_clear_routes ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_ignore_auto_routes ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_ignore_auto_dns ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_never_default ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_may_fail ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml b/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml new file mode 100644 index 00000000..d9194bd1 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml @@ -0,0 +1,159 @@ +<!-- ##### SECTION Title ##### --> +NMSettingOlpcMesh + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_OLPC_MESH_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingOlpcMeshError ##### --> +<para> + +</para> + +@NM_SETTING_OLPC_MESH_ERROR_UNKNOWN: +@NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY: +@NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_TYPE_SETTING_OLPC_MESH_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_OLPC_MESH_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_olpc_mesh_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_OLPC_MESH_SSID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_OLPC_MESH_CHANNEL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingOlpcMesh ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingOlpcMesh:channel ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingOlpcMesh:dhcp-anycast-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingOlpcMesh:ssid ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingOlpcMeshClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_olpc_mesh_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_olpc_mesh_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_olpc_mesh_get_ssid ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_olpc_mesh_get_channel ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_olpc_mesh_get_dhcp_anycast_address ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-ppp.sgml b/docs/libnm-util/tmpl/nm-setting-ppp.sgml new file mode 100644 index 00000000..9c48f890 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-ppp.sgml @@ -0,0 +1,475 @@ +<!-- ##### SECTION Title ##### --> +NMSettingPPP + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_PPP_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingPPPError ##### --> +<para> + +</para> + +@NM_SETTING_PPP_ERROR_UNKNOWN: +@NM_SETTING_PPP_ERROR_INVALID_PROPERTY: +@NM_SETTING_PPP_ERROR_MISSING_PROPERTY: +@NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED: + +<!-- ##### MACRO NM_TYPE_SETTING_PPP_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_ppp_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_PPP_NOAUTH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_REFUSE_EAP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_REFUSE_PAP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_REFUSE_CHAP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_REFUSE_MSCHAP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_REFUSE_MSCHAPV2 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_NOBSDCOMP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_NODEFLATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_NO_VJ_COMP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_REQUIRE_MPPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_REQUIRE_MPPE_128 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_MPPE_STATEFUL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_CRTSCTS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_BAUD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_MRU ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_MTU ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_LCP_ECHO_FAILURE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPP_LCP_ECHO_INTERVAL ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingPPP ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingPPP:baud ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:crtscts ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:lcp-echo-failure ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:lcp-echo-interval ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:mppe-stateful ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:mru ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:mtu ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:no-vj-comp ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:noauth ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:nobsdcomp ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:nodeflate ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:refuse-chap ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:refuse-eap ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:refuse-mschap ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:refuse-mschapv2 ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:refuse-pap ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:require-mppe ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPP:require-mppe-128 ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingPPPClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_ppp_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_noauth ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_refuse_eap ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_refuse_pap ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_refuse_chap ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_refuse_mschap ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_refuse_mschapv2 ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_nobsdcomp ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_nodeflate ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_no_vj_comp ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_require_mppe ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_require_mppe_128 ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_mppe_stateful ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_crtscts ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_baud ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_mru ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_mtu ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_lcp_echo_failure ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ppp_get_lcp_echo_interval ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-pppoe.sgml b/docs/libnm-util/tmpl/nm-setting-pppoe.sgml new file mode 100644 index 00000000..5bd2666c --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-pppoe.sgml @@ -0,0 +1,160 @@ +<!-- ##### SECTION Title ##### --> +NMSettingPPPOE + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_PPPOE_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingPPPOEError ##### --> +<para> + +</para> + +@NM_SETTING_PPPOE_ERROR_UNKNOWN: +@NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY: +@NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY: +@NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING: + +<!-- ##### MACRO NM_TYPE_SETTING_PPPOE_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPPOE_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_pppoe_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_PPPOE_SERVICE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPPOE_USERNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPPOE_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingPPPOE ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingPPPOE:password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPPOE:service ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPPPOE:username ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingPPPOEClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_pppoe_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_pppoe_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_pppoe_get_service ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_pppoe_get_username ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_pppoe_get_password ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-serial.sgml b/docs/libnm-util/tmpl/nm-setting-serial.sgml new file mode 100644 index 00000000..c5aeb6fc --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-serial.sgml @@ -0,0 +1,202 @@ +<!-- ##### SECTION Title ##### --> +NMSettingSerial + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_SERIAL_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingSerialError ##### --> +<para> + +</para> + +@NM_SETTING_SERIAL_ERROR_UNKNOWN: +@NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY: +@NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY: +@NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING: + +<!-- ##### MACRO NM_TYPE_SETTING_SERIAL_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_SERIAL_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_serial_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_SERIAL_BAUD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_SERIAL_BITS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_SERIAL_PARITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_SERIAL_STOPBITS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_SERIAL_SEND_DELAY ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingSerial ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingSerial:baud ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingSerial:bits ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingSerial:parity ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingSerial:send-delay ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingSerial:stopbits ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingSerialClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_serial_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_serial_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_serial_get_baud ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_serial_get_bits ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_serial_get_parity ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_serial_get_stopbits ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_serial_get_send_delay ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-vpn.sgml b/docs/libnm-util/tmpl/nm-setting-vpn.sgml new file mode 100644 index 00000000..f30f01f9 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-vpn.sgml @@ -0,0 +1,250 @@ +<!-- ##### SECTION Title ##### --> +NMSettingVPN + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_VPN_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingVpnError ##### --> +<para> + +</para> + +@NM_SETTING_VPN_ERROR_UNKNOWN: +@NM_SETTING_VPN_ERROR_INVALID_PROPERTY: +@NM_SETTING_VPN_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_TYPE_SETTING_VPN_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VPN_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_vpn_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_VPN_SERVICE_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VPN_USER_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VPN_DATA ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VPN_SECRETS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingVPN ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingVPN:data ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingVPN:secrets ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingVPN:service-type ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingVPN:user-name ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingVPNClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### USER_FUNCTION VPNIterFunc ##### --> +<para> + +</para> + +@key: +@value: +@user_data: + + +<!-- ##### FUNCTION nm_setting_vpn_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vpn_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vpn_get_service_type ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vpn_get_user_name ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vpn_add_data_item ##### --> +<para> + +</para> + +@setting: +@key: +@item: + + +<!-- ##### FUNCTION nm_setting_vpn_get_data_item ##### --> +<para> + +</para> + +@setting: +@key: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vpn_remove_data_item ##### --> +<para> + +</para> + +@setting: +@key: + + +<!-- ##### FUNCTION nm_setting_vpn_foreach_data_item ##### --> +<para> + +</para> + +@setting: +@func: +@user_data: + + +<!-- ##### FUNCTION nm_setting_vpn_add_secret ##### --> +<para> + +</para> + +@setting: +@key: +@secret: + + +<!-- ##### FUNCTION nm_setting_vpn_get_secret ##### --> +<para> + +</para> + +@setting: +@key: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vpn_remove_secret ##### --> +<para> + +</para> + +@setting: +@key: + + +<!-- ##### FUNCTION nm_setting_vpn_foreach_secret ##### --> +<para> + +</para> + +@setting: +@func: +@user_data: + + diff --git a/docs/libnm-util/tmpl/nm-setting-wimax.sgml b/docs/libnm-util/tmpl/nm-setting-wimax.sgml new file mode 100644 index 00000000..07d54af4 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-wimax.sgml @@ -0,0 +1,136 @@ +<!-- ##### SECTION Title ##### --> +NMSettingWimax + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_WIMAX_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingWimaxError ##### --> +<para> + +</para> + +@NM_SETTING_WIMAX_ERROR_UNKNOWN: +@NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY: +@NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_TYPE_SETTING_WIMAX_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIMAX_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_wimax_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_WIMAX_NETWORK_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIMAX_MAC_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingWimax ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWimax:mac-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWimax:network-name ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingWimaxClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_wimax_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wimax_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wimax_get_network_name ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wimax_get_mac_address ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-wired.sgml b/docs/libnm-util/tmpl/nm-setting-wired.sgml new file mode 100644 index 00000000..4ac2c691 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-wired.sgml @@ -0,0 +1,222 @@ +<!-- ##### SECTION Title ##### --> +NMSettingWired + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_WIRED_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingWiredError ##### --> +<para> + +</para> + +@NM_SETTING_WIRED_ERROR_UNKNOWN: +@NM_SETTING_WIRED_ERROR_INVALID_PROPERTY: +@NM_SETTING_WIRED_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_TYPE_SETTING_WIRED_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_wired_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_WIRED_PORT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_SPEED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_DUPLEX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_AUTO_NEGOTIATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_MAC_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_MTU ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingWired ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWired:auto-negotiate ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:duplex ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:mac-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:mtu ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:port ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:speed ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingWiredClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_wired_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_port ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_speed ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_duplex ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_auto_negotiate ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_mac_address ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_mtu ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml b/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml new file mode 100644 index 00000000..7ebd57d5 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml @@ -0,0 +1,499 @@ +<!-- ##### SECTION Title ##### --> +NMSettingWirelessSecurity + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingWirelessSecurityError ##### --> +<para> + +</para> + +@NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN: +@NM_SETTING_WIRELESS_SECURITY_ERROR_INVALID_PROPERTY: +@NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_PROPERTY: +@NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_802_1X_SETTING: +@NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_802_1X: +@NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_USERNAME: +@NM_SETTING_WIRELESS_SECURITY_ERROR_SHARED_KEY_REQUIRES_WEP: + +<!-- ##### MACRO NM_TYPE_SETTING_WIRELESS_SECURITY_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_wireless_security_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### ENUM NMWepKeyType ##### --> +<para> + +</para> + +@NM_WEP_KEY_TYPE_UNKNOWN: +@NM_WEP_KEY_TYPE_KEY: +@NM_WEP_KEY_TYPE_PASSPHRASE: +@NM_WEP_KEY_TYPE_LAST: + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_KEY_MGMT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_AUTH_ALG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PROTO ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PAIRWISE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_GROUP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY0 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY1 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY2 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY3 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PSK ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingWirelessSecurity ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWirelessSecurity:auth-alg ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:group ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:key-mgmt ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:leap-password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:leap-username ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:pairwise ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:proto ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:psk ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:wep-key-type ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:wep-key0 ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:wep-key1 ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:wep-key2 ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:wep-key3 ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:wep-tx-keyidx ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingWirelessSecurityClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_wireless_security_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_key_mgmt ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_num_protos ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_proto ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_add_proto ##### --> +<para> + +</para> + +@setting: +@proto: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_remove_proto ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_wireless_security_clear_protos ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_num_pairwise ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_pairwise ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_add_pairwise ##### --> +<para> + +</para> + +@setting: +@pairwise: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_remove_pairwise ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_wireless_security_clear_pairwise ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_num_groups ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_group ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_add_group ##### --> +<para> + +</para> + +@setting: +@group: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_remove_group ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_wireless_security_clear_groups ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_psk ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_leap_username ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_leap_password ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_key ##### --> +<para> + +</para> + +@setting: +@idx: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_set_wep_key ##### --> +<para> + +</para> + +@setting: +@idx: +@key: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_tx_keyidx ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_auth_alg ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_key_type ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting-wireless.sgml b/docs/libnm-util/tmpl/nm-setting-wireless.sgml new file mode 100644 index 00000000..d1734f16 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting-wireless.sgml @@ -0,0 +1,363 @@ +<!-- ##### SECTION Title ##### --> +NMSettingWireless + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingWirelessError ##### --> +<para> + +</para> + +@NM_SETTING_WIRELESS_ERROR_UNKNOWN: +@NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY: +@NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY: +@NM_SETTING_WIRELESS_ERROR_MISSING_SECURITY_SETTING: +@NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND: + +<!-- ##### MACRO NM_TYPE_SETTING_WIRELESS_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_wireless_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SSID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_MODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_BAND ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_CHANNEL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_BSSID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_RATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_TX_POWER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_MAC_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_MTU ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SEEN_BSSIDS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SEC ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingWireless ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWireless:band ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:bssid ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:channel ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:mac-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:mode ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:mtu ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:rate ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:security ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:seen-bssids ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:ssid ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:tx-power ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingWirelessClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_wireless_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_ssid ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_mode ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_band ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_channel ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_bssid ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_rate ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_tx_power ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_mac_address ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_mtu ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_security ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_add_seen_bssid ##### --> +<para> + +</para> + +@setting: +@bssid: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_num_seen_bssids ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_seen_bssid ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_ap_security_compatible ##### --> +<para> + +</para> + +@s_wireless: +@s_wireless_sec: +@ap_flags: +@ap_wpa: +@ap_rsn: +@ap_mode: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-setting.sgml b/docs/libnm-util/tmpl/nm-setting.sgml new file mode 100644 index 00000000..989e71d1 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting.sgml @@ -0,0 +1,252 @@ +<!-- ##### SECTION Title ##### --> +NMSetting + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM NMSettingError ##### --> +<para> + +</para> + +@NM_SETTING_ERROR_UNKNOWN: +@NM_SETTING_ERROR_PROPERTY_NOT_FOUND: +@NM_SETTING_ERROR_PROPERTY_NOT_SECRET: +@NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH: + +<!-- ##### MACRO NM_TYPE_SETTING_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_PARAM_SERIALIZE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PARAM_REQUIRED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PARAM_SECRET ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PARAM_FUZZY_IGNORE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSetting ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting:name ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingClass ##### --> +<para> + +</para> + +@parent: +@verify: +@need_secrets: +@update_one_secret: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### USER_FUNCTION NMSettingValueIterFn ##### --> +<para> + +</para> + +@setting: +@key: +@value: +@flags: +@user_data: + + +<!-- ##### FUNCTION nm_setting_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_to_hash ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_new_from_hash ##### --> +<para> + +</para> + +@setting_type: +@hash: +@Returns: + + +<!-- ##### FUNCTION nm_setting_duplicate ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_get_name ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_verify ##### --> +<para> + +</para> + +@setting: +@all_settings: +@error: +@Returns: + + +<!-- ##### ENUM NMSettingCompareFlags ##### --> +<para> + +</para> + +@NM_SETTING_COMPARE_FLAG_EXACT: +@NM_SETTING_COMPARE_FLAG_FUZZY: +@NM_SETTING_COMPARE_FLAG_IGNORE_ID: +@NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS: + +<!-- ##### FUNCTION nm_setting_compare ##### --> +<para> + +</para> + +@a: +@b: +@flags: +@Returns: + + +<!-- ##### FUNCTION nm_setting_enumerate_values ##### --> +<para> + +</para> + +@setting: +@func: +@user_data: + + +<!-- ##### FUNCTION nm_setting_to_string ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_clear_secrets ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_need_secrets ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_update_secrets ##### --> +<para> + +</para> + +@setting: +@secrets: +@error: +@Returns: + + diff --git a/docs/libnm-util/tmpl/nm-utils.sgml b/docs/libnm-util/tmpl/nm-utils.sgml new file mode 100644 index 00000000..7c7d3d5e --- /dev/null +++ b/docs/libnm-util/tmpl/nm-utils.sgml @@ -0,0 +1,362 @@ +<!-- ##### SECTION Title ##### --> +nm-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO nm_print_backtrace ##### --> +<para> + +</para> + + + +<!-- ##### MACRO nm_get_timestamp ##### --> +<para> + +</para> + +@timestamp: + + +<!-- ##### MACRO nm_info ##### --> +<para> + +</para> + +@fmt: +@args...: + + +<!-- ##### MACRO nm_info_str ##### --> +<para> + +</para> + +@fmt_str: +@args...: + + +<!-- ##### MACRO nm_debug ##### --> +<para> + +</para> + +@fmt: +@args...: + + +<!-- ##### MACRO nm_debug_str ##### --> +<para> + +</para> + +@fmt_str: +@args...: + + +<!-- ##### MACRO nm_warning ##### --> +<para> + +</para> + +@fmt: +@args...: + + +<!-- ##### MACRO nm_warning_str ##### --> +<para> + +</para> + +@fmt_str: +@args...: + + +<!-- ##### MACRO nm_error ##### --> +<para> + +</para> + +@fmt: +@args...: + + +<!-- ##### MACRO nm_error_str ##### --> +<para> + +</para> + +@fmt_str: +@args...: + + +<!-- ##### FUNCTION nm_utils_init ##### --> +<para> + +</para> + +@error: +@Returns: + + +<!-- ##### FUNCTION nm_utils_deinit ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION nm_utils_is_empty_ssid ##### --> +<para> + +</para> + +@ssid: +@len: +@Returns: + + +<!-- ##### FUNCTION nm_utils_escape_ssid ##### --> +<para> + +</para> + +@ssid: +@len: +@Returns: + + +<!-- ##### FUNCTION nm_utils_same_ssid ##### --> +<para> + +</para> + +@ssid1: +@ssid2: +@ignore_trailing_null: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ssid_to_utf8 ##### --> +<para> + +</para> + +@ssid: +@len: +@Returns: + + +<!-- ##### FUNCTION nm_utils_gvalue_hash_dup ##### --> +<para> + +</para> + +@hash: +@Returns: + + +<!-- ##### FUNCTION nm_utils_slist_free ##### --> +<para> + +</para> + +@list: +@elem_destroy_fn: + + +<!-- ##### ENUM NMUtilsSecurityType ##### --> +<para> + +</para> + +@NMU_SEC_INVALID: +@NMU_SEC_NONE: +@NMU_SEC_STATIC_WEP: +@NMU_SEC_LEAP: +@NMU_SEC_DYNAMIC_WEP: +@NMU_SEC_WPA_PSK: +@NMU_SEC_WPA_ENTERPRISE: +@NMU_SEC_WPA2_PSK: +@NMU_SEC_WPA2_ENTERPRISE: + +<!-- ##### FUNCTION nm_utils_security_valid ##### --> +<para> + +</para> + +@type: +@wifi_caps: +@have_ap: +@adhoc: +@ap_flags: +@ap_wpa: +@ap_rsn: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_addresses_from_gvalue ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_addresses_to_gvalue ##### --> +<para> + +</para> + +@list: +@value: + + +<!-- ##### FUNCTION nm_utils_ip4_routes_from_gvalue ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_routes_to_gvalue ##### --> +<para> + +</para> + +@list: +@value: + + +<!-- ##### FUNCTION nm_utils_ip4_netmask_to_prefix ##### --> +<para> + +</para> + +@netmask: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_prefix_to_netmask ##### --> +<para> + +</para> + +@prefix: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_get_default_prefix ##### --> +<para> + +</para> + +@ip: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_addresses_from_gvalue ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_addresses_to_gvalue ##### --> +<para> + +</para> + +@list: +@value: + + +<!-- ##### FUNCTION nm_utils_ip6_routes_from_gvalue ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_routes_to_gvalue ##### --> +<para> + +</para> + +@list: +@value: + + +<!-- ##### FUNCTION nm_utils_ip6_dns_from_gvalue ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_dns_to_gvalue ##### --> +<para> + +</para> + +@list: +@value: + + +<!-- ##### FUNCTION nm_utils_uuid_generate ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_utils_uuid_generate_from_string ##### --> +<para> + +</para> + +@s: +@Returns: + + +<!-- ##### FUNCTION nm_utils_rsa_key_encrypt ##### --> +<para> + +</para> + +@data: +@in_password: +@out_password: +@error: +@Returns: + + |