diff options
Diffstat (limited to 'docs/libnm/tmpl/nm-setting-ip-config.sgml')
| -rw-r--r-- | docs/libnm/tmpl/nm-setting-ip-config.sgml | 872 |
1 files changed, 872 insertions, 0 deletions
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: + + |