crypto/external/bsd/heimdal/dist/lib/krb5/krb5_appdefault.3

   1 .\"     $NetBSD: krb5_appdefault.3,v 1.1.1.2 2011/04/14 14:09:22 elric Exp $
   2 .\"
   3 .\" Copyright (c) 2000 Kungliga Tekniska Högskolan
   4 .\" (Royal Institute of Technology, Stockholm, Sweden).
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" 3. Neither the name of the Institute nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\" Id
  35 .\"
  36 .Dd July 25, 2000
  37 .Dt KRB5_APPDEFAULT 3
  38 .Os
  39 .Sh NAME
  40 .Nm krb5_appdefault_boolean ,
  41 .Nm krb5_appdefault_string ,
  42 .Nm krb5_appdefault_time
  43 .Nd get application configuration value
  44 .Sh LIBRARY
  45 Kerberos 5 Library (libkrb5, -lkrb5)
  46 .Sh SYNOPSIS
  47 .In krb5/krb5.h
  48 .Ft void
  49 .Fn krb5_appdefault_boolean "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "krb5_boolean def_val" "krb5_boolean *ret_val"
  50 .Ft void
  51 .Fn krb5_appdefault_string "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "const char *def_val" "char **ret_val"
  52 .Ft void
  53 .Fn krb5_appdefault_time "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "time_t def_val" "time_t *ret_val"
  54 .Sh DESCRIPTION
  55 These functions get application defaults from the
  56 .Dv appdefaults
  57 section of the
  58 .Xr krb5.conf 5
  59 configuration file. These defaults can be specified per application,
  60 and/or per realm.
  61 .Pp
  62 These values will be looked for in
  63 .Xr krb5.conf 5 ,
  64 in order of descending importance.
  65 .Bd -literal -offset indent
  66 [appdefaults]
  67         appname = {
  68                 realm = {
  69                         option = value
  70                 }
  71         }
  72         appname = {
  73                 option = value
  74         }
  75         realm = {
  76                 option = value
  77         }
  78         option = value
  79 .Ed
  80 .Fa appname
  81 is the name of the application, and
  82 .Fa realm
  83 is the realm name. If the realm is omitted it will not be used for
  84 resolving values.
  85 .Fa def_val
  86 is the value to return if no value is found in
  87 .Xr krb5.conf 5 .
  88 .Sh SEE ALSO
  89 .Xr krb5_config 3 ,
  90 .Xr krb5.conf 5