diff options
Diffstat (limited to 'doc/doxyout/krb5/man/man3/krb5_support.3')
| -rw-r--r-- | doc/doxyout/krb5/man/man3/krb5_support.3 | 114 |
1 files changed, 57 insertions, 57 deletions
diff --git a/doc/doxyout/krb5/man/man3/krb5_support.3 b/doc/doxyout/krb5/man/man3/krb5_support.3 index 8a1ffb17d708..9c3152f7d8f7 100644 --- a/doc/doxyout/krb5/man/man3/krb5_support.3 +++ b/doc/doxyout/krb5/man/man3/krb5_support.3 @@ -1,8 +1,8 @@ -.TH "krb5_support" 3 "Fri Jun 7 2019" "Version 7.7.0" "HeimdalKerberos5library" \" -*- nroff -*- +.TH "krb5_support" 3 "Tue Nov 15 2022" "Version 7.8.0" "Heimdal Kerberos 5 library" \" -*- nroff -*- .ad l .nh .SH NAME -krb5_support +krb5_support \- Heimdal Kerberos 5 support functions .SH SYNOPSIS .br .PP @@ -115,7 +115,7 @@ krb5_support .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_acl_match_file (krb5_context context, const char * file, const char * format, \&.\&.\&.)" krb5_acl_match_file matches ACL format against each line in a file using \fBkrb5_acl_match_string()\fP\&. Lines starting with # are treated like comments and ignored\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP Kerberos 5 context\&. .br @@ -126,12 +126,12 @@ krb5_acl_match_file matches ACL format against each line in a file using \fBkrb5 \fI\&.\&.\&.\fP parameter to format string\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0\&. .RE .PP -\fBSee also:\fP +\fBSee also\fP .RS 4 \fBkrb5_acl_match_string\fP .RE @@ -151,7 +151,7 @@ f Matches the string with fnmatch(3)\&. Theflags argument (the last argument) pa r Returns a copy of the string in the char ** passed in; the copy must be freed with free(3)\&. There is no need to free(3) the string on error: the function will clean up and set the pointer to NULL\&. .PP .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP Kerberos 5 context .br @@ -162,7 +162,7 @@ r Returns a copy of the string in the char ** passed in; the copy must be freed \fI\&.\&.\&.\fP parameter to format string .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0\&. .RE @@ -185,7 +185,7 @@ free(s); .fi .PP .PP -\fBSee also:\fP +\fBSee also\fP .RS 4 \fBkrb5_acl_match_file\fP .RE @@ -198,7 +198,7 @@ Returns 0 on success, KRB5_NO_LOCALNAME if no mapping was found, or some Kerbero .PP Inputs: .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A krb5_context .br @@ -213,14 +213,14 @@ Inputs: .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_config_file_free (krb5_context context, krb5_config_section * s)" Free configuration file section, the result of krb5_config_parse_file() and \fBkrb5_config_parse_file_multi()\fP\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context .br \fIs\fP the configuration section to free .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 returns 0 on successes, otherwise an error code, see \fBkrb5_get_error_message()\fP .RE @@ -229,7 +229,7 @@ returns 0 on successes, otherwise an error code, see \fBkrb5_get_error_message() .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_config_free_strings (char ** strings)" Free the resulting strings from krb5_config-get_strings() and \fBkrb5_config_vget_strings()\fP\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIstrings\fP strings to free .RE @@ -240,7 +240,7 @@ Like \fBkrb5_config_get_bool()\fP but with a va_list list of configuration selec .PP Configuration value to a boolean value, where yes/true and any non-zero number means TRUE and other value is FALSE\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -249,7 +249,7 @@ Configuration value to a boolean value, where yes/true and any non-zero number m \fI\&.\&.\&.\fP a list of names, terminated with NULL\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 TRUE or FALSE .RE @@ -258,7 +258,7 @@ TRUE or FALSE .SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_config_get_bool_default (krb5_context context, const krb5_config_section * c, krb5_boolean def_value, \&.\&.\&.)" \fBkrb5_config_get_bool_default()\fP will convert the configuration option value to a boolean value, where yes/true and any non-zero number means TRUE and other value is FALSE\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -269,7 +269,7 @@ TRUE or FALSE \fI\&.\&.\&.\fP a list of names, terminated with NULL\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 TRUE or FALSE .RE @@ -278,7 +278,7 @@ TRUE or FALSE .SS "KRB5_LIB_FUNCTION const krb5_config_binding* KRB5_LIB_CALL krb5_config_get_list (krb5_context context, const krb5_config_section * c, \&.\&.\&.)" Get a list of configuration binding list for more processing .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -287,7 +287,7 @@ Get a list of configuration binding list for more processing \fI\&.\&.\&.\fP a list of names, terminated with NULL\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 NULL if configuration list is not found, a list otherwise .RE @@ -296,7 +296,7 @@ NULL if configuration list is not found, a list otherwise .SS "KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_config_get_string (krb5_context context, const krb5_config_section * c, \&.\&.\&.)" Returns a 'const char *' to a string in the configuration database\&. The string may not be valid after a reload of the configuration database so a caller should make a local copy if it needs to keep the string\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -305,7 +305,7 @@ Returns a 'const char *' to a string in the configuration database\&. The string \fI\&.\&.\&.\fP a list of names, terminated with NULL\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 NULL if configuration string not found, a string otherwise .RE @@ -314,7 +314,7 @@ NULL if configuration string not found, a string otherwise .SS "KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_config_get_string_default (krb5_context context, const krb5_config_section * c, const char * def_value, \&.\&.\&.)" Like \fBkrb5_config_get_string()\fP, but instead of returning NULL, instead return a default value\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -325,7 +325,7 @@ Like \fBkrb5_config_get_string()\fP, but instead of returning NULL, instead retu \fI\&.\&.\&.\fP a list of names, terminated with NULL\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 a configuration string .RE @@ -334,7 +334,7 @@ a configuration string .SS "KRB5_LIB_FUNCTION char** KRB5_LIB_CALL krb5_config_get_strings (krb5_context context, const krb5_config_section * c, \&.\&.\&.)" Get a list of configuration strings, free the result with \fBkrb5_config_free_strings()\fP\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -343,7 +343,7 @@ Get a list of configuration strings, free the result with \fBkrb5_config_free_st \fI\&.\&.\&.\fP a list of names, terminated with NULL\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 TRUE or FALSE .RE @@ -352,7 +352,7 @@ TRUE or FALSE .SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_config_get_time (krb5_context context, const krb5_config_section * c, \&.\&.\&.)" Get the time from the configuration file using a relative time, for example: 1h30s .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -361,7 +361,7 @@ Get the time from the configuration file using a relative time, for example: 1h3 \fI\&.\&.\&.\fP a list of names, terminated with NULL\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 parsed the time or -1 on error .RE @@ -370,7 +370,7 @@ parsed the time or -1 on error .SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_config_get_time_default (krb5_context context, const krb5_config_section * c, int def_value, \&.\&.\&.)" Get the time from the configuration file using a relative time, for example: 1h30s .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -381,7 +381,7 @@ Get the time from the configuration file using a relative time, for example: 1h3 \fI\&.\&.\&.\fP a list of names, terminated with NULL\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 parsed the time (or def_value on parse error) .RE @@ -390,7 +390,7 @@ parsed the time (or def_value on parse error) .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_config_parse_file_multi (krb5_context context, const char * fname, krb5_config_section ** res)" Parse a configuration file and add the result into res\&. This interface can be used to parse several configuration files into one resulting krb5_config_section by calling it repeatably\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Kerberos 5 context\&. .br @@ -399,7 +399,7 @@ Parse a configuration file and add the result into res\&. This interface can be \fIres\fP the returned result, must be free with \fBkrb5_free_config_files()\fP\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -408,7 +408,7 @@ If the fname starts with '~/' parse configuration file in the current users home .SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_config_vget_bool (krb5_context context, const krb5_config_section * c, va_list args)" \fBkrb5_config_get_bool()\fP will convert the configuration option value to a boolean value, where yes/true and any non-zero number means TRUE and other value is FALSE\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -417,7 +417,7 @@ If the fname starts with '~/' parse configuration file in the current users home \fIargs\fP a va_list of arguments .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 TRUE or FALSE .RE @@ -428,7 +428,7 @@ Like \fBkrb5_config_get_bool_default()\fP but with a va_list list of configurati .PP Configuration value to a boolean value, where yes/true and any non-zero number means TRUE and other value is FALSE\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -439,7 +439,7 @@ Configuration value to a boolean value, where yes/true and any non-zero number m \fIargs\fP a va_list of arguments .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 TRUE or FALSE .RE @@ -448,7 +448,7 @@ TRUE or FALSE .SS "KRB5_LIB_FUNCTION const krb5_config_binding* KRB5_LIB_CALL krb5_config_vget_list (krb5_context context, const krb5_config_section * c, va_list args)" Get a list of configuration binding list for more processing .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -457,7 +457,7 @@ Get a list of configuration binding list for more processing \fIargs\fP a va_list of arguments .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 NULL if configuration list is not found, a list otherwise .RE @@ -466,7 +466,7 @@ NULL if configuration list is not found, a list otherwise .SS "KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_config_vget_string (krb5_context context, const krb5_config_section * c, va_list args)" Like \fBkrb5_config_get_string()\fP, but uses a va_list instead of \&.\&.\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -475,7 +475,7 @@ Like \fBkrb5_config_get_string()\fP, but uses a va_list instead of \&.\&.\&. \fIargs\fP a va_list of arguments .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 NULL if configuration string not found, a string otherwise .RE @@ -484,7 +484,7 @@ NULL if configuration string not found, a string otherwise .SS "KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_config_vget_string_default (krb5_context context, const krb5_config_section * c, const char * def_value, va_list args)" Like \fBkrb5_config_vget_string()\fP, but instead of returning NULL, instead return a default value\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -495,7 +495,7 @@ Like \fBkrb5_config_vget_string()\fP, but instead of returning NULL, instead ret \fIargs\fP a va_list of arguments .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 a configuration string .RE @@ -504,7 +504,7 @@ a configuration string .SS "KRB5_LIB_FUNCTION char** KRB5_LIB_CALL krb5_config_vget_strings (krb5_context context, const krb5_config_section * c, va_list args)" Get a list of configuration strings, free the result with \fBkrb5_config_free_strings()\fP\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -513,7 +513,7 @@ Get a list of configuration strings, free the result with \fBkrb5_config_free_st \fIargs\fP a va_list of arguments .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 TRUE or FALSE .RE @@ -522,7 +522,7 @@ TRUE or FALSE .SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_config_vget_time (krb5_context context, const krb5_config_section * c, va_list args)" Get the time from the configuration file using a relative time, for example: 1h30s .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -531,7 +531,7 @@ Get the time from the configuration file using a relative time, for example: 1h3 \fIargs\fP a va_list of arguments .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 parsed the time or -1 on error .RE @@ -542,7 +542,7 @@ Get the time from the configuration file using a relative time\&. .PP Like \fBkrb5_config_get_time_default()\fP but with a va_list list of configuration selection\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br @@ -553,7 +553,7 @@ Like \fBkrb5_config_get_time_default()\fP but with a va_list list of configurati \fIargs\fP a va_list of arguments .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 parsed the time (or def_value on parse error) .RE @@ -562,7 +562,7 @@ parsed the time (or def_value on parse error) .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_expand_hostname (krb5_context context, const char * orig_hostname, char ** new_hostname)" \fBkrb5_expand_hostname()\fP tries to make orig_hostname into a more canonical one in the newly allocated space returned in new_hostname\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context .br @@ -571,7 +571,7 @@ parsed the time (or def_value on parse error) \fInew_hostname\fP output hostname, caller must free hostname with krb5_xfree()\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -580,7 +580,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_expand_hostname_realms (krb5_context context, const char * orig_hostname, char ** new_hostname, char *** realms)" \fBkrb5_expand_hostname_realms()\fP expands orig_hostname to a name we believe to be a hostname in newly allocated space in new_hostname and return the realms new_hostname is believed to belong to in realms\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context .br @@ -591,7 +591,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. \fIrealms\fP output possible realms, is an array that is terminated with NULL\&. Caller must free with \fBkrb5_free_host_realm()\fP\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -600,14 +600,14 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_host_realm (krb5_context context, krb5_realm * realmlist)" Free all memory allocated by `realmlist' .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP A Kerberos 5 context\&. .br \fIrealmlist\fP realmlist to free, NULL is ok .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 a Kerberos error code, always 0\&. .RE @@ -626,7 +626,7 @@ Optionally, a set of files may be put in ~/\&.k5login\&.d (a directory), in whic .PP If no configuration file exists, match user against local domains, ie luser@LOCAL-REALMS-IN-CONFIGURATION-FILES\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP Kerberos 5 context\&. .br @@ -635,7 +635,7 @@ If no configuration file exists, match user against local domains, ie luser@LOCA \fIluser\fP local user id .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 returns TRUE if access should be granted, FALSE otherwise\&. .RE @@ -644,7 +644,7 @@ returns TRUE if access should be granted, FALSE otherwise\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_plugin_register (krb5_context context, enum krb5_plugin_type type, const char * name, void * symbol)" Register a plugin symbol name of specific type\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context .br @@ -655,7 +655,7 @@ Register a plugin symbol name of specific type\&. \fIsymbol\fP a pointer to the named symbol .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 In case of error a non zero error com_err error is returned and the Kerberos error string is set\&. .RE @@ -663,4 +663,4 @@ In case of error a non zero error com_err error is returned and the Kerberos err .SH "Author" .PP -Generated automatically by Doxygen for HeimdalKerberos5library from the source code\&. +Generated automatically by Doxygen for Heimdal Kerberos 5 library from the source code\&. |