freebsd-nq/eBones/krb/krb_set_tkt_string.3
Jordan K. Hubbard 2b6645c034 Various documentation changes.
Submitted by:	Mark Murray <mark@grondar.za>
1995-02-08 10:54:30 +00:00

44 lines
1.3 KiB
Groff

.\" from: krb_set_tkt_string.3,v 4.1 89/01/23 11:11:09 jtkohl Exp $
.\" $Id: krb_set_tkt_string.3,v 1.1.1.1 1994/09/30 14:50:07 csgr Exp $
.\" Copyright 1989 by the Massachusetts Institute of Technology.
.\"
.\" For copying and distribution information,
.\" please see the file <Copyright.MIT>.
.\"
.TH KRB_SET_TKT_STRING 3 "Kerberos Version 4.0" "MIT Project Athena"
.SH NAME
krb_set_tkt_string \- set Kerberos ticket cache file name
.SH SYNOPSIS
.nf
.nj
.ft B
#include <kerberosIV/krb.h>
.PP
.ft B
void krb_set_tkt_string(filename)
char *filename;
.fi
.ft R
.SH DESCRIPTION
.I krb_set_tkt_string
sets the name of the file that holds the user's
cache of Kerberos server tickets and associated session keys.
.PP
The string
.I filename
passed in is copied into local storage.
Only MAXPATHLEN-1 (see <sys/param.h>) characters of the filename are
copied in for use as the cache file name.
.PP
This routine should be called during initialization, before other
Kerberos routines are called; otherwise the routines which fetch the
ticket cache file name may be called and return an undesired ticket file
name until this routine is called.
.SH FILES
.TP 20n
/tmp/tkt[uid]
default ticket file name, unless the environment variable KRBTKFILE is set.
[uid] denotes the user's uid, in decimal.
.SH SEE ALSO
kerberos(3), setenv(3)