diff options
Diffstat (limited to 'docs/libnm-util/tmpl/nm-utils.sgml')
-rw-r--r-- | docs/libnm-util/tmpl/nm-utils.sgml | 404 |
1 files changed, 404 insertions, 0 deletions
diff --git a/docs/libnm-util/tmpl/nm-utils.sgml b/docs/libnm-util/tmpl/nm-utils.sgml new file mode 100644 index 000000000..15c82f33d --- /dev/null +++ b/docs/libnm-util/tmpl/nm-utils.sgml @@ -0,0 +1,404 @@ +<!-- ##### SECTION Title ##### --> +nm-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO nm_print_backtrace ##### --> +<para> + +</para> + + + +<!-- ##### MACRO nm_get_timestamp ##### --> +<para> + +</para> + +@timestamp: + + +<!-- ##### MACRO nm_info ##### --> +<para> + +</para> + +@fmt: +@args...: + + +<!-- ##### MACRO nm_info_str ##### --> +<para> + +</para> + +@fmt_str: +@args...: + + +<!-- ##### MACRO nm_debug ##### --> +<para> + +</para> + +@fmt: +@args...: + + +<!-- ##### MACRO nm_debug_str ##### --> +<para> + +</para> + +@fmt_str: +@args...: + + +<!-- ##### MACRO nm_warning ##### --> +<para> + +</para> + +@fmt: +@args...: + + +<!-- ##### MACRO nm_warning_str ##### --> +<para> + +</para> + +@fmt_str: +@args...: + + +<!-- ##### MACRO nm_error ##### --> +<para> + +</para> + +@fmt: +@args...: + + +<!-- ##### MACRO nm_error_str ##### --> +<para> + +</para> + +@fmt_str: +@args...: + + +<!-- ##### FUNCTION nm_utils_init ##### --> +<para> + +</para> + +@error: +@Returns: + + +<!-- ##### FUNCTION nm_utils_deinit ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION nm_utils_is_empty_ssid ##### --> +<para> + +</para> + +@ssid: +@len: +@Returns: + + +<!-- ##### FUNCTION nm_utils_escape_ssid ##### --> +<para> + +</para> + +@ssid: +@len: +@Returns: + + +<!-- ##### FUNCTION nm_utils_same_ssid ##### --> +<para> + +</para> + +@ssid1: +@ssid2: +@ignore_trailing_null: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ssid_to_utf8 ##### --> +<para> + +</para> + +@ssid: +@len: +@Returns: + + +<!-- ##### FUNCTION nm_utils_gvalue_hash_dup ##### --> +<para> + +</para> + +@hash: +@Returns: + + +<!-- ##### FUNCTION nm_utils_slist_free ##### --> +<para> + +</para> + +@list: +@elem_destroy_fn: + + +<!-- ##### ENUM NMUtilsSecurityType ##### --> +<para> + +</para> + +@NMU_SEC_INVALID: +@NMU_SEC_NONE: +@NMU_SEC_STATIC_WEP: +@NMU_SEC_LEAP: +@NMU_SEC_DYNAMIC_WEP: +@NMU_SEC_WPA_PSK: +@NMU_SEC_WPA_ENTERPRISE: +@NMU_SEC_WPA2_PSK: +@NMU_SEC_WPA2_ENTERPRISE: + +<!-- ##### FUNCTION nm_utils_security_valid ##### --> +<para> + +</para> + +@type: +@wifi_caps: +@have_ap: +@adhoc: +@ap_flags: +@ap_wpa: +@ap_rsn: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_addresses_from_gvalue ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_addresses_to_gvalue ##### --> +<para> + +</para> + +@list: +@value: + + +<!-- ##### FUNCTION nm_utils_ip4_routes_from_gvalue ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_routes_to_gvalue ##### --> +<para> + +</para> + +@list: +@value: + + +<!-- ##### FUNCTION nm_utils_ip4_netmask_to_prefix ##### --> +<para> + +</para> + +@netmask: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_prefix_to_netmask ##### --> +<para> + +</para> + +@prefix: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip4_get_default_prefix ##### --> +<para> + +</para> + +@ip: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_addresses_from_gvalue ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_addresses_to_gvalue ##### --> +<para> + +</para> + +@list: +@value: + + +<!-- ##### FUNCTION nm_utils_ip6_routes_from_gvalue ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_routes_to_gvalue ##### --> +<para> + +</para> + +@list: +@value: + + +<!-- ##### FUNCTION nm_utils_ip6_dns_from_gvalue ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION nm_utils_ip6_dns_to_gvalue ##### --> +<para> + +</para> + +@list: +@value: + + +<!-- ##### FUNCTION nm_utils_uuid_generate ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_utils_uuid_generate_from_string ##### --> +<para> + +</para> + +@s: +@Returns: + + +<!-- ##### FUNCTION nm_utils_rsa_key_encrypt ##### --> +<para> + +</para> + +@data: +@in_password: +@out_password: +@error: +@Returns: + + +<!-- ##### 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: + + |