freebsd-dev/crypto/heimdal/lib/krb5/krb5_appdefault.3

.\" Copyright (c) 2000 Kungliga Tekniska H<>gskolan
.\" $Id: krb5_appdefault.3,v 1.4 2001/05/02 08:59:23 assar Exp $
.Dd July 25, 2000
.Dt KRB5_APPDEFAULT 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_appdefault_boolean ,
.Nm krb5_appdefault_string ,
.Nm krb5_appdefault_time
.Nd get application configuration value
.Sh SYNOPSIS
.Fd #include <krb5.h>
.Ft void
.Fn krb5_appdefault_boolean "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "krb5_boolean def_val" "krb5_boolean *ret_val"
.Ft void
.Fn krb5_appdefault_string "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "const char *def_val" "char **ret_val"
.Ft void
.Fn krb5_appdefault_time "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "time_t def_val" "time_t *ret_val"
.Sh DESCRIPTION
These functions get application application defaults from the 
.Dv appdefaults
section of the
.Xr krb5.conf 5 
configuration file. These defaults can be specified per application,
and/or per realm.
.Pp
These values will be looked for in 
.Xr krb5.conf 5 ,
in order of descending importance.
.Bd -literal -offset indent
[appdefaults]
	appname = {
		realm = {
			option = value
		}
	}
	appname = {
		option = value
	}
	realm = {
		option = value
	}
	option = value
.Ed
.Pp
If the realm is omitted it will not be used for resolving values.  If
no value can be found,
.Fa def_val
is returned instead.
.Sh SEE ALSO
.Xr krb5_config 3 ,
.Xr krb5.conf 5