crypto/heimdal/lib/krb5/krb5_appdefault.3

   1 .\" Copyright (c) 2000 Kungliga Tekniska Högskolan
   2 .\" $Id: krb5_appdefault.3,v 1.7 2002/08/28 15:30:46 joda 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 LIBRARY
  12 Kerberos 5 Library (libkrb5, -lkrb5)
  13 .Sh SYNOPSIS
  14 .Fd #include <krb5.h>
  15 .Ft void
  16 .Fn krb5_appdefault_boolean "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "krb5_boolean def_val" "krb5_boolean *ret_val"
  17 .Ft void
  18 .Fn krb5_appdefault_string "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "const char *def_val" "char **ret_val"
  19 .Ft void
  20 .Fn krb5_appdefault_time "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "time_t def_val" "time_t *ret_val"
  21 .Sh DESCRIPTION
  22 These functions get application application defaults from the
  23 .Dv appdefaults
  24 section of the
  25 .Xr krb5.conf 5
  26 configuration file. These defaults can be specified per application,
  27 and/or per realm.
  28 .Pp
  29 These values will be looked for in
  30 .Xr krb5.conf 5 ,
  31 in order of descending importance.
  32 .Bd -literal -offset indent
  33 [appdefaults]
  34         appname = {
  35                 realm = {
  36                         option = value
  37                 }
  38         }
  39         appname = {
  40                 option = value
  41         }
  42         realm = {
  43                 option = value
  44         }
  45         option = value
  46 .Ed
  47 .Fa appname
  48 is the name of the application, and
  49 .Fa realm
  50 is the realm name. If the realm is omitted it will not be used for
  51 resolving values.
  52 .Fa def_val
  53 is the value to return if no value is found in
  54 .Xr krb5.conf 5 .
  55 .Sh SEE ALSO
  56 .Xr krb5_config 3 ,
  57 .Xr krb5.conf 5