Initial import from FreeBSD RELENG_4:
[games.git] / crypto / kerberosIV / man / krb_set_tkt_string.3
1 .\" $Id: krb_set_tkt_string.3,v 1.2 1996/06/12 21:29:24 bg Exp $
2 .\" Copyright 1989 by the Massachusetts Institute of Technology.
3 .\"
4 .\" For copying and distribution information,
5 .\" please see the file <mit-copyright.h>.
6 .\"
7 .TH KRB_SET_TKT_STRING 3 "Kerberos Version 4.0" "MIT Project Athena"
8 .SH NAME
9 krb_set_tkt_string \- set Kerberos ticket cache file name
10 .SH SYNOPSIS
11 .nf
12 .nj
13 .ft B
14 #include <krb.h>
15 .PP
16 .ft B
17 void krb_set_tkt_string(filename)
18 char *filename;
19 .fi
20 .ft R
21 .SH DESCRIPTION
22 .I krb_set_tkt_string
23 sets the name of the file that holds the user's
24 cache of Kerberos server tickets and associated session keys.
25 .PP
26 The string 
27 .I filename
28 passed in is copied into local storage.
29 Only MAXPATHLEN-1 (see <sys/param.h>) characters of the filename are
30 copied in for use as the cache file name.
31 .PP
32 This routine should be called during initialization, before other
33 Kerberos routines are called; otherwise the routines which fetch the
34 ticket cache file name may be called and return an undesired ticket file
35 name until this routine is called.
36 .SH FILES
37 .TP 20n
38 /tmp/tkt[uid]
39 default ticket file name, unless the environment variable KRBTKFILE is set.
40 [uid] denotes the user's uid, in decimal.
41 .SH SEE ALSO
42 kerberos(3), setenv(3)