Updated text for the KRB5_TRACE env variable.
[krb5.git] / doc / implement / libos-i.tex
1 The operating-system specific functions provide an interface between the
2 other parts of the \libname{libkrb5.a} libraries and the operating system.
3
4 Beware! Any of the functions below are allowed to be implemented as
5 macros.  Prototypes for functions can be found in {\tt
6 <krb5/libos-proto.h>}; other definitions (including macros, if used) are
7 in {\tt <krb5/libos.h>}.
8
9 The following global symbols are provided in \libname{libos.a}.  If you
10 wish to substitute for any of them, you must substitute for all of them
11 (they are all declared and initialized in the same object file):
12 \begin{description}
13 % These come from src/lib/osconfig.c
14 \item[extern char *\globalname{krb5_config_file}:] name of configuration file
15 \item[extern char *\globalname{krb5_trans_file}:] name of hostname/realm
16 name translation file
17 \item[extern char *\globalname{krb5_defkeyname}:] default name of key
18 table file
19 \item[extern char *\globalname{krb5_lname_file}:] name of aname/lname
20 translation database
21 \item[extern int \globalname{krb5_max_dgram_size}:] maximum allowable
22 datagram size
23 \item[extern int \globalname{krb5_max_skdc_timeout}:] maximum
24 per-message KDC reply timeout
25 \item[extern int \globalname{krb5_skdc_timeout_shift}:] shift factor
26 (bits) to exponentially back-off the KDC timeouts
27 \item[extern int \globalname{krb5_skdc_timeout_1}:] initial KDC timeout
28 \item[extern char *\globalname{krb5_kdc_udp_portname}:] name of KDC UDP port
29 \item[extern char *\globalname{krb5_default_pwd_prompt1}:] first prompt
30 for password reading.
31 \item[extern char *\globalname{krb5_default_pwd_prompt2}:] second prompt
32
33 \end{description}
34