xref: /freebsd/crypto/heimdal/lib/krb5/krb5_appdefault.3 (revision 5521ff5a4d1929056e7ffc982fac3341ca54df7c)
1.\" Copyright (c) 2000 Kungliga Tekniska H�gskolan
2.\" $Id: krb5_appdefault.3,v 1.4 2001/05/02 08:59:23 assar Exp $
3.Dd July 25, 2000
4.Dt KRB5_APPDEFAULT 3
5.Os HEIMDAL
6.Sh NAME
7.Nm krb5_appdefault_boolean ,
8.Nm krb5_appdefault_string ,
9.Nm krb5_appdefault_time
10.Nd get application configuration value
11.Sh SYNOPSIS
12.Fd #include <krb5.h>
13.Ft void
14.Fn krb5_appdefault_boolean "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "krb5_boolean def_val" "krb5_boolean *ret_val"
15.Ft void
16.Fn krb5_appdefault_string "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "const char *def_val" "char **ret_val"
17.Ft void
18.Fn krb5_appdefault_time "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "time_t def_val" "time_t *ret_val"
19.Sh DESCRIPTION
20These functions get application application defaults from the
21.Dv appdefaults
22section of the
23.Xr krb5.conf 5
24configuration file. These defaults can be specified per application,
25and/or per realm.
26.Pp
27These values will be looked for in
28.Xr krb5.conf 5 ,
29in order of descending importance.
30.Bd -literal -offset indent
31[appdefaults]
32	appname = {
33		realm = {
34			option = value
35		}
36	}
37	appname = {
38		option = value
39	}
40	realm = {
41		option = value
42	}
43	option = value
44.Ed
45.Pp
46If the realm is omitted it will not be used for resolving values.  If
47no value can be found,
48.Fa def_val
49is returned instead.
50.Sh SEE ALSO
51.Xr krb5_config 3 ,
52.Xr krb5.conf 5
53