diff options
| author | Michael Biebl <biebl@debian.org> | 2015-01-22 00:29:39 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2015-01-22 00:29:39 +0100 |
| commit | 2c032d8f1c6292c1338a615e6ec40252889ba85c (patch) | |
| tree | 1f77182220b2b0264288ba4a476ab47e5bc48716 /docs/libnm/tmpl | |
| parent | 33491bc4279481db8ae47213e34a6d695a0e8830 (diff) | |
Imported Upstream version 1.0.0 upstream/1.0.0
Diffstat (limited to 'docs/libnm/tmpl')
63 files changed, 15555 insertions, 0 deletions
diff --git a/docs/libnm/tmpl/libnm-unused.sgml b/docs/libnm/tmpl/libnm-unused.sgml new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/libnm/tmpl/libnm-unused.sgml diff --git a/docs/libnm/tmpl/nm-access-point.sgml b/docs/libnm/tmpl/nm-access-point.sgml new file mode 100644 index 00000000..8673d766 --- /dev/null +++ b/docs/libnm/tmpl/nm-access-point.sgml @@ -0,0 +1,258 @@ +<!-- ##### SECTION Title ##### --> +NMAccessPoint + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_ACCESS_POINT_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACCESS_POINT_WPA_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACCESS_POINT_RSN_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACCESS_POINT_SSID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACCESS_POINT_BSSID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACCESS_POINT_FREQUENCY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACCESS_POINT_MODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACCESS_POINT_MAX_BITRATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACCESS_POINT_STRENGTH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACCESS_POINT_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMAccessPoint ##### --> +<para> + +</para> + + +<!-- ##### ARG NMAccessPoint:bssid ##### --> +<para> + +</para> + +<!-- ##### ARG NMAccessPoint:flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMAccessPoint:frequency ##### --> +<para> + +</para> + +<!-- ##### ARG NMAccessPoint:hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMAccessPoint:max-bitrate ##### --> +<para> + +</para> + +<!-- ##### ARG NMAccessPoint:mode ##### --> +<para> + +</para> + +<!-- ##### ARG NMAccessPoint:rsn-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMAccessPoint:ssid ##### --> +<para> + +</para> + +<!-- ##### ARG NMAccessPoint:strength ##### --> +<para> + +</para> + +<!-- ##### ARG NMAccessPoint:wpa-flags ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMAccessPointClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_access_point_get_flags ##### --> +<para> + +</para> + +@ap: +@Returns: + + +<!-- ##### FUNCTION nm_access_point_get_wpa_flags ##### --> +<para> + +</para> + +@ap: +@Returns: + + +<!-- ##### FUNCTION nm_access_point_get_rsn_flags ##### --> +<para> + +</para> + +@ap: +@Returns: + + +<!-- ##### FUNCTION nm_access_point_get_ssid ##### --> +<para> + +</para> + +@ap: +@Returns: + + +<!-- ##### FUNCTION nm_access_point_get_bssid ##### --> +<para> + +</para> + +@ap: +@Returns: + + +<!-- ##### FUNCTION nm_access_point_get_frequency ##### --> +<para> + +</para> + +@ap: +@Returns: + + +<!-- ##### FUNCTION nm_access_point_get_mode ##### --> +<para> + +</para> + +@ap: +@Returns: + + +<!-- ##### FUNCTION nm_access_point_get_max_bitrate ##### --> +<para> + +</para> + +@ap: +@Returns: + + +<!-- ##### FUNCTION nm_access_point_get_strength ##### --> +<para> + +</para> + +@ap: +@Returns: + + +<!-- ##### FUNCTION nm_access_point_filter_connections ##### --> +<para> + +</para> + +@ap: +@connections: +@Returns: + + +<!-- ##### FUNCTION nm_access_point_connection_valid ##### --> +<para> + +</para> + +@ap: +@connection: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-active-connection.sgml b/docs/libnm/tmpl/nm-active-connection.sgml new file mode 100644 index 00000000..0fe4bb39 --- /dev/null +++ b/docs/libnm/tmpl/nm-active-connection.sgml @@ -0,0 +1,352 @@ +<!-- ##### SECTION Title ##### --> +NMActiveConnection + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_ID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_UUID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_DEVICES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_STATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_DEFAULT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_IP4_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_DHCP4_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_DEFAULT6 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_IP6_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_DHCP6_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_VPN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_ACTIVE_CONNECTION_MASTER ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMActiveConnection ##### --> +<para> + +</para> + + +<!-- ##### ARG NMActiveConnection:connection ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:default ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:default6 ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:devices ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:dhcp4-config ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:dhcp6-config ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:id ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:ip4-config ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:ip6-config ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:master ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:specific-object-path ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:state ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:type ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:uuid ##### --> +<para> + +</para> + +<!-- ##### ARG NMActiveConnection:vpn ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMActiveConnectionClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_active_connection_get_connection ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_id ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_uuid ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_connection_type ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_specific_object_path ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_devices ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_state ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_master ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_default ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_ip4_config ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_dhcp4_config ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_default6 ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_ip6_config ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_dhcp6_config ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_active_connection_get_vpn ##### --> +<para> + +</para> + +@connection: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-client.sgml b/docs/libnm/tmpl/nm-client.sgml new file mode 100644 index 00000000..32d4edef --- /dev/null +++ b/docs/libnm/tmpl/nm-client.sgml @@ -0,0 +1,952 @@ +<!-- ##### SECTION Title ##### --> +NMClient + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_CLIENT_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_STATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_STARTUP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_NM_RUNNING ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_NETWORKING_ENABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_WIRELESS_ENABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_WIRELESS_HARDWARE_ENABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_WWAN_ENABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_WWAN_HARDWARE_ENABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_WIMAX_ENABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_WIMAX_HARDWARE_ENABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_ACTIVE_CONNECTIONS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_CONNECTIVITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_PRIMARY_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_ACTIVATING_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_DEVICES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_CONNECTIONS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_HOSTNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_CAN_MODIFY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_DEVICE_ADDED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_DEVICE_REMOVED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_PERMISSION_CHANGED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_CONNECTION_ADDED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CLIENT_CONNECTION_REMOVED ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMClientPermission ##### --> +<para> + +</para> + +@NM_CLIENT_PERMISSION_NONE: +@NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK: +@NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI: +@NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN: +@NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX: +@NM_CLIENT_PERMISSION_SLEEP_WAKE: +@NM_CLIENT_PERMISSION_NETWORK_CONTROL: +@NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED: +@NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN: +@NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM: +@NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN: +@NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME: +@NM_CLIENT_PERMISSION_LAST: + +<!-- ##### ENUM NMClientPermissionResult ##### --> +<para> + +</para> + +@NM_CLIENT_PERMISSION_RESULT_UNKNOWN: +@NM_CLIENT_PERMISSION_RESULT_YES: +@NM_CLIENT_PERMISSION_RESULT_AUTH: +@NM_CLIENT_PERMISSION_RESULT_NO: + +<!-- ##### ENUM NMClientError ##### --> +<para> + +</para> + +@NM_CLIENT_ERROR_FAILED: +@NM_CLIENT_ERROR_MANAGER_NOT_RUNNING: +@NM_CLIENT_ERROR_OBJECT_CREATION_FAILED: + +<!-- ##### MACRO NM_CLIENT_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_client_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### STRUCT NMClient ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL NMClient::connection-added ##### --> +<para> + +</para> + +@nmclient: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL NMClient::connection-removed ##### --> +<para> + +</para> + +@nmclient: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL NMClient::device-added ##### --> +<para> + +</para> + +@nmclient: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL NMClient::device-removed ##### --> +<para> + +</para> + +@nmclient: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL NMClient::permission-changed ##### --> +<para> + +</para> + +@nmclient: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### ARG NMClient:activating-connection ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:active-connections ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:can-modify ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:connections ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:connectivity ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:devices ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:hostname ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:networking-enabled ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:nm-running ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:primary-connection ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:startup ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:state ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:version ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:wimax-enabled ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:wimax-hardware-enabled ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:wireless-enabled ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:wireless-hardware-enabled ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:wwan-enabled ##### --> +<para> + +</para> + +<!-- ##### ARG NMClient:wwan-hardware-enabled ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMClientClass ##### --> +<para> + +</para> + +@parent: +@device_added: +@device_removed: +@permission_changed: +@connection_added: +@connection_removed: + +<!-- ##### FUNCTION nm_client_new ##### --> +<para> + +</para> + +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_new_async ##### --> +<para> + +</para> + +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_client_new_finish ##### --> +<para> + +</para> + +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_version ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_state ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_startup ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_nm_running ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_networking_get_enabled ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_networking_set_enabled ##### --> +<para> + +</para> + +@client: +@enabled: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_wireless_get_enabled ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_wireless_set_enabled ##### --> +<para> + +</para> + +@client: +@enabled: + + +<!-- ##### FUNCTION nm_client_wireless_hardware_get_enabled ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_wwan_get_enabled ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_wwan_set_enabled ##### --> +<para> + +</para> + +@client: +@enabled: + + +<!-- ##### FUNCTION nm_client_wwan_hardware_get_enabled ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_wimax_get_enabled ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_wimax_set_enabled ##### --> +<para> + +</para> + +@client: +@enabled: + + +<!-- ##### FUNCTION nm_client_wimax_hardware_get_enabled ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_logging ##### --> +<para> + +</para> + +@client: +@level: +@domains: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_set_logging ##### --> +<para> + +</para> + +@client: +@level: +@domains: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_permission_result ##### --> +<para> + +</para> + +@client: +@permission: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_connectivity ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_check_connectivity ##### --> +<para> + +</para> + +@client: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_check_connectivity_async ##### --> +<para> + +</para> + +@client: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_client_check_connectivity_finish ##### --> +<para> + +</para> + +@client: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_save_hostname ##### --> +<para> + +</para> + +@client: +@hostname: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_save_hostname_async ##### --> +<para> + +</para> + +@client: +@hostname: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_client_save_hostname_finish ##### --> +<para> + +</para> + +@client: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_devices ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_device_by_path ##### --> +<para> + +</para> + +@client: +@object_path: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_device_by_iface ##### --> +<para> + +</para> + +@client: +@iface: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_active_connections ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_primary_connection ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_activating_connection ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_activate_connection_async ##### --> +<para> + +</para> + +@client: +@connection: +@device: +@specific_object: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_client_activate_connection_finish ##### --> +<para> + +</para> + +@client: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_add_and_activate_connection_async ##### --> +<para> + +</para> + +@client: +@partial: +@device: +@specific_object: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_client_add_and_activate_connection_finish ##### --> +<para> + +</para> + +@client: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_deactivate_connection ##### --> +<para> + +</para> + +@client: +@active: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_deactivate_connection_async ##### --> +<para> + +</para> + +@client: +@active: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_client_deactivate_connection_finish ##### --> +<para> + +</para> + +@client: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_connections ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_connection_by_id ##### --> +<para> + +</para> + +@client: +@id: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_connection_by_path ##### --> +<para> + +</para> + +@client: +@path: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_connection_by_uuid ##### --> +<para> + +</para> + +@client: +@uuid: +@Returns: + + +<!-- ##### FUNCTION nm_client_add_connection_async ##### --> +<para> + +</para> + +@client: +@connection: +@save_to_disk: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_client_add_connection_finish ##### --> +<para> + +</para> + +@client: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_load_connections ##### --> +<para> + +</para> + +@client: +@filenames: +@failures: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_load_connections_async ##### --> +<para> + +</para> + +@client: +@filenames: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_client_load_connections_finish ##### --> +<para> + +</para> + +@client: +@failures: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_reload_connections ##### --> +<para> + +</para> + +@client: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_reload_connections_async ##### --> +<para> + +</para> + +@client: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_client_reload_connections_finish ##### --> +<para> + +</para> + +@client: +@result: +@error: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-connection.sgml b/docs/libnm/tmpl/nm-connection.sgml new file mode 100644 index 00000000..804f0cb2 --- /dev/null +++ b/docs/libnm/tmpl/nm-connection.sgml @@ -0,0 +1,573 @@ +<!-- ##### SECTION Title ##### --> +NMConnection + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_CONNECTION_SECRETS_UPDATED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CONNECTION_SECRETS_CLEARED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CONNECTION_CHANGED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMConnectionInterface ##### --> +<para> + +</para> + +@parent: +@secrets_updated: +@secrets_cleared: +@changed: + +<!-- ##### 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: + + +<!-- ##### MACRO NM_VARIANT_TYPE_SETTING ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMConnectionSerializationFlags ##### --> +<para> + +</para> + +@NM_CONNECTION_SERIALIZE_ALL: +@NM_CONNECTION_SERIALIZE_NO_SECRETS: +@NM_CONNECTION_SERIALIZE_ONLY_SECRETS: + +<!-- ##### FUNCTION nm_connection_to_dbus ##### --> +<para> + +</para> + +@connection: +@flags: +@Returns: + + +<!-- ##### FUNCTION nm_connection_replace_settings ##### --> +<para> + +</para> + +@connection: +@new_settings: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_connection_replace_settings_from_connection ##### --> +<para> + +</para> + +@connection: +@new_connection: + + +<!-- ##### FUNCTION nm_connection_clear_settings ##### --> +<para> + +</para> + +@connection: + + +<!-- ##### FUNCTION nm_connection_compare ##### --> +<para> + +</para> + +@a: +@b: +@flags: +@Returns: + + +<!-- ##### FUNCTION nm_connection_diff ##### --> +<para> + +</para> + +@a: +@b: +@flags: +@out_settings: +@Returns: + + +<!-- ##### FUNCTION nm_connection_verify ##### --> +<para> + +</para> + +@connection: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_connection_normalize ##### --> +<para> + +</para> + +@connection: +@parameters: +@modified: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_connection_need_secrets ##### --> +<para> + +</para> + +@connection: +@hints: +@Returns: + + +<!-- ##### FUNCTION nm_connection_clear_secrets ##### --> +<para> + +</para> + +@connection: + + +<!-- ##### FUNCTION nm_connection_clear_secrets_with_flags ##### --> +<para> + +</para> + +@connection: +@func: +@user_data: + + +<!-- ##### FUNCTION nm_connection_update_secrets ##### --> +<para> + +</para> + +@connection: +@setting_name: +@secrets: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_connection_set_path ##### --> +<para> + +</para> + +@connection: +@path: + + +<!-- ##### FUNCTION nm_connection_get_path ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_interface_name ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_is_type ##### --> +<para> + +</para> + +@connection: +@type: +@Returns: + + +<!-- ##### FUNCTION nm_connection_for_each_setting_value ##### --> +<para> + +</para> + +@connection: +@func: +@user_data: + + +<!-- ##### FUNCTION nm_connection_dump ##### --> +<para> + +</para> + +@connection: + + +<!-- ##### FUNCTION nm_connection_get_uuid ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_id ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_connection_type ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_is_virtual ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_virtual_device_description ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_802_1x ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_bluetooth ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_bond ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_team ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_team_port ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_bridge ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_bridge_port ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_cdma ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_connection ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_dcb ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_generic ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_gsm ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_infiniband ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_ip4_config ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_ip6_config ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_olpc_mesh ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_ppp ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_pppoe ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_serial ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_vpn ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_wimax ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_adsl ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_wired ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_wireless ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_wireless_security ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_connection_get_setting_vlan ##### --> +<para> + +</para> + +@connection: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-core-enum-types.sgml b/docs/libnm/tmpl/nm-core-enum-types.sgml new file mode 100644 index 00000000..68f14ec3 --- /dev/null +++ b/docs/libnm/tmpl/nm-core-enum-types.sgml @@ -0,0 +1,24 @@ +<!-- ##### SECTION Title ##### --> +nm-core-enum-types + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + diff --git a/docs/libnm/tmpl/nm-dbus-interface.sgml b/docs/libnm/tmpl/nm-dbus-interface.sgml new file mode 100644 index 00000000..287ab8c7 --- /dev/null +++ b/docs/libnm/tmpl/nm-dbus-interface.sgml @@ -0,0 +1,548 @@ +<!-- ##### SECTION Title ##### --> +nm-dbus-interface + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DBUS_SERVICE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_WIRED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_ADSL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_WIRELESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_BLUETOOTH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_OLPC_MESH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_PATH_ACCESS_POINT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_ACCESS_POINT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_MODEM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_WIMAX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_WIMAX_NSP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_PATH_WIMAX_NSP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_ACTIVE_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_IP4_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DHCP4_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_IP6_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DHCP6_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_INFINIBAND ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_BOND ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_TEAM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_VLAN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_BRIDGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_GENERIC ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_VETH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_TUN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_MACVLAN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_VXLAN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_DEVICE_GRE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_SETTINGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_PATH_SETTINGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_SETTINGS_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_PATH_SETTINGS_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_SETTINGS_CONNECTION_SECRETS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_AGENT_MANAGER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_PATH_AGENT_MANAGER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_SECRET_AGENT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_PATH_SECRET_AGENT ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMState ##### --> +<para> + +</para> + +@NM_STATE_UNKNOWN: +@NM_STATE_ASLEEP: +@NM_STATE_DISCONNECTED: +@NM_STATE_DISCONNECTING: +@NM_STATE_CONNECTING: +@NM_STATE_CONNECTED_LOCAL: +@NM_STATE_CONNECTED_SITE: +@NM_STATE_CONNECTED_GLOBAL: + +<!-- ##### ENUM NMConnectivityState ##### --> +<para> + +</para> + +@NM_CONNECTIVITY_UNKNOWN: +@NM_CONNECTIVITY_NONE: +@NM_CONNECTIVITY_PORTAL: +@NM_CONNECTIVITY_LIMITED: +@NM_CONNECTIVITY_FULL: + +<!-- ##### ENUM NMDeviceType ##### --> +<para> + +</para> + +@NM_DEVICE_TYPE_UNKNOWN: +@NM_DEVICE_TYPE_ETHERNET: +@NM_DEVICE_TYPE_WIFI: +@NM_DEVICE_TYPE_UNUSED1: +@NM_DEVICE_TYPE_UNUSED2: +@NM_DEVICE_TYPE_BT: +@NM_DEVICE_TYPE_OLPC_MESH: +@NM_DEVICE_TYPE_WIMAX: +@NM_DEVICE_TYPE_MODEM: +@NM_DEVICE_TYPE_INFINIBAND: +@NM_DEVICE_TYPE_BOND: +@NM_DEVICE_TYPE_VLAN: +@NM_DEVICE_TYPE_ADSL: +@NM_DEVICE_TYPE_BRIDGE: +@NM_DEVICE_TYPE_GENERIC: +@NM_DEVICE_TYPE_TEAM: + +<!-- ##### ENUM NMDeviceCapabilities ##### --> +<para> + +</para> + +@NM_DEVICE_CAP_NONE: +@NM_DEVICE_CAP_NM_SUPPORTED: +@NM_DEVICE_CAP_CARRIER_DETECT: +@NM_DEVICE_CAP_IS_SOFTWARE: + +<!-- ##### ENUM NMDeviceWifiCapabilities ##### --> +<para> + +</para> + +@NM_WIFI_DEVICE_CAP_NONE: +@NM_WIFI_DEVICE_CAP_CIPHER_WEP40: +@NM_WIFI_DEVICE_CAP_CIPHER_WEP104: +@NM_WIFI_DEVICE_CAP_CIPHER_TKIP: +@NM_WIFI_DEVICE_CAP_CIPHER_CCMP: +@NM_WIFI_DEVICE_CAP_WPA: +@NM_WIFI_DEVICE_CAP_RSN: +@NM_WIFI_DEVICE_CAP_AP: +@NM_WIFI_DEVICE_CAP_ADHOC: + +<!-- ##### ENUM NM80211ApFlags ##### --> +<para> + +</para> + +@NM_802_11_AP_FLAGS_NONE: +@NM_802_11_AP_FLAGS_PRIVACY: + +<!-- ##### ENUM NM80211ApSecurityFlags ##### --> +<para> + +</para> + +@NM_802_11_AP_SEC_NONE: +@NM_802_11_AP_SEC_PAIR_WEP40: +@NM_802_11_AP_SEC_PAIR_WEP104: +@NM_802_11_AP_SEC_PAIR_TKIP: +@NM_802_11_AP_SEC_PAIR_CCMP: +@NM_802_11_AP_SEC_GROUP_WEP40: +@NM_802_11_AP_SEC_GROUP_WEP104: +@NM_802_11_AP_SEC_GROUP_TKIP: +@NM_802_11_AP_SEC_GROUP_CCMP: +@NM_802_11_AP_SEC_KEY_MGMT_PSK: +@NM_802_11_AP_SEC_KEY_MGMT_802_1X: + +<!-- ##### ENUM NM80211Mode ##### --> +<para> + +</para> + +@NM_802_11_MODE_UNKNOWN: +@NM_802_11_MODE_ADHOC: +@NM_802_11_MODE_INFRA: +@NM_802_11_MODE_AP: + +<!-- ##### ENUM NMBluetoothCapabilities ##### --> +<para> + +</para> + +@NM_BT_CAPABILITY_NONE: +@NM_BT_CAPABILITY_DUN: +@NM_BT_CAPABILITY_NAP: + +<!-- ##### ENUM NMDeviceModemCapabilities ##### --> +<para> + +</para> + +@NM_DEVICE_MODEM_CAPABILITY_NONE: +@NM_DEVICE_MODEM_CAPABILITY_POTS: +@NM_DEVICE_MODEM_CAPABILITY_CDMA_EVDO: +@NM_DEVICE_MODEM_CAPABILITY_GSM_UMTS: +@NM_DEVICE_MODEM_CAPABILITY_LTE: + +<!-- ##### ENUM NMDeviceState ##### --> +<para> + +</para> + +@NM_DEVICE_STATE_UNKNOWN: +@NM_DEVICE_STATE_UNMANAGED: +@NM_DEVICE_STATE_UNAVAILABLE: +@NM_DEVICE_STATE_DISCONNECTED: +@NM_DEVICE_STATE_PREPARE: +@NM_DEVICE_STATE_CONFIG: +@NM_DEVICE_STATE_NEED_AUTH: +@NM_DEVICE_STATE_IP_CONFIG: +@NM_DEVICE_STATE_IP_CHECK: +@NM_DEVICE_STATE_SECONDARIES: +@NM_DEVICE_STATE_ACTIVATED: +@NM_DEVICE_STATE_DEACTIVATING: +@NM_DEVICE_STATE_FAILED: + +<!-- ##### ENUM NMDeviceStateReason ##### --> +<para> + +</para> + +@NM_DEVICE_STATE_REASON_NONE: +@NM_DEVICE_STATE_REASON_UNKNOWN: +@NM_DEVICE_STATE_REASON_NOW_MANAGED: +@NM_DEVICE_STATE_REASON_NOW_UNMANAGED: +@NM_DEVICE_STATE_REASON_CONFIG_FAILED: +@NM_DEVICE_STATE_REASON_IP_CONFIG_UNAVAILABLE: +@NM_DEVICE_STATE_REASON_IP_CONFIG_EXPIRED: +@NM_DEVICE_STATE_REASON_NO_SECRETS: +@NM_DEVICE_STATE_REASON_SUPPLICANT_DISCONNECT: +@NM_DEVICE_STATE_REASON_SUPPLICANT_CONFIG_FAILED: +@NM_DEVICE_STATE_REASON_SUPPLICANT_FAILED: +@NM_DEVICE_STATE_REASON_SUPPLICANT_TIMEOUT: +@NM_DEVICE_STATE_REASON_PPP_START_FAILED: +@NM_DEVICE_STATE_REASON_PPP_DISCONNECT: +@NM_DEVICE_STATE_REASON_PPP_FAILED: +@NM_DEVICE_STATE_REASON_DHCP_START_FAILED: +@NM_DEVICE_STATE_REASON_DHCP_ERROR: +@NM_DEVICE_STATE_REASON_DHCP_FAILED: +@NM_DEVICE_STATE_REASON_SHARED_START_FAILED: +@NM_DEVICE_STATE_REASON_SHARED_FAILED: +@NM_DEVICE_STATE_REASON_AUTOIP_START_FAILED: +@NM_DEVICE_STATE_REASON_AUTOIP_ERROR: +@NM_DEVICE_STATE_REASON_AUTOIP_FAILED: +@NM_DEVICE_STATE_REASON_MODEM_BUSY: +@NM_DEVICE_STATE_REASON_MODEM_NO_DIAL_TONE: +@NM_DEVICE_STATE_REASON_MODEM_NO_CARRIER: +@NM_DEVICE_STATE_REASON_MODEM_DIAL_TIMEOUT: +@NM_DEVICE_STATE_REASON_MODEM_DIAL_FAILED: +@NM_DEVICE_STATE_REASON_MODEM_INIT_FAILED: +@NM_DEVICE_STATE_REASON_GSM_APN_FAILED: +@NM_DEVICE_STATE_REASON_GSM_REGISTRATION_NOT_SEARCHING: +@NM_DEVICE_STATE_REASON_GSM_REGISTRATION_DENIED: +@NM_DEVICE_STATE_REASON_GSM_REGISTRATION_TIMEOUT: +@NM_DEVICE_STATE_REASON_GSM_REGISTRATION_FAILED: +@NM_DEVICE_STATE_REASON_GSM_PIN_CHECK_FAILED: +@NM_DEVICE_STATE_REASON_FIRMWARE_MISSING: +@NM_DEVICE_STATE_REASON_REMOVED: +@NM_DEVICE_STATE_REASON_SLEEPING: +@NM_DEVICE_STATE_REASON_CONNECTION_REMOVED: +@NM_DEVICE_STATE_REASON_USER_REQUESTED: +@NM_DEVICE_STATE_REASON_CARRIER: +@NM_DEVICE_STATE_REASON_CONNECTION_ASSUMED: +@NM_DEVICE_STATE_REASON_SUPPLICANT_AVAILABLE: +@NM_DEVICE_STATE_REASON_MODEM_NOT_FOUND: +@NM_DEVICE_STATE_REASON_BT_FAILED: +@NM_DEVICE_STATE_REASON_GSM_SIM_NOT_INSERTED: +@NM_DEVICE_STATE_REASON_GSM_SIM_PIN_REQUIRED: +@NM_DEVICE_STATE_REASON_GSM_SIM_PUK_REQUIRED: +@NM_DEVICE_STATE_REASON_GSM_SIM_WRONG: +@NM_DEVICE_STATE_REASON_INFINIBAND_MODE: +@NM_DEVICE_STATE_REASON_DEPENDENCY_FAILED: +@NM_DEVICE_STATE_REASON_BR2684_FAILED: +@NM_DEVICE_STATE_REASON_MODEM_MANAGER_UNAVAILABLE: +@NM_DEVICE_STATE_REASON_SSID_NOT_FOUND: +@NM_DEVICE_STATE_REASON_SECONDARY_CONNECTION_FAILED: +@NM_DEVICE_STATE_REASON_DCB_FCOE_FAILED: +@NM_DEVICE_STATE_REASON_TEAMD_CONTROL_FAILED: +@NM_DEVICE_STATE_REASON_MODEM_FAILED: +@NM_DEVICE_STATE_REASON_MODEM_AVAILABLE: +@NM_DEVICE_STATE_REASON_SIM_PIN_INCORRECT: + +<!-- ##### ENUM NMActiveConnectionState ##### --> +<para> + +</para> + +@NM_ACTIVE_CONNECTION_STATE_UNKNOWN: +@NM_ACTIVE_CONNECTION_STATE_ACTIVATING: +@NM_ACTIVE_CONNECTION_STATE_ACTIVATED: +@NM_ACTIVE_CONNECTION_STATE_DEACTIVATING: +@NM_ACTIVE_CONNECTION_STATE_DEACTIVATED: + +<!-- ##### ENUM NMSecretAgentGetSecretsFlags ##### --> +<para> + +</para> + +@NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE: +@NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION: +@NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW: +@NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED: +@NM_SECRET_AGENT_GET_SECRETS_FLAG_ONLY_SYSTEM: +@NM_SECRET_AGENT_GET_SECRETS_FLAG_NO_ERRORS: + +<!-- ##### ENUM NMSecretAgentCapabilities ##### --> +<para> + +</para> + +@NM_SECRET_AGENT_CAPABILITY_NONE: +@NM_SECRET_AGENT_CAPABILITY_VPN_HINTS: +@NM_SECRET_AGENT_CAPABILITY_LAST: + diff --git a/docs/libnm/tmpl/nm-device-adsl.sgml b/docs/libnm/tmpl/nm-device-adsl.sgml new file mode 100644 index 00000000..406c572c --- /dev/null +++ b/docs/libnm/tmpl/nm-device-adsl.sgml @@ -0,0 +1,58 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceAdsl + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_ADSL_CARRIER ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceAdsl ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceAdsl:carrier ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceAdslClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_adsl_get_carrier ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-bond.sgml b/docs/libnm/tmpl/nm-device-bond.sgml new file mode 100644 index 00000000..b444ff3d --- /dev/null +++ b/docs/libnm/tmpl/nm-device-bond.sgml @@ -0,0 +1,100 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceBond + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_BOND_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_BOND_CARRIER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_BOND_SLAVES ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceBond ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceBond:carrier ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceBond:hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceBond:slaves ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceBondClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_bond_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_bond_get_carrier ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_bond_get_slaves ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-bridge.sgml b/docs/libnm/tmpl/nm-device-bridge.sgml new file mode 100644 index 00000000..4a0e1595 --- /dev/null +++ b/docs/libnm/tmpl/nm-device-bridge.sgml @@ -0,0 +1,100 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceBridge + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_BRIDGE_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_BRIDGE_CARRIER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_BRIDGE_SLAVES ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceBridge ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceBridge:carrier ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceBridge:hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceBridge:slaves ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceBridgeClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_bridge_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_bridge_get_carrier ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_bridge_get_slaves ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-bt.sgml b/docs/libnm/tmpl/nm-device-bt.sgml new file mode 100644 index 00000000..5765f666 --- /dev/null +++ b/docs/libnm/tmpl/nm-device-bt.sgml @@ -0,0 +1,100 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceBt + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_BT_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_BT_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_BT_CAPABILITIES ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceBt ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceBt:bt-capabilities ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceBt:hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceBt:name ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceBtClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_bt_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_bt_get_name ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_bt_get_capabilities ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-ethernet.sgml b/docs/libnm/tmpl/nm-device-ethernet.sgml new file mode 100644 index 00000000..6a004bf0 --- /dev/null +++ b/docs/libnm/tmpl/nm-device-ethernet.sgml @@ -0,0 +1,121 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceEthernet + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_ETHERNET_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_ETHERNET_SPEED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_ETHERNET_CARRIER ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceEthernet ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceEthernet:carrier ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceEthernet:hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceEthernet:perm-hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceEthernet:speed ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceEthernetClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_ethernet_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_ethernet_get_permanent_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_ethernet_get_speed ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_ethernet_get_carrier ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-generic.sgml b/docs/libnm/tmpl/nm-device-generic.sgml new file mode 100644 index 00000000..c93ed4cc --- /dev/null +++ b/docs/libnm/tmpl/nm-device-generic.sgml @@ -0,0 +1,70 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceGeneric + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_GENERIC_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_GENERIC_TYPE_DESCRIPTION ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceGeneric ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceGeneric:hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceGeneric:type-description ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceGenericClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_generic_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-infiniband.sgml b/docs/libnm/tmpl/nm-device-infiniband.sgml new file mode 100644 index 00000000..626c0e3d --- /dev/null +++ b/docs/libnm/tmpl/nm-device-infiniband.sgml @@ -0,0 +1,79 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceInfiniband + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_INFINIBAND_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_INFINIBAND_CARRIER ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceInfiniband ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceInfiniband:carrier ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceInfiniband:hw-address ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceInfinibandClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_infiniband_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_infiniband_get_carrier ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-modem.sgml b/docs/libnm/tmpl/nm-device-modem.sgml new file mode 100644 index 00000000..c582ddbd --- /dev/null +++ b/docs/libnm/tmpl/nm-device-modem.sgml @@ -0,0 +1,79 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceModem + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_MODEM_MODEM_CAPABILITIES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_MODEM_CURRENT_CAPABILITIES ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceModem ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceModem:current-capabilities ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceModem:modem-capabilities ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceModemClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_modem_get_modem_capabilities ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION nm_device_modem_get_current_capabilities ##### --> +<para> + +</para> + +@self: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-olpc-mesh.sgml b/docs/libnm/tmpl/nm-device-olpc-mesh.sgml new file mode 100644 index 00000000..bcc857ae --- /dev/null +++ b/docs/libnm/tmpl/nm-device-olpc-mesh.sgml @@ -0,0 +1,100 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceOlpcMesh + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_OLPC_MESH_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_OLPC_MESH_COMPANION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceOlpcMesh ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceOlpcMesh:active-channel ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceOlpcMesh:companion ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceOlpcMesh:hw-address ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceOlpcMeshClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_olpc_mesh_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_olpc_mesh_get_companion ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_olpc_mesh_get_active_channel ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-team.sgml b/docs/libnm/tmpl/nm-device-team.sgml new file mode 100644 index 00000000..de047234 --- /dev/null +++ b/docs/libnm/tmpl/nm-device-team.sgml @@ -0,0 +1,100 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceTeam + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_TEAM_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_TEAM_CARRIER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_TEAM_SLAVES ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceTeam ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceTeam:carrier ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceTeam:hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceTeam:slaves ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceTeamClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_team_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_team_get_carrier ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_team_get_slaves ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-vlan.sgml b/docs/libnm/tmpl/nm-device-vlan.sgml new file mode 100644 index 00000000..8607d3e0 --- /dev/null +++ b/docs/libnm/tmpl/nm-device-vlan.sgml @@ -0,0 +1,121 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceVlan + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_VLAN_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_VLAN_CARRIER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_VLAN_PARENT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_VLAN_VLAN_ID ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceVlan ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDeviceVlan:carrier ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceVlan:hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceVlan:parent ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceVlan:vlan-id ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceVlanClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_device_vlan_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_vlan_get_carrier ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_vlan_get_parent ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_vlan_get_vlan_id ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-wifi.sgml b/docs/libnm/tmpl/nm-device-wifi.sgml new file mode 100644 index 00000000..d1947631 --- /dev/null +++ b/docs/libnm/tmpl/nm-device-wifi.sgml @@ -0,0 +1,245 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceWifi + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_WIFI_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIFI_MODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIFI_BITRATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIFI_CAPABILITIES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIFI_ACCESS_POINTS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceWifi ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL NMDeviceWifi::access-point-added ##### --> +<para> + +</para> + +@nmdevicewifi: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL NMDeviceWifi::access-point-removed ##### --> +<para> + +</para> + +@nmdevicewifi: the object which received the signal. +@arg1: + +<!-- ##### ARG NMDeviceWifi:access-points ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWifi:active-access-point ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWifi:bitrate ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWifi:hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWifi:mode ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWifi:perm-hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWifi:wireless-capabilities ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceWifiClass ##### --> +<para> + +</para> + +@parent: +@access_point_added: +@access_point_removed: + +<!-- ##### FUNCTION nm_device_wifi_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_wifi_get_permanent_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_wifi_get_mode ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_wifi_get_bitrate ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_wifi_get_capabilities ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_wifi_get_active_access_point ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_wifi_get_access_point_by_path ##### --> +<para> + +</para> + +@device: +@path: +@Returns: + + +<!-- ##### FUNCTION nm_device_wifi_get_access_points ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_wifi_request_scan ##### --> +<para> + +</para> + +@device: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_device_wifi_request_scan_async ##### --> +<para> + +</para> + +@device: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_device_wifi_request_scan_finish ##### --> +<para> + +</para> + +@device: +@result: +@error: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device-wimax.sgml b/docs/libnm/tmpl/nm-device-wimax.sgml new file mode 100644 index 00000000..fcbac1e5 --- /dev/null +++ b/docs/libnm/tmpl/nm-device-wimax.sgml @@ -0,0 +1,233 @@ +<!-- ##### SECTION Title ##### --> +NMDeviceWimax + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_WIMAX_HW_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIMAX_ACTIVE_NSP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIMAX_CENTER_FREQUENCY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIMAX_RSSI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIMAX_CINR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIMAX_TX_POWER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIMAX_BSID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_WIMAX_NSPS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDeviceWimax ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL NMDeviceWimax::nsp-added ##### --> +<para> + +</para> + +@nmdevicewimax: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL NMDeviceWimax::nsp-removed ##### --> +<para> + +</para> + +@nmdevicewimax: the object which received the signal. +@arg1: + +<!-- ##### ARG NMDeviceWimax:active-nsp ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWimax:bsid ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWimax:center-frequency ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWimax:cinr ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWimax:hw-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWimax:nsps ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWimax:rssi ##### --> +<para> + +</para> + +<!-- ##### ARG NMDeviceWimax:tx-power ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceWimaxClass ##### --> +<para> + +</para> + +@parent: +@nsp_added: +@nsp_removed: + +<!-- ##### FUNCTION nm_device_wimax_get_hw_address ##### --> +<para> + +</para> + +@wimax: +@Returns: + + +<!-- ##### FUNCTION nm_device_wimax_get_active_nsp ##### --> +<para> + +</para> + +@wimax: +@Returns: + + +<!-- ##### FUNCTION nm_device_wimax_get_nsp_by_path ##### --> +<para> + +</para> + +@wimax: +@path: +@Returns: + + +<!-- ##### FUNCTION nm_device_wimax_get_nsps ##### --> +<para> + +</para> + +@wimax: +@Returns: + + +<!-- ##### FUNCTION nm_device_wimax_get_center_frequency ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION nm_device_wimax_get_rssi ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION nm_device_wimax_get_cinr ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION nm_device_wimax_get_tx_power ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION nm_device_wimax_get_bsid ##### --> +<para> + +</para> + +@self: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-device.sgml b/docs/libnm/tmpl/nm-device.sgml new file mode 100644 index 00000000..5bd99db5 --- /dev/null +++ b/docs/libnm/tmpl/nm-device.sgml @@ -0,0 +1,696 @@ +<!-- ##### SECTION Title ##### --> +NMDevice + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DEVICE_DEVICE_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_UDI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_INTERFACE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_IP_INTERFACE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_DRIVER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_DRIVER_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_FIRMWARE_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_CAPABILITIES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_MANAGED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_AUTOCONNECT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_FIRMWARE_MISSING ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_IP4_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_DHCP4_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_IP6_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_DHCP6_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_STATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_STATE_REASON ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_ACTIVE_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_AVAILABLE_CONNECTIONS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_VENDOR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_PRODUCT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_PHYSICAL_PORT_ID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEVICE_MTU ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMDevice ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL NMDevice::state-changed ##### --> +<para> + +</para> + +@nmdevice: the object which received the signal. +@arg1: +@arg2: +@arg3: + +<!-- ##### ARG NMDevice:active-connection ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:autoconnect ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:available-connections ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:capabilities ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:device-type ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:dhcp4-config ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:dhcp6-config ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:driver ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:driver-version ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:firmware-missing ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:firmware-version ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:interface ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:ip-interface ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:ip4-config ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:ip6-config ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:managed ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:mtu ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:physical-port-id ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:product ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:state ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:state-reason ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:udi ##### --> +<para> + +</para> + +<!-- ##### ARG NMDevice:vendor ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDeviceClass ##### --> +<para> + +</para> + +@parent: +@state_changed: +@connection_compatible: +@get_type_description: +@get_hw_address: +@get_setting_type: + +<!-- ##### FUNCTION nm_device_get_iface ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_ip_iface ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_device_type ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_udi ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_driver ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_driver_version ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_firmware_version ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_type_description ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_hw_address ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_capabilities ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_managed ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_autoconnect ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_set_autoconnect ##### --> +<para> + +</para> + +@device: +@autoconnect: + + +<!-- ##### FUNCTION nm_device_get_firmware_missing ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_ip4_config ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_dhcp4_config ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_ip6_config ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_dhcp6_config ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_state ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_state_reason ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_active_connection ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_available_connections ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_physical_port_id ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_mtu ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_is_software ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_product ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_vendor ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_description ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION nm_device_disambiguate_names ##### --> +<para> + +</para> + +@devices: +@num_devices: +@Returns: + + +<!-- ##### FUNCTION nm_device_disconnect ##### --> +<para> + +</para> + +@device: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_device_disconnect_async ##### --> +<para> + +</para> + +@device: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_device_disconnect_finish ##### --> +<para> + +</para> + +@device: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_device_delete ##### --> +<para> + +</para> + +@device: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_device_delete_async ##### --> +<para> + +</para> + +@device: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_device_delete_finish ##### --> +<para> + +</para> + +@device: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_device_filter_connections ##### --> +<para> + +</para> + +@device: +@connections: +@Returns: + + +<!-- ##### FUNCTION nm_device_connection_valid ##### --> +<para> + +</para> + +@device: +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_device_connection_compatible ##### --> +<para> + +</para> + +@device: +@connection: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_device_get_setting_type ##### --> +<para> + +</para> + +@device: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-dhcp-config.sgml b/docs/libnm/tmpl/nm-dhcp-config.sgml new file mode 100644 index 00000000..6d5af6f0 --- /dev/null +++ b/docs/libnm/tmpl/nm-dhcp-config.sgml @@ -0,0 +1,89 @@ +<!-- ##### SECTION Title ##### --> +NMDhcpConfig + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT NMDhcpConfig ##### --> +<para> + +</para> + + +<!-- ##### ARG NMDhcpConfig:family ##### --> +<para> + +</para> + +<!-- ##### ARG NMDhcpConfig:options ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMDhcpConfigClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### MACRO NM_DHCP_CONFIG_FAMILY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DHCP_CONFIG_OPTIONS ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_dhcp_config_get_family ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION nm_dhcp_config_get_options ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION nm_dhcp_config_get_one_option ##### --> +<para> + +</para> + +@config: +@option: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-enum-types.sgml b/docs/libnm/tmpl/nm-enum-types.sgml new file mode 100644 index 00000000..8577600d --- /dev/null +++ b/docs/libnm/tmpl/nm-enum-types.sgml @@ -0,0 +1,24 @@ +<!-- ##### SECTION Title ##### --> +nm-enum-types + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + diff --git a/docs/libnm/tmpl/nm-errors.sgml b/docs/libnm/tmpl/nm-errors.sgml new file mode 100644 index 00000000..8c79b479 --- /dev/null +++ b/docs/libnm/tmpl/nm-errors.sgml @@ -0,0 +1,263 @@ +<!-- ##### SECTION Title ##### --> +nm-errors + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM NMAgentManagerError ##### --> +<para> + +</para> + +@NM_AGENT_MANAGER_ERROR_FAILED: +@NM_AGENT_MANAGER_ERROR_PERMISSION_DENIED: +@NM_AGENT_MANAGER_ERROR_INVALID_IDENTIFIER: +@NM_AGENT_MANAGER_ERROR_NOT_REGISTERED: +@NM_AGENT_MANAGER_ERROR_NO_SECRETS: +@NM_AGENT_MANAGER_ERROR_USER_CANCELED: + +<!-- ##### FUNCTION nm_agent_manager_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_AGENT_MANAGER_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMConnectionError ##### --> +<para> + +</para> + +@NM_CONNECTION_ERROR_FAILED: +@NM_CONNECTION_ERROR_SETTING_NOT_FOUND: +@NM_CONNECTION_ERROR_PROPERTY_NOT_FOUND: +@NM_CONNECTION_ERROR_PROPERTY_NOT_SECRET: +@NM_CONNECTION_ERROR_MISSING_SETTING: +@NM_CONNECTION_ERROR_INVALID_SETTING: +@NM_CONNECTION_ERROR_MISSING_PROPERTY: +@NM_CONNECTION_ERROR_INVALID_PROPERTY: + +<!-- ##### MACRO NM_CONNECTION_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_connection_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### ENUM NMCryptoError ##### --> +<para> + +</para> + +@NM_CRYPTO_ERROR_FAILED: +@NM_CRYPTO_ERROR_INVALID_DATA: +@NM_CRYPTO_ERROR_INVALID_PASSWORD: +@NM_CRYPTO_ERROR_UNKNOWN_CIPHER: +@NM_CRYPTO_ERROR_DECRYPTION_FAILED: +@NM_CRYPTO_ERROR_ENCRYPTION_FAILED: + +<!-- ##### MACRO NM_CRYPTO_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_crypto_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### ENUM NMDeviceError ##### --> +<para> + +</para> + +@NM_DEVICE_ERROR_FAILED: +@NM_DEVICE_ERROR_CREATION_FAILED: +@NM_DEVICE_ERROR_INVALID_CONNECTION: +@NM_DEVICE_ERROR_INCOMPATIBLE_CONNECTION: +@NM_DEVICE_ERROR_NOT_ACTIVE: +@NM_DEVICE_ERROR_NOT_SOFTWARE: +@NM_DEVICE_ERROR_NOT_ALLOWED: +@NM_DEVICE_ERROR_SPECIFIC_OBJECT_NOT_FOUND: + +<!-- ##### MACRO NM_DEVICE_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_device_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### ENUM NMManagerError ##### --> +<para> + +</para> + +@NM_MANAGER_ERROR_FAILED: +@NM_MANAGER_ERROR_PERMISSION_DENIED: +@NM_MANAGER_ERROR_UNKNOWN_CONNECTION: +@NM_MANAGER_ERROR_UNKNOWN_DEVICE: +@NM_MANAGER_ERROR_CONNECTION_NOT_AVAILABLE: +@NM_MANAGER_ERROR_CONNECTION_NOT_ACTIVE: +@NM_MANAGER_ERROR_CONNECTION_ALREADY_ACTIVE: +@NM_MANAGER_ERROR_DEPENDENCY_FAILED: +@NM_MANAGER_ERROR_ALREADY_ASLEEP_OR_AWAKE: +@NM_MANAGER_ERROR_ALREADY_ENABLED_OR_DISABLED: +@NM_MANAGER_ERROR_UNKNOWN_LOG_LEVEL: +@NM_MANAGER_ERROR_UNKNOWN_LOG_DOMAIN: + +<!-- ##### FUNCTION nm_manager_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_MANAGER_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSecretAgentError ##### --> +<para> + +</para> + +@NM_SECRET_AGENT_ERROR_FAILED: +@NM_SECRET_AGENT_ERROR_PERMISSION_DENIED: +@NM_SECRET_AGENT_ERROR_INVALID_CONNECTION: +@NM_SECRET_AGENT_ERROR_USER_CANCELED: +@NM_SECRET_AGENT_ERROR_AGENT_CANCELED: +@NM_SECRET_AGENT_ERROR_NO_SECRETS: + +<!-- ##### FUNCTION nm_secret_agent_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SECRET_AGENT_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingsError ##### --> +<para> + +</para> + +@NM_SETTINGS_ERROR_FAILED: +@NM_SETTINGS_ERROR_PERMISSION_DENIED: +@NM_SETTINGS_ERROR_NOT_SUPPORTED: +@NM_SETTINGS_ERROR_INVALID_CONNECTION: +@NM_SETTINGS_ERROR_READ_ONLY_CONNECTION: +@NM_SETTINGS_ERROR_UUID_EXISTS: +@NM_SETTINGS_ERROR_INVALID_HOSTNAME: + +<!-- ##### FUNCTION nm_settings_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTINGS_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMVpnPluginError ##### --> +<para> + +</para> + +@NM_VPN_PLUGIN_ERROR_FAILED: +@NM_VPN_PLUGIN_ERROR_STARTING_IN_PROGRESS: +@NM_VPN_PLUGIN_ERROR_ALREADY_STARTED: +@NM_VPN_PLUGIN_ERROR_STOPPING_IN_PROGRESS: +@NM_VPN_PLUGIN_ERROR_ALREADY_STOPPED: +@NM_VPN_PLUGIN_ERROR_WRONG_STATE: +@NM_VPN_PLUGIN_ERROR_BAD_ARGUMENTS: +@NM_VPN_PLUGIN_ERROR_LAUNCH_FAILED: +@NM_VPN_PLUGIN_ERROR_INVALID_CONNECTION: +@NM_VPN_PLUGIN_ERROR_INTERACTIVE_NOT_SUPPORTED: + +<!-- ##### MACRO NM_VPN_PLUGIN_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_vpn_plugin_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-ip-config.sgml b/docs/libnm/tmpl/nm-ip-config.sgml new file mode 100644 index 00000000..bc3ff563 --- /dev/null +++ b/docs/libnm/tmpl/nm-ip-config.sgml @@ -0,0 +1,205 @@ +<!-- ##### SECTION Title ##### --> +NMIPConfig + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT NMIPConfig ##### --> +<para> + +</para> + + +<!-- ##### ARG NMIPConfig:addresses ##### --> +<para> + +</para> + +<!-- ##### ARG NMIPConfig:domains ##### --> +<para> + +</para> + +<!-- ##### ARG NMIPConfig:family ##### --> +<para> + +</para> + +<!-- ##### ARG NMIPConfig:gateway ##### --> +<para> + +</para> + +<!-- ##### ARG NMIPConfig:nameservers ##### --> +<para> + +</para> + +<!-- ##### ARG NMIPConfig:routes ##### --> +<para> + +</para> + +<!-- ##### ARG NMIPConfig:searches ##### --> +<para> + +</para> + +<!-- ##### ARG NMIPConfig:wins-servers ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMIPConfigClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### MACRO NM_IP_CONFIG_FAMILY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_IP_CONFIG_GATEWAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_IP_CONFIG_ADDRESSES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_IP_CONFIG_ROUTES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_IP_CONFIG_NAMESERVERS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_IP_CONFIG_DOMAINS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_IP_CONFIG_SEARCHES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_IP_CONFIG_WINS_SERVERS ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_ip_config_get_family ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION nm_ip_config_get_gateway ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION nm_ip_config_get_addresses ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION nm_ip_config_get_routes ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION nm_ip_config_get_nameservers ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION nm_ip_config_get_domains ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION nm_ip_config_get_searches ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION nm_ip_config_get_wins_servers ##### --> +<para> + +</para> + +@config: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-object.sgml b/docs/libnm/tmpl/nm-object.sgml new file mode 100644 index 00000000..53ed0566 --- /dev/null +++ b/docs/libnm/tmpl/nm-object.sgml @@ -0,0 +1,77 @@ +<!-- ##### SECTION Title ##### --> +NMObject + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_OBJECT_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_OBJECT_DBUS_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMObject ##### --> +<para> + +</para> + + +<!-- ##### ARG NMObject:dbus-connection ##### --> +<para> + +</para> + +<!-- ##### ARG NMObject:nm-running-internal ##### --> +<para> + +</para> + +<!-- ##### ARG NMObject:path ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMObjectClass ##### --> +<para> + +</para> + +@parent: +@init_dbus: +@object_creation_failed: + +<!-- ##### FUNCTION nm_object_get_path ##### --> +<para> + +</para> + +@object: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-remote-connection.sgml b/docs/libnm/tmpl/nm-remote-connection.sgml new file mode 100644 index 00000000..f51af61e --- /dev/null +++ b/docs/libnm/tmpl/nm-remote-connection.sgml @@ -0,0 +1,229 @@ +<!-- ##### SECTION Title ##### --> +NMRemoteConnection + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_REMOTE_CONNECTION_DBUS_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_REMOTE_CONNECTION_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_REMOTE_CONNECTION_UNSAVED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_REMOTE_CONNECTION_VISIBLE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMRemoteConnection ##### --> +<para> + +</para> + + +<!-- ##### ARG NMRemoteConnection:unsaved ##### --> +<para> + +</para> + +<!-- ##### ARG NMRemoteConnection:visible ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMRemoteConnectionClass ##### --> +<para> + +</para> + +@parent_class: + +<!-- ##### FUNCTION nm_remote_connection_commit_changes ##### --> +<para> + +</para> + +@connection: +@save_to_disk: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_remote_connection_commit_changes_async ##### --> +<para> + +</para> + +@connection: +@save_to_disk: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_remote_connection_commit_changes_finish ##### --> +<para> + +</para> + +@connection: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_remote_connection_save ##### --> +<para> + +</para> + +@connection: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_remote_connection_save_async ##### --> +<para> + +</para> + +@connection: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_remote_connection_save_finish ##### --> +<para> + +</para> + +@connection: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_remote_connection_delete ##### --> +<para> + +</para> + +@connection: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_remote_connection_delete_async ##### --> +<para> + +</para> + +@connection: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_remote_connection_delete_finish ##### --> +<para> + +</para> + +@connection: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_remote_connection_get_secrets ##### --> +<para> + +</para> + +@connection: +@setting_name: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_remote_connection_get_secrets_async ##### --> +<para> + +</para> + +@connection: +@setting_name: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_remote_connection_get_secrets_finish ##### --> +<para> + +</para> + +@connection: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_remote_connection_get_unsaved ##### --> +<para> + +</para> + +@connection: +@Returns: + + +<!-- ##### FUNCTION nm_remote_connection_get_visible ##### --> +<para> + +</para> + +@connection: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-secret-agent-old.sgml b/docs/libnm/tmpl/nm-secret-agent-old.sgml new file mode 100644 index 00000000..86953508 --- /dev/null +++ b/docs/libnm/tmpl/nm-secret-agent-old.sgml @@ -0,0 +1,234 @@ +<!-- ##### SECTION Title ##### --> +NMSecretAgentOld + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SECRET_AGENT_OLD_IDENTIFIER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SECRET_AGENT_OLD_AUTO_REGISTER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SECRET_AGENT_OLD_REGISTERED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SECRET_AGENT_OLD_CAPABILITIES ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSecretAgentOld ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSecretAgentOld:auto-register ##### --> +<para> + +</para> + +<!-- ##### ARG NMSecretAgentOld:capabilities ##### --> +<para> + +</para> + +<!-- ##### ARG NMSecretAgentOld:identifier ##### --> +<para> + +</para> + +<!-- ##### ARG NMSecretAgentOld:registered ##### --> +<para> + +</para> + +<!-- ##### USER_FUNCTION NMSecretAgentOldGetSecretsFunc ##### --> +<para> + +</para> + +@agent: +@connection: +@secrets: +@error: +@user_data: + + +<!-- ##### USER_FUNCTION NMSecretAgentOldSaveSecretsFunc ##### --> +<para> + +</para> + +@agent: +@connection: +@error: +@user_data: + + +<!-- ##### USER_FUNCTION NMSecretAgentOldDeleteSecretsFunc ##### --> +<para> + +</para> + +@agent: +@connection: +@error: +@user_data: + + +<!-- ##### STRUCT NMSecretAgentOldClass ##### --> +<para> + +</para> + +@parent: +@get_secrets: +@cancel_get_secrets: +@save_secrets: +@delete_secrets: + +<!-- ##### FUNCTION nm_secret_agent_old_register ##### --> +<para> + +</para> + +@self: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_secret_agent_old_register_async ##### --> +<para> + +</para> + +@self: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_secret_agent_old_register_finish ##### --> +<para> + +</para> + +@self: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_secret_agent_old_unregister ##### --> +<para> + +</para> + +@self: +@cancellable: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_secret_agent_old_unregister_async ##### --> +<para> + +</para> + +@self: +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_secret_agent_old_unregister_finish ##### --> +<para> + +</para> + +@self: +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_secret_agent_old_get_registered ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION nm_secret_agent_old_get_secrets ##### --> +<para> + +</para> + +@self: +@connection: +@setting_name: +@hints: +@flags: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_secret_agent_old_save_secrets ##### --> +<para> + +</para> + +@self: +@connection: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_secret_agent_old_delete_secrets ##### --> +<para> + +</para> + +@self: +@connection: +@callback: +@user_data: + + diff --git a/docs/libnm/tmpl/nm-setting-8021x.sgml b/docs/libnm/tmpl/nm-setting-8021x.sgml new file mode 100644 index 00000000..b77deec6 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-8021x.sgml @@ -0,0 +1,1091 @@ +<!-- ##### 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> + + + +<!-- ##### 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_PAC_FILE ##### --> +<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_SUBJECT_MATCH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_ALTSUBJECT_MATCHES ##### --> +<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_SUBJECT_MATCH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES ##### --> +<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_PASSWORD_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD_RAW ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD_RAW_FLAGS ##### --> +<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_PRIVATE_KEY_PASSWORD_FLAGS ##### --> +<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_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_PIN_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_802_1X_SYSTEM_CA_CERTS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSetting8021x ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting8021x:altsubject-matches ##### --> +<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:pac-file ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:password-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:password-raw ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:password-raw-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase1-fast-provisioning ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase1-peaplabel ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase1-peapver ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase2-altsubject-matches ##### --> +<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:phase2-private-key-password-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:phase2-subject-match ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:pin ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:pin-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:private-key ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:private-key-password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:private-key-password-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:subject-match ##### --> +<para> + +</para> + +<!-- ##### ARG NMSetting8021x:system-ca-certs ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSetting8021xClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### 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_remove_eap_method_by_value ##### --> +<para> + +</para> + +@setting: +@eap: +@Returns: + + +<!-- ##### 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_pac_file ##### --> +<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: +@cert_path: +@scheme: +@out_format: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_subject_match ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_num_altsubject_matches ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_altsubject_match ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_add_altsubject_match ##### --> +<para> + +</para> + +@setting: +@altsubject_match: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_remove_altsubject_match ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_802_1x_remove_altsubject_match_by_value ##### --> +<para> + +</para> + +@setting: +@altsubject_match: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_clear_altsubject_matches ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### 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: +@cert_path: +@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: +@cert_path: +@scheme: +@out_format: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_subject_match ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_num_phase2_altsubject_matches ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_altsubject_match ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_add_phase2_altsubject_match ##### --> +<para> + +</para> + +@setting: +@phase2_altsubject_match: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_remove_phase2_altsubject_match ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_802_1x_remove_phase2_altsubject_match_by_value ##### --> +<para> + +</para> + +@setting: +@phase2_altsubject_match: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_clear_phase2_altsubject_matches ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### 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: +@cert_path: +@scheme: +@out_format: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_password ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_password_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_password_raw ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_password_raw_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_pin ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_pin_flags ##### --> +<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: +@key_path: +@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_password_flags ##### --> +<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: +@key_path: +@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_password_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_format ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-adsl.sgml b/docs/libnm/tmpl/nm-setting-adsl.sgml new file mode 100644 index 00000000..cac35e4d --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-adsl.sgml @@ -0,0 +1,235 @@ +<!-- ##### SECTION Title ##### --> +NMSettingAdsl + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_ADSL_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_USERNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_PASSWORD_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_PROTOCOL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_ENCAPSULATION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_VPI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_VCI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_PROTOCOL_PPPOA ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_PROTOCOL_PPPOE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_PROTOCOL_IPOATM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_ENCAPSULATION_VCMUX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ADSL_ENCAPSULATION_LLC ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingAdsl ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingAdsl:encapsulation ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingAdsl:password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingAdsl:password-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingAdsl:protocol ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingAdsl:username ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingAdsl:vci ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingAdsl:vpi ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingAdslClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_adsl_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_adsl_get_username ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_adsl_get_password ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_adsl_get_protocol ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_adsl_get_encapsulation ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_adsl_get_vpi ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_adsl_get_vci ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_adsl_get_password_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-bluetooth.sgml b/docs/libnm/tmpl/nm-setting-bluetooth.sgml new file mode 100644 index 00000000..e4dc1397 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-bluetooth.sgml @@ -0,0 +1,109 @@ +<!-- ##### 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> + + + +<!-- ##### 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: + +<!-- ##### 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/tmpl/nm-setting-bond.sgml b/docs/libnm/tmpl/nm-setting-bond.sgml new file mode 100644 index 00000000..bbf1e8b0 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-bond.sgml @@ -0,0 +1,251 @@ +<!-- ##### SECTION Title ##### --> +NMSettingBond + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_BOND_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTIONS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_MODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_MIIMON ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_DOWNDELAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_UPDELAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_ARP_INTERVAL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_ARP_IP_TARGET ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_ARP_VALIDATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_PRIMARY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_PRIMARY_RESELECT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_FAIL_OVER_MAC ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_USE_CARRIER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_AD_SELECT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_XMIT_HASH_POLICY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_RESEND_IGMP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BOND_OPTION_LACP_RATE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingBond ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingBond:options ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingBondClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_bond_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bond_get_num_options ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bond_get_option ##### --> +<para> + +</para> + +@setting: +@idx: +@out_name: +@out_value: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bond_get_option_by_name ##### --> +<para> + +</para> + +@setting: +@name: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bond_add_option ##### --> +<para> + +</para> + +@setting: +@name: +@value: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bond_remove_option ##### --> +<para> + +</para> + +@setting: +@name: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bond_validate_option ##### --> +<para> + +</para> + +@name: +@value: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bond_get_valid_options ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bond_get_option_default ##### --> +<para> + +</para> + +@setting: +@name: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-bridge-port.sgml b/docs/libnm/tmpl/nm-setting-bridge-port.sgml new file mode 100644 index 00000000..4588abee --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-bridge-port.sgml @@ -0,0 +1,116 @@ +<!-- ##### SECTION Title ##### --> +NMSettingBridgePort + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_PRIORITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_PATH_COST ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingBridgePort ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingBridgePort:hairpin-mode ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingBridgePort:path-cost ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingBridgePort:priority ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingBridgePortClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_bridge_port_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_port_get_priority ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_port_get_path_cost ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_port_get_hairpin_mode ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-bridge.sgml b/docs/libnm/tmpl/nm-setting-bridge.sgml new file mode 100644 index 00000000..47629732 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-bridge.sgml @@ -0,0 +1,200 @@ +<!-- ##### SECTION Title ##### --> +NMSettingBridge + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_BRIDGE_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_MAC_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_STP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_PRIORITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_FORWARD_DELAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_HELLO_TIME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_MAX_AGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_BRIDGE_AGEING_TIME ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingBridge ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingBridge:ageing-time ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingBridge:forward-delay ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingBridge:hello-time ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingBridge:mac-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingBridge:max-age ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingBridge:priority ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingBridge:stp ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingBridgeClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_bridge_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_get_mac_address ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_get_stp ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_get_priority ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_get_forward_delay ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_get_hello_time ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_get_max_age ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_bridge_get_ageing_time ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-cdma.sgml b/docs/libnm/tmpl/nm-setting-cdma.sgml new file mode 100644 index 00000000..cd497fe1 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-cdma.sgml @@ -0,0 +1,137 @@ +<!-- ##### 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> + + + +<!-- ##### MACRO NM_SETTING_CDMA_NUMBER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CDMA_USERNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CDMA_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CDMA_PASSWORD_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingCdma ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingCdma:number ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingCdma:password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingCdma:password-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingCdma:username ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingCdmaClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### 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: + + +<!-- ##### FUNCTION nm_setting_cdma_get_password_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-connection.sgml b/docs/libnm/tmpl/nm-setting-connection.sgml new file mode 100644 index 00000000..f4dbe24f --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-connection.sgml @@ -0,0 +1,473 @@ +<!-- ##### 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> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_ID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_UUID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_INTERFACE_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_AUTOCONNECT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_TIMESTAMP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_READ_ONLY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_PERMISSIONS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_ZONE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_MASTER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_SLAVE_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_SECONDARIES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingConnection ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingConnection:autoconnect ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:autoconnect-priority ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:gateway-ping-timeout ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:id ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:interface-name ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:master ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:permissions ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:read-only ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:secondaries ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:slave-type ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:timestamp ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:type ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:uuid ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingConnection:zone ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingConnectionClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### 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_interface_name ##### --> +<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_autoconnect_priority ##### --> +<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: + + +<!-- ##### FUNCTION nm_setting_connection_get_num_permissions ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_permission ##### --> +<para> + +</para> + +@setting: +@idx: +@out_ptype: +@out_pitem: +@out_detail: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_zone ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_permissions_user_allowed ##### --> +<para> + +</para> + +@setting: +@uname: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_add_permission ##### --> +<para> + +</para> + +@setting: +@ptype: +@pitem: +@detail: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_remove_permission ##### --> +<para> + +</para> + +@setting: +@idx: + + +<!-- ##### FUNCTION nm_setting_connection_remove_permission_by_value ##### --> +<para> + +</para> + +@setting: +@ptype: +@pitem: +@detail: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_master ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_is_slave_type ##### --> +<para> + +</para> + +@setting: +@type: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_slave_type ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_num_secondaries ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_secondary ##### --> +<para> + +</para> + +@setting: +@idx: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_add_secondary ##### --> +<para> + +</para> + +@setting: +@sec_uuid: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_remove_secondary ##### --> +<para> + +</para> + +@setting: +@idx: + + +<!-- ##### FUNCTION nm_setting_connection_remove_secondary_by_value ##### --> +<para> + +</para> + +@setting: +@sec_uuid: +@Returns: + + +<!-- ##### FUNCTION nm_setting_connection_get_gateway_ping_timeout ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-dcb.sgml b/docs/libnm/tmpl/nm-setting-dcb.sgml new file mode 100644 index 00000000..38a875ce --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-dcb.sgml @@ -0,0 +1,458 @@ +<!-- ##### SECTION Title ##### --> +NMSettingDcb + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_DCB_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingDcbFlags ##### --> +<para> + +</para> + +@NM_SETTING_DCB_FLAG_NONE: +@NM_SETTING_DCB_FLAG_ENABLE: +@NM_SETTING_DCB_FLAG_ADVERTISE: +@NM_SETTING_DCB_FLAG_WILLING: + +<!-- ##### MACRO NM_SETTING_DCB_FCOE_MODE_FABRIC ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_FCOE_MODE_VN2VN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_APP_FCOE_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_APP_FCOE_PRIORITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_APP_FCOE_MODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_APP_ISCSI_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_APP_ISCSI_PRIORITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_APP_FIP_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_APP_FIP_PRIORITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_PRIORITY_FLOW_CONTROL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_PRIORITY_GROUP_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_PRIORITY_GROUP_ID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_PRIORITY_BANDWIDTH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingDcb ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingDcb:app-fcoe-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:app-fcoe-mode ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:app-fcoe-priority ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:app-fip-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:app-fip-priority ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:app-iscsi-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:app-iscsi-priority ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:priority-bandwidth ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:priority-flow-control ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:priority-flow-control-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:priority-group-bandwidth ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:priority-group-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:priority-group-id ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:priority-strict-bandwidth ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingDcb:priority-traffic-class ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingDcbClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_dcb_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_get_app_fcoe_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_get_app_fcoe_priority ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_get_app_fcoe_mode ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_get_app_iscsi_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_get_app_iscsi_priority ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_get_app_fip_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_get_app_fip_priority ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_get_priority_flow_control_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_get_priority_flow_control ##### --> +<para> + +</para> + +@setting: +@user_priority: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_set_priority_flow_control ##### --> +<para> + +</para> + +@setting: +@user_priority: +@enabled: + + +<!-- ##### FUNCTION nm_setting_dcb_get_priority_group_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_get_priority_group_id ##### --> +<para> + +</para> + +@setting: +@user_priority: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_set_priority_group_id ##### --> +<para> + +</para> + +@setting: +@user_priority: +@group_id: + + +<!-- ##### FUNCTION nm_setting_dcb_get_priority_group_bandwidth ##### --> +<para> + +</para> + +@setting: +@group_id: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_set_priority_group_bandwidth ##### --> +<para> + +</para> + +@setting: +@group_id: +@bandwidth_percent: + + +<!-- ##### FUNCTION nm_setting_dcb_get_priority_bandwidth ##### --> +<para> + +</para> + +@setting: +@user_priority: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_set_priority_bandwidth ##### --> +<para> + +</para> + +@setting: +@user_priority: +@bandwidth_percent: + + +<!-- ##### FUNCTION nm_setting_dcb_get_priority_strict_bandwidth ##### --> +<para> + +</para> + +@setting: +@user_priority: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_set_priority_strict_bandwidth ##### --> +<para> + +</para> + +@setting: +@user_priority: +@strict: + + +<!-- ##### FUNCTION nm_setting_dcb_get_priority_traffic_class ##### --> +<para> + +</para> + +@setting: +@user_priority: +@Returns: + + +<!-- ##### FUNCTION nm_setting_dcb_set_priority_traffic_class ##### --> +<para> + +</para> + +@setting: +@user_priority: +@traffic_class: + + diff --git a/docs/libnm/tmpl/nm-setting-generic.sgml b/docs/libnm/tmpl/nm-setting-generic.sgml new file mode 100644 index 00000000..bb6d1902 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-generic.sgml @@ -0,0 +1,53 @@ +<!-- ##### SECTION Title ##### --> +NMSettingGeneric + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_GENERIC_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingGeneric ##### --> +<para> + +</para> + + +<!-- ##### STRUCT NMSettingGenericClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_generic_new ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-gsm.sgml b/docs/libnm/tmpl/nm-setting-gsm.sgml new file mode 100644 index 00000000..1bc4a620 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-gsm.sgml @@ -0,0 +1,242 @@ +<!-- ##### 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> + + + +<!-- ##### 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_PASSWORD_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_APN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_NETWORK_ID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_PIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_PIN_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_GSM_HOME_ONLY ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingGsm ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingGsm:apn ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:home-only ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:network-id ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:number ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:password-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:pin ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:pin-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingGsm:username ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingGsmClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### 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_pin ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_home_only ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_pin_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_gsm_get_password_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-infiniband.sgml b/docs/libnm/tmpl/nm-setting-infiniband.sgml new file mode 100644 index 00000000..41588b37 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-infiniband.sgml @@ -0,0 +1,167 @@ +<!-- ##### SECTION Title ##### --> +NMSettingInfiniband + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_INFINIBAND_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_INFINIBAND_MAC_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_INFINIBAND_MTU ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_INFINIBAND_TRANSPORT_MODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_INFINIBAND_P_KEY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_INFINIBAND_PARENT ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingInfiniband ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingInfiniband:mac-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingInfiniband:mtu ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingInfiniband:p-key ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingInfiniband:parent ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingInfiniband:transport-mode ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingInfinibandClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_infiniband_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_infiniband_get_mac_address ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_infiniband_get_mtu ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_infiniband_get_transport_mode ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_infiniband_get_p_key ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_infiniband_get_parent ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_infiniband_get_virtual_interface_name ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-ip-config.sgml b/docs/libnm/tmpl/nm-setting-ip-config.sgml new file mode 100644 index 00000000..00a233ce --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-ip-config.sgml @@ -0,0 +1,872 @@ +<!-- ##### SECTION Title ##### --> +NMSettingIPConfig + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### TYPEDEF NMIPAddress ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION nm_ip_address_new ##### --> +<para> + +</para> + +@family: +@addr: +@prefix: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_ip_address_new_binary ##### --> +<para> + +</para> + +@family: +@addr: +@prefix: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_ip_address_ref ##### --> +<para> + +</para> + +@address: + + +<!-- ##### FUNCTION nm_ip_address_unref ##### --> +<para> + +</para> + +@address: + + +<!-- ##### FUNCTION nm_ip_address_equal ##### --> +<para> + +</para> + +@address: +@other: +@Returns: + + +<!-- ##### FUNCTION nm_ip_address_dup ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip_address_get_family ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip_address_get_address ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip_address_set_address ##### --> +<para> + +</para> + +@address: +@addr: + + +<!-- ##### FUNCTION nm_ip_address_get_address_binary ##### --> +<para> + +</para> + +@address: +@addr: + + +<!-- ##### FUNCTION nm_ip_address_set_address_binary ##### --> +<para> + +</para> + +@address: +@addr: + + +<!-- ##### FUNCTION nm_ip_address_get_prefix ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip_address_set_prefix ##### --> +<para> + +</para> + +@address: +@prefix: + + +<!-- ##### FUNCTION nm_ip_address_get_attribute_names ##### --> +<para> + +</para> + +@address: +@Returns: + + +<!-- ##### FUNCTION nm_ip_address_get_attribute ##### --> +<para> + +</para> + +@address: +@name: +@Returns: + + +<!-- ##### FUNCTION nm_ip_address_set_attribute ##### --> +<para> + +</para> + +@address: +@name: +@value: + + +<!-- ##### TYPEDEF NMIPRoute ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION nm_ip_route_new ##### --> +<para> + +</para> + +@family: +@dest: +@prefix: +@next_hop: +@metric: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_new_binary ##### --> +<para> + +</para> + +@family: +@dest: +@prefix: +@next_hop: +@metric: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_ref ##### --> +<para> + +</para> + +@route: + + +<!-- ##### FUNCTION nm_ip_route_unref ##### --> +<para> + +</para> + +@route: + + +<!-- ##### FUNCTION nm_ip_route_equal ##### --> +<para> + +</para> + +@route: +@other: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_dup ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_get_family ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_get_dest ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_set_dest ##### --> +<para> + +</para> + +@route: +@dest: + + +<!-- ##### FUNCTION nm_ip_route_get_dest_binary ##### --> +<para> + +</para> + +@route: +@dest: + + +<!-- ##### FUNCTION nm_ip_route_set_dest_binary ##### --> +<para> + +</para> + +@route: +@dest: + + +<!-- ##### FUNCTION nm_ip_route_get_prefix ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_set_prefix ##### --> +<para> + +</para> + +@route: +@prefix: + + +<!-- ##### FUNCTION nm_ip_route_get_next_hop ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_set_next_hop ##### --> +<para> + +</para> + +@route: +@next_hop: + + +<!-- ##### FUNCTION nm_ip_route_get_next_hop_binary ##### --> +<para> + +</para> + +@route: +@next_hop: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_set_next_hop_binary ##### --> +<para> + +</para> + +@route: +@next_hop: + + +<!-- ##### FUNCTION nm_ip_route_get_metric ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_set_metric ##### --> +<para> + +</para> + +@route: +@metric: + + +<!-- ##### FUNCTION nm_ip_route_get_attribute_names ##### --> +<para> + +</para> + +@route: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_get_attribute ##### --> +<para> + +</para> + +@route: +@name: +@Returns: + + +<!-- ##### FUNCTION nm_ip_route_set_attribute ##### --> +<para> + +</para> + +@route: +@name: +@value: + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_METHOD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_DNS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_DNS_SEARCH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_ADDRESSES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_GATEWAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_ROUTES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_ROUTE_METRIC ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_DHCP_HOSTNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_NEVER_DEFAULT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_IP_CONFIG_MAY_FAIL ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingIPConfig ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingIPConfig:addresses ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:dhcp-hostname ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:dhcp-send-hostname ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:dns ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:dns-search ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:gateway ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:ignore-auto-dns ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:ignore-auto-routes ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:may-fail ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:method ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:never-default ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:route-metric ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingIPConfig:routes ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingIPConfigClass ##### --> +<para> + +</para> + +@parent: +@padding: + +<!-- ##### FUNCTION nm_setting_ip_config_get_method ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_num_dns ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_dns ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_add_dns ##### --> +<para> + +</para> + +@setting: +@dns: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_remove_dns ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip_config_remove_dns_by_value ##### --> +<para> + +</para> + +@setting: +@dns: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_clear_dns ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_num_dns_searches ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_dns_search ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_add_dns_search ##### --> +<para> + +</para> + +@setting: +@dns_search: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_remove_dns_search ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip_config_remove_dns_search_by_value ##### --> +<para> + +</para> + +@setting: +@dns_search: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_clear_dns_searches ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_num_addresses ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_address ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_add_address ##### --> +<para> + +</para> + +@setting: +@address: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_remove_address ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip_config_remove_address_by_value ##### --> +<para> + +</para> + +@setting: +@address: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_clear_addresses ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_gateway ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_num_routes ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_route ##### --> +<para> + +</para> + +@setting: +@i: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_add_route ##### --> +<para> + +</para> + +@setting: +@route: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_remove_route ##### --> +<para> + +</para> + +@setting: +@i: + + +<!-- ##### FUNCTION nm_setting_ip_config_remove_route_by_value ##### --> +<para> + +</para> + +@setting: +@route: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_clear_routes ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_route_metric ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_ignore_auto_routes ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_ignore_auto_dns ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_dhcp_hostname ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_dhcp_send_hostname ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_never_default ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip_config_get_may_fail ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-ip4-config.sgml b/docs/libnm/tmpl/nm-setting-ip4-config.sgml new file mode 100644 index 00000000..3d1b3caa --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-ip4-config.sgml @@ -0,0 +1,109 @@ +<!-- ##### 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> + + + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID ##### --> +<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> + + + +<!-- ##### STRUCT NMSettingIP4Config ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingIP4Config:dhcp-client-id ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingIP4ConfigClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_ip4_config_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip4_config_get_dhcp_client_id ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-ip6-config.sgml b/docs/libnm/tmpl/nm-setting-ip6-config.sgml new file mode 100644 index 00000000..82184963 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-ip6-config.sgml @@ -0,0 +1,126 @@ +<!-- ##### 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> + + + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_IP6_PRIVACY ##### --> +<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_DHCP ##### --> +<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> + + + +<!-- ##### ENUM NMSettingIP6ConfigPrivacy ##### --> +<para> + +</para> + +@NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN: +@NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED: +@NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR: +@NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR: + +<!-- ##### STRUCT NMSettingIP6Config ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingIP6Config:ip6-privacy ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingIP6ConfigClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_ip6_config_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_ip6_config_get_ip6_privacy ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-olpc-mesh.sgml b/docs/libnm/tmpl/nm-setting-olpc-mesh.sgml new file mode 100644 index 00000000..dfcc9e08 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-olpc-mesh.sgml @@ -0,0 +1,116 @@ +<!-- ##### 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> + + + +<!-- ##### 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: + +<!-- ##### 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/tmpl/nm-setting-ppp.sgml b/docs/libnm/tmpl/nm-setting-ppp.sgml new file mode 100644 index 00000000..8ae7fa2b --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-ppp.sgml @@ -0,0 +1,431 @@ +<!-- ##### 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> + + + +<!-- ##### 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: + +<!-- ##### 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/tmpl/nm-setting-pppoe.sgml b/docs/libnm/tmpl/nm-setting-pppoe.sgml new file mode 100644 index 00000000..932c4990 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-pppoe.sgml @@ -0,0 +1,137 @@ +<!-- ##### 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> + + + +<!-- ##### MACRO NM_SETTING_PPPOE_SERVICE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPPOE_USERNAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPPOE_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PPPOE_PASSWORD_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingPppoe ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingPppoe:password ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPppoe:password-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPppoe:service ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingPppoe:username ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingPppoeClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### 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: + + +<!-- ##### FUNCTION nm_setting_pppoe_get_password_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-serial.sgml b/docs/libnm/tmpl/nm-setting-serial.sgml new file mode 100644 index 00000000..2db0e5ce --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-serial.sgml @@ -0,0 +1,167 @@ +<!-- ##### 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 NMSettingSerialParity ##### --> +<para> + +</para> + +@NM_SETTING_SERIAL_PARITY_NONE: +@NM_SETTING_SERIAL_PARITY_EVEN: +@NM_SETTING_SERIAL_PARITY_ODD: + +<!-- ##### 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: + +<!-- ##### 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/tmpl/nm-setting-team-port.sgml b/docs/libnm/tmpl/nm-setting-team-port.sgml new file mode 100644 index 00000000..a8bb595b --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-team-port.sgml @@ -0,0 +1,74 @@ +<!-- ##### SECTION Title ##### --> +NMSettingTeamPort + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_TEAM_PORT_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_TEAM_PORT_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingTeamPort ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingTeamPort:config ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingTeamPortClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_team_port_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_team_port_get_config ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-team.sgml b/docs/libnm/tmpl/nm-setting-team.sgml new file mode 100644 index 00000000..ed6ea846 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-team.sgml @@ -0,0 +1,74 @@ +<!-- ##### SECTION Title ##### --> +NMSettingTeam + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_TEAM_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_TEAM_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingTeam ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingTeam:config ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingTeamClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_setting_team_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_team_get_config ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-vlan.sgml b/docs/libnm/tmpl/nm-setting-vlan.sgml new file mode 100644 index 00000000..fa0915d0 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-vlan.sgml @@ -0,0 +1,245 @@ +<!-- ##### SECTION Title ##### --> +NMSettingVlan + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_VLAN_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VLAN_PARENT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VLAN_ID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VLAN_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VLAN_INGRESS_PRIORITY_MAP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VLAN_EGRESS_PRIORITY_MAP ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingVlan ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingVlan:egress-priority-map ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingVlan:flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingVlan:id ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingVlan:ingress-priority-map ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingVlan:parent ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingVlanClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### ENUM NMVlanPriorityMap ##### --> +<para> + +</para> + +@NM_VLAN_INGRESS_MAP: +@NM_VLAN_EGRESS_MAP: + +<!-- ##### ENUM NMVlanFlags ##### --> +<para> + +</para> + +@NM_VLAN_FLAG_REORDER_HEADERS: +@NM_VLAN_FLAG_GVRP: +@NM_VLAN_FLAG_LOOSE_BINDING: + +<!-- ##### FUNCTION nm_setting_vlan_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vlan_get_parent ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vlan_get_id ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vlan_get_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vlan_get_num_priorities ##### --> +<para> + +</para> + +@setting: +@map: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vlan_get_priority ##### --> +<para> + +</para> + +@setting: +@map: +@idx: +@out_from: +@out_to: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vlan_add_priority ##### --> +<para> + +</para> + +@setting: +@map: +@from: +@to: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vlan_remove_priority ##### --> +<para> + +</para> + +@setting: +@map: +@idx: + + +<!-- ##### FUNCTION nm_setting_vlan_remove_priority_by_value ##### --> +<para> + +</para> + +@setting: +@map: +@from: +@to: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vlan_remove_priority_str_by_value ##### --> +<para> + +</para> + +@setting: +@map: +@str: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vlan_clear_priorities ##### --> +<para> + +</para> + +@setting: +@map: + + +<!-- ##### FUNCTION nm_setting_vlan_add_priority_str ##### --> +<para> + +</para> + +@setting: +@map: +@str: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-vpn.sgml b/docs/libnm/tmpl/nm-setting-vpn.sgml new file mode 100644 index 00000000..e7aef771 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-vpn.sgml @@ -0,0 +1,248 @@ +<!-- ##### 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> + + + +<!-- ##### MACRO NM_SETTING_VPN_SERVICE_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VPN_USER_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_VPN_PERSISTENT ##### --> +<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:persistent ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingVpn:secrets ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingVpn:service-type ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingVpn:user-name ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingVpnClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### USER_FUNCTION NMVpnIterFunc ##### --> +<para> + +</para> + +@key: +@value: +@user_data: + + +<!-- ##### 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_get_persistent ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vpn_get_num_data_items ##### --> +<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: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vpn_foreach_data_item ##### --> +<para> + +</para> + +@setting: +@func: +@user_data: + + +<!-- ##### FUNCTION nm_setting_vpn_get_num_secrets ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### 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: +@Returns: + + +<!-- ##### FUNCTION nm_setting_vpn_foreach_secret ##### --> +<para> + +</para> + +@setting: +@func: +@user_data: + + diff --git a/docs/libnm/tmpl/nm-setting-wimax.sgml b/docs/libnm/tmpl/nm-setting-wimax.sgml new file mode 100644 index 00000000..51eb12de --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-wimax.sgml @@ -0,0 +1,95 @@ +<!-- ##### 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> + + + +<!-- ##### 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_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/tmpl/nm-setting-wired.sgml b/docs/libnm/tmpl/nm-setting-wired.sgml new file mode 100644 index 00000000..06cd9157 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-wired.sgml @@ -0,0 +1,392 @@ +<!-- ##### 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> + + + +<!-- ##### 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_CLONED_MAC_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_MTU ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_S390_SUBCHANNELS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_S390_NETTYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRED_S390_OPTIONS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingWired ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWired:auto-negotiate ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:cloned-mac-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:duplex ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:mac-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:mac-address-blacklist ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:mtu ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:port ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:s390-nettype ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:s390-options ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:s390-subchannels ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWired:speed ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingWiredClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### 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_cloned_mac_address ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_mac_address_blacklist ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_num_mac_blacklist_items ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_mac_blacklist_item ##### --> +<para> + +</para> + +@setting: +@idx: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_add_mac_blacklist_item ##### --> +<para> + +</para> + +@setting: +@mac: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_remove_mac_blacklist_item ##### --> +<para> + +</para> + +@setting: +@idx: + + +<!-- ##### FUNCTION nm_setting_wired_remove_mac_blacklist_item_by_value ##### --> +<para> + +</para> + +@setting: +@mac: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_clear_mac_blacklist_items ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_wired_get_mtu ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_s390_subchannels ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_s390_nettype ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_num_s390_options ##### --> +<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_add_s390_option ##### --> +<para> + +</para> + +@setting: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_remove_s390_option ##### --> +<para> + +</para> + +@setting: +@key: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wired_get_valid_s390_options ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-wireless-security.sgml b/docs/libnm/tmpl/nm-setting-wireless-security.sgml new file mode 100644 index 00000000..5cfed64c --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-wireless-security.sgml @@ -0,0 +1,545 @@ +<!-- ##### 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 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_WEP_KEY_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PSK ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS ##### --> +<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-password-flags ##### --> +<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:psk-flags ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWirelessSecurity:wep-key-flags ##### --> +<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: + +<!-- ##### 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_remove_proto_by_value ##### --> +<para> + +</para> + +@setting: +@proto: +@Returns: + + +<!-- ##### 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_remove_pairwise_by_value ##### --> +<para> + +</para> + +@setting: +@pairwise: +@Returns: + + +<!-- ##### 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_remove_group_by_value ##### --> +<para> + +</para> + +@setting: +@group: +@Returns: + + +<!-- ##### 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_psk_flags ##### --> +<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_leap_password_flags ##### --> +<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_flags ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_key_type ##### --> +<para> + +</para> + +@setting: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-setting-wireless.sgml b/docs/libnm/tmpl/nm-setting-wireless.sgml new file mode 100644 index 00000000..4a69fd77 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting-wireless.sgml @@ -0,0 +1,437 @@ +<!-- ##### 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> + + + +<!-- ##### 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_CLONED_MAC_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_MTU ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_SEEN_BSSIDS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_HIDDEN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_MODE_ADHOC ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_MODE_AP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_WIRELESS_MODE_INFRA ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMSettingWireless ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSettingWireless:band ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:bssid ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:channel ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:cloned-mac-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:hidden ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:mac-address ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:mac-address-blacklist ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:mode ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:mtu ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:rate ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:seen-bssids ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:ssid ##### --> +<para> + +</para> + +<!-- ##### ARG NMSettingWireless:tx-power ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingWirelessClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### 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_cloned_mac_address ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_mac_address_blacklist ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_num_mac_blacklist_items ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_mac_blacklist_item ##### --> +<para> + +</para> + +@setting: +@idx: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_add_mac_blacklist_item ##### --> +<para> + +</para> + +@setting: +@mac: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_remove_mac_blacklist_item ##### --> +<para> + +</para> + +@setting: +@idx: + + +<!-- ##### FUNCTION nm_setting_wireless_remove_mac_blacklist_item_by_value ##### --> +<para> + +</para> + +@setting: +@mac: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_clear_mac_blacklist_items ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_wireless_get_mtu ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_wireless_get_hidden ##### --> +<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/tmpl/nm-setting.sgml b/docs/libnm/tmpl/nm-setting.sgml new file mode 100644 index 00000000..aec0ef91 --- /dev/null +++ b/docs/libnm/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 ##### --> + + +<!-- ##### 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> + + + +<!-- ##### ENUM NMSettingSecretFlags ##### --> +<para> + +</para> + +@NM_SETTING_SECRET_FLAG_NONE: +@NM_SETTING_SECRET_FLAG_AGENT_OWNED: +@NM_SETTING_SECRET_FLAG_NOT_SAVED: +@NM_SETTING_SECRET_FLAG_NOT_REQUIRED: + +<!-- ##### 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: +@NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS: +@NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS: +@NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT: +@NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT: +@NM_SETTING_COMPARE_FLAG_IGNORE_TIMESTAMP: + +<!-- ##### STRUCT NMSetting ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting:name ##### --> +<para> + +</para> + +<!-- ##### USER_FUNCTION NMSettingClearSecretsWithFlagsFn ##### --> +<para> + +</para> + +@setting: +@secret: +@flags: +@user_data: +@Returns: + + +<!-- ##### STRUCT NMSettingClass ##### --> +<para> + +</para> + +@parent: +@verify: +@need_secrets: +@update_one_secret: +@get_secret_flags: +@set_secret_flags: +@clear_secrets_with_flags: +@compare_property: + +<!-- ##### USER_FUNCTION NMSettingValueIterFn ##### --> +<para> + +</para> + +@setting: +@key: +@value: +@flags: +@user_data: + + +<!-- ##### FUNCTION nm_setting_lookup_type ##### --> +<para> + +</para> + +@name: +@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: +@connection: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_compare ##### --> +<para> + +</para> + +@a: +@b: +@flags: +@Returns: + + +<!-- ##### ENUM NMSettingDiffResult ##### --> +<para> + +</para> + +@NM_SETTING_DIFF_RESULT_UNKNOWN: +@NM_SETTING_DIFF_RESULT_IN_A: +@NM_SETTING_DIFF_RESULT_IN_B: +@NM_SETTING_DIFF_RESULT_IN_A_DEFAULT: +@NM_SETTING_DIFF_RESULT_IN_B_DEFAULT: + +<!-- ##### FUNCTION nm_setting_diff ##### --> +<para> + +</para> + +@a: +@b: +@flags: +@invert_results: +@results: +@Returns: + + +<!-- ##### FUNCTION nm_setting_enumerate_values ##### --> +<para> + +</para> + +@setting: +@func: +@user_data: + + +<!-- ##### FUNCTION nm_setting_to_string ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_get_secret_flags ##### --> +<para> + +</para> + +@setting: +@secret_name: +@out_flags: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_set_secret_flags ##### --> +<para> + +</para> + +@setting: +@secret_name: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_get_dbus_property_type ##### --> +<para> + +</para> + +@setting: +@property_name: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-simple-connection.sgml b/docs/libnm/tmpl/nm-simple-connection.sgml new file mode 100644 index 00000000..683461f8 --- /dev/null +++ b/docs/libnm/tmpl/nm-simple-connection.sgml @@ -0,0 +1,65 @@ +<!-- ##### SECTION Title ##### --> +NMSimpleConnection + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT NMSimpleConnection ##### --> +<para> + +</para> + + +<!-- ##### STRUCT NMSimpleConnectionClass ##### --> +<para> + +</para> + +@parent_class: + +<!-- ##### FUNCTION nm_simple_connection_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_simple_connection_new_from_dbus ##### --> +<para> + +</para> + +@dict: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_simple_connection_new_clone ##### --> +<para> + +</para> + +@connection: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-utils.sgml b/docs/libnm/tmpl/nm-utils.sgml new file mode 100644 index 00000000..9981cc58 --- /dev/null +++ b/docs/libnm/tmpl/nm-utils.sgml @@ -0,0 +1,578 @@ +<!-- ##### SECTION Title ##### --> +nm-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### 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: +@len1: +@ssid2: +@len2: +@ignore_trailing_null: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ssid_to_utf8 ##### --> +<para> + +</para> + +@ssid: +@len: +@Returns: + + +<!-- ##### 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_ap_mode_security_valid ##### --> +<para> + +</para> + +@type: +@wifi_caps: +@Returns: + + +<!-- ##### FUNCTION nm_utils_wep_key_valid ##### --> +<para> + +</para> + +@key: +@wep_type: +@Returns: + + +<!-- ##### FUNCTION nm_utils_wpa_psk_valid ##### --> +<para> + +</para> + +@psk: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_dns_to_variant ##### --> +<para> + +</para> + +@dns: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_dns_from_variant ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_addresses_to_variant ##### --> +<para> + +</para> + +@addresses: +@gateway: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_addresses_from_variant ##### --> +<para> + +</para> + +@value: +@out_gateway: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_routes_to_variant ##### --> +<para> + +</para> + +@routes: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_routes_from_variant ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### 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_dns_to_variant ##### --> +<para> + +</para> + +@dns: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_dns_from_variant ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_addresses_to_variant ##### --> +<para> + +</para> + +@addresses: +@gateway: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_addresses_from_variant ##### --> +<para> + +</para> + +@value: +@out_gateway: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_routes_to_variant ##### --> +<para> + +</para> + +@routes: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_routes_from_variant ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip_addresses_to_variant ##### --> +<para> + +</para> + +@addresses: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip_addresses_from_variant ##### --> +<para> + +</para> + +@value: +@family: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip_routes_to_variant ##### --> +<para> + +</para> + +@routes: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip_routes_from_variant ##### --> +<para> + +</para> + +@value: +@family: +@Returns: + + +<!-- ##### FUNCTION nm_utils_uuid_generate ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_utils_file_is_certificate ##### --> +<para> + +</para> + +@filename: +@Returns: + + +<!-- ##### FUNCTION nm_utils_file_is_private_key ##### --> +<para> + +</para> + +@filename: +@out_encrypted: +@Returns: + + +<!-- ##### FUNCTION nm_utils_file_is_pkcs12 ##### --> +<para> + +</para> + +@filename: +@Returns: + + +<!-- ##### USER_FUNCTION NMUtilsFileSearchInPathsPredicate ##### --> +<para> + +</para> + +@filename: +@user_data: +@Returns: + + +<!-- ##### FUNCTION nm_utils_file_search_in_paths ##### --> +<para> + +</para> + +@progname: +@try_first: +@paths: +@file_test_flags: +@predicate: +@user_data: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_utils_wifi_freq_to_channel ##### --> +<para> + +</para> + +@freq: +@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_is_channel_valid ##### --> +<para> + +</para> + +@channel: +@band: +@Returns: + + +<!-- ##### FUNCTION nm_utils_wifi_strength_bars ##### --> +<para> + +</para> + +@strength: +@Returns: + + +<!-- ##### MACRO NM_UTILS_HWADDR_LEN_MAX ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_utils_hwaddr_len ##### --> +<para> + +</para> + +@type: +@Returns: + + +<!-- ##### FUNCTION nm_utils_hwaddr_ntoa ##### --> +<para> + +</para> + +@addr: +@length: +@Returns: + + +<!-- ##### FUNCTION nm_utils_hwaddr_atoba ##### --> +<para> + +</para> + +@asc: +@length: +@Returns: + + +<!-- ##### FUNCTION nm_utils_hwaddr_aton ##### --> +<para> + +</para> + +@asc: +@buffer: +@length: +@Returns: + + +<!-- ##### FUNCTION nm_utils_hwaddr_valid ##### --> +<para> + +</para> + +@asc: +@length: +@Returns: + + +<!-- ##### FUNCTION nm_utils_hwaddr_canonical ##### --> +<para> + +</para> + +@asc: +@length: +@Returns: + + +<!-- ##### FUNCTION nm_utils_hwaddr_matches ##### --> +<para> + +</para> + +@hwaddr1: +@hwaddr1_len: +@hwaddr2: +@hwaddr2_len: +@Returns: + + +<!-- ##### FUNCTION nm_utils_bin2hexstr ##### --> +<para> + +</para> + +@src: +@len: +@final_len: +@Returns: + + +<!-- ##### FUNCTION nm_utils_hexstr2bin ##### --> +<para> + +</para> + +@hex: +@Returns: + + +<!-- ##### FUNCTION nm_utils_iface_valid_name ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION nm_utils_is_uuid ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### MACRO NM_UTILS_INET_ADDRSTRLEN ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_utils_inet4_ntop ##### --> +<para> + +</para> + +@inaddr: +@dst: +@Returns: + + +<!-- ##### FUNCTION nm_utils_inet6_ntop ##### --> +<para> + +</para> + +@in6addr: +@dst: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ipaddr_valid ##### --> +<para> + +</para> + +@family: +@ip: +@Returns: + + +<!-- ##### FUNCTION nm_utils_check_virtual_device_compatibility ##### --> +<para> + +</para> + +@virtual_type: +@other_type: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-version.sgml b/docs/libnm/tmpl/nm-version.sgml new file mode 100644 index 00000000..c27d75bd --- /dev/null +++ b/docs/libnm/tmpl/nm-version.sgml @@ -0,0 +1,158 @@ +<!-- ##### SECTION Title ##### --> +nm-version + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_MAJOR_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_MINOR_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_MICRO_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_CHECK_VERSION ##### --> +<para> + +</para> + +@major: +@minor: +@micro: + + +<!-- ##### MACRO NM_ENCODE_VERSION ##### --> +<para> + +</para> + +@major: +@minor: +@micro: + + +<!-- ##### MACRO NM_VERSION_0_9_8 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VERSION_0_9_10 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VERSION_1_0 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VERSION_CUR_STABLE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VERSION_NEXT_STABLE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VERSION_MIN_REQUIRED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VERSION_MAX_ALLOWED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEPRECATED_IN_0_9_10 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEPRECATED_IN_0_9_10_FOR ##### --> +<para> + +</para> + +@f: + + +<!-- ##### MACRO NM_DEPRECATED_IN_1_0 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DEPRECATED_IN_1_0_FOR ##### --> +<para> + +</para> + +@f: + + +<!-- ##### MACRO NM_AVAILABLE_IN_0_9_10 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_AVAILABLE_IN_1_0 ##### --> +<para> + +</para> + + + diff --git a/docs/libnm/tmpl/nm-vpn-connection.sgml b/docs/libnm/tmpl/nm-vpn-connection.sgml new file mode 100644 index 00000000..0b85b6f0 --- /dev/null +++ b/docs/libnm/tmpl/nm-vpn-connection.sgml @@ -0,0 +1,89 @@ +<!-- ##### SECTION Title ##### --> +NMVpnConnection + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_VPN_CONNECTION_VPN_STATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_CONNECTION_BANNER ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMVpnConnection ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL NMVpnConnection::vpn-state-changed ##### --> +<para> + +</para> + +@nmvpnconnection: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### ARG NMVpnConnection:banner ##### --> +<para> + +</para> + +<!-- ##### ARG NMVpnConnection:vpn-state ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMVpnConnectionClass ##### --> +<para> + +</para> + +@parent: +@vpn_state_changed: + +<!-- ##### FUNCTION nm_vpn_connection_get_vpn_state ##### --> +<para> + +</para> + +@vpn: +@Returns: + + +<!-- ##### FUNCTION nm_vpn_connection_get_banner ##### --> +<para> + +</para> + +@vpn: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-vpn-dbus-interface.sgml b/docs/libnm/tmpl/nm-vpn-dbus-interface.sgml new file mode 100644 index 00000000..c4a88fe3 --- /dev/null +++ b/docs/libnm/tmpl/nm-vpn-dbus-interface.sgml @@ -0,0 +1,484 @@ +<!-- ##### SECTION Title ##### --> +nm-vpn-dbus-interface + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_DBUS_PATH_VPN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_VPN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_PATH_VPN_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INTERFACE_VPN_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_DBUS_PLUGIN_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_DBUS_PLUGIN_INTERFACE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_NO_ACTIVE_VPN_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_NO_VPN_CONNECTIONS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_INVALID_VPN_CONNECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_ERROR_PREFIX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_STARTING_IN_PROGRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_ALREADY_STARTED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_STOPPING_IN_PROGRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_ALREADY_STOPPED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_WRONG_STATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_BAD_ARGUMENTS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_INTERACTIVE_NOT_SUPPORTED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_SIGNAL_LOGIN_BANNER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_SIGNAL_LOGIN_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_SIGNAL_LAUNCH_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_SIGNAL_CONNECT_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_SIGNAL_VPN_CONFIG_BAD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_SIGNAL_IP_CONFIG_BAD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_SIGNAL_STATE_CHANGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_DBUS_VPN_SIGNAL_IP4_CONFIG ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMVpnServiceState ##### --> +<para> + +</para> + +@NM_VPN_SERVICE_STATE_UNKNOWN: +@NM_VPN_SERVICE_STATE_INIT: +@NM_VPN_SERVICE_STATE_SHUTDOWN: +@NM_VPN_SERVICE_STATE_STARTING: +@NM_VPN_SERVICE_STATE_STARTED: +@NM_VPN_SERVICE_STATE_STOPPING: +@NM_VPN_SERVICE_STATE_STOPPED: + +<!-- ##### ENUM NMVpnConnectionState ##### --> +<para> + +</para> + +@NM_VPN_CONNECTION_STATE_UNKNOWN: +@NM_VPN_CONNECTION_STATE_PREPARE: +@NM_VPN_CONNECTION_STATE_NEED_AUTH: +@NM_VPN_CONNECTION_STATE_CONNECT: +@NM_VPN_CONNECTION_STATE_IP_CONFIG_GET: +@NM_VPN_CONNECTION_STATE_ACTIVATED: +@NM_VPN_CONNECTION_STATE_FAILED: +@NM_VPN_CONNECTION_STATE_DISCONNECTED: + +<!-- ##### ENUM NMVpnConnectionStateReason ##### --> +<para> + +</para> + +@NM_VPN_CONNECTION_STATE_REASON_UNKNOWN: +@NM_VPN_CONNECTION_STATE_REASON_NONE: +@NM_VPN_CONNECTION_STATE_REASON_USER_DISCONNECTED: +@NM_VPN_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED: +@NM_VPN_CONNECTION_STATE_REASON_SERVICE_STOPPED: +@NM_VPN_CONNECTION_STATE_REASON_IP_CONFIG_INVALID: +@NM_VPN_CONNECTION_STATE_REASON_CONNECT_TIMEOUT: +@NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT: +@NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_FAILED: +@NM_VPN_CONNECTION_STATE_REASON_NO_SECRETS: +@NM_VPN_CONNECTION_STATE_REASON_LOGIN_FAILED: +@NM_VPN_CONNECTION_STATE_REASON_CONNECTION_REMOVED: + +<!-- ##### ENUM NMVpnPluginFailure ##### --> +<para> + +</para> + +@NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED: +@NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED: +@NM_VPN_PLUGIN_FAILURE_BAD_IP_CONFIG: + +<!-- ##### MACRO NM_VPN_PLUGIN_CONFIG_TUNDEV ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_CONFIG_BANNER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_CONFIG_EXT_GATEWAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_CONFIG_MTU ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_CONFIG_HAS_IP4 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_CONFIG_HAS_IP6 ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_CAN_PERSIST ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_INT_GATEWAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_PTP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_PREFIX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_DNS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_NBNS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_MSS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_DOMAIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_DOMAINS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_ROUTES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_NEVER_DEFAULT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_GATEWAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_BANNER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_MTU ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP4_CONFIG_TUNDEV ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP6_CONFIG_INT_GATEWAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP6_CONFIG_ADDRESS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP6_CONFIG_PTP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP6_CONFIG_PREFIX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP6_CONFIG_DNS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP6_CONFIG_MSS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP6_CONFIG_DOMAIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP6_CONFIG_DOMAINS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP6_CONFIG_ROUTES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_PLUGIN_IP6_CONFIG_NEVER_DEFAULT ##### --> +<para> + +</para> + + + diff --git a/docs/libnm/tmpl/nm-vpn-editor-plugin.sgml b/docs/libnm/tmpl/nm-vpn-editor-plugin.sgml new file mode 100644 index 00000000..f657e7e2 --- /dev/null +++ b/docs/libnm/tmpl/nm-vpn-editor-plugin.sgml @@ -0,0 +1,169 @@ +<!-- ##### SECTION Title ##### --> +NMVpnEditorPlugin + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### USER_FUNCTION NMVpnEditorPluginFactory ##### --> +<para> + +</para> + +@error: +@Returns: + + +<!-- ##### FUNCTION nm_vpn_editor_plugin_factory ##### --> +<para> + +</para> + +@error: +@Returns: + + +<!-- ##### ENUM NMVpnEditorPluginCapability ##### --> +<para> + +</para> + +@NM_VPN_EDITOR_PLUGIN_CAPABILITY_NONE: +@NM_VPN_EDITOR_PLUGIN_CAPABILITY_IMPORT: +@NM_VPN_EDITOR_PLUGIN_CAPABILITY_EXPORT: +@NM_VPN_EDITOR_PLUGIN_CAPABILITY_IPV6: + +<!-- ##### MACRO NM_VPN_EDITOR_PLUGIN_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_EDITOR_PLUGIN_DESCRIPTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_VPN_EDITOR_PLUGIN_SERVICE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT NMVpnEditorPluginInterface ##### --> +<para> + +</para> + +@g_iface: +@get_editor: +@get_capabilities: +@import_from_file: +@export_to_file: +@get_suggested_filename: + +<!-- ##### FUNCTION nm_vpn_editor_plugin_get_editor ##### --> +<para> + +</para> + +@plugin: +@connection: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_vpn_editor_plugin_get_capabilities ##### --> +<para> + +</para> + +@plugin: +@Returns: + + +<!-- ##### FUNCTION nm_vpn_editor_plugin_import ##### --> +<para> + +</para> + +@plugin: +@path: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_vpn_editor_plugin_export ##### --> +<para> + +</para> + +@plugin: +@path: +@connection: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_vpn_editor_plugin_get_suggested_filename ##### --> +<para> + +</para> + +@plugin: +@connection: +@Returns: + + +<!-- ##### STRUCT NMVpnEditorInterface ##### --> +<para> + +</para> + +@g_iface: +@get_widget: +@placeholder: +@update_connection: +@changed: + +<!-- ##### FUNCTION nm_vpn_editor_get_widget ##### --> +<para> + +</para> + +@editor: +@Returns: + + +<!-- ##### FUNCTION nm_vpn_editor_update_connection ##### --> +<para> + +</para> + +@editor: +@connection: +@error: +@Returns: + + diff --git a/docs/libnm/tmpl/nm-wimax-nsp.sgml b/docs/libnm/tmpl/nm-wimax-nsp.sgml new file mode 100644 index 00000000..12143f54 --- /dev/null +++ b/docs/libnm/tmpl/nm-wimax-nsp.sgml @@ -0,0 +1,130 @@ +<!-- ##### SECTION Title ##### --> +NMWimaxNsp + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_WIMAX_NSP_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_WIMAX_NSP_SIGNAL_QUALITY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_WIMAX_NSP_NETWORK_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMWimaxNspNetworkType ##### --> +<para> + +</para> + +@NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN: +@NM_WIMAX_NSP_NETWORK_TYPE_HOME: +@NM_WIMAX_NSP_NETWORK_TYPE_PARTNER: +@NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER: + +<!-- ##### STRUCT NMWimaxNsp ##### --> +<para> + +</para> + + +<!-- ##### ARG NMWimaxNsp:name ##### --> +<para> + +</para> + +<!-- ##### ARG NMWimaxNsp:network-type ##### --> +<para> + +</para> + +<!-- ##### ARG NMWimaxNsp:signal-quality ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMWimaxNspClass ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION nm_wimax_nsp_get_name ##### --> +<para> + +</para> + +@nsp: +@Returns: + + +<!-- ##### FUNCTION nm_wimax_nsp_get_signal_quality ##### --> +<para> + +</para> + +@nsp: +@Returns: + + +<!-- ##### FUNCTION nm_wimax_nsp_get_network_type ##### --> +<para> + +</para> + +@nsp: +@Returns: + + +<!-- ##### FUNCTION nm_wimax_nsp_filter_connections ##### --> +<para> + +</para> + +@nsp: +@connections: +@Returns: + + +<!-- ##### FUNCTION nm_wimax_nsp_connection_valid ##### --> +<para> + +</para> + +@nsp: +@connection: +@Returns: + + |