xref: /freebsd/crypto/heimdal/lib/krb5/krb5_appdefault.3 (revision b52b9d56d4e96089873a75f9e29062eec19fabba)
1.\" Copyright (c) 2000 Kungliga Tekniska H�gskolan
2.\" $Id: krb5_appdefault.3,v 1.5 2001/06/23 22:35:19 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.Fa appname
46is the name of the application, and
47.Fa realm
48is the realm name. If the realm is omitted it will not be used for
49resolving values.
50.Fa def_val
51is the value to return if no value is found in
52.Xr krb5.conf 5 .
53.Sh SEE ALSO
54.Xr krb5_config 3 ,
55.Xr krb5.conf 5
56