diff options
Diffstat (limited to 'crypto/heimdal/lib/kafs/kafs.3')
-rw-r--r-- | crypto/heimdal/lib/kafs/kafs.3 | 56 |
1 files changed, 29 insertions, 27 deletions
diff --git a/crypto/heimdal/lib/kafs/kafs.3 b/crypto/heimdal/lib/kafs/kafs.3 index 534c6e8..934d121 100644 --- a/crypto/heimdal/lib/kafs/kafs.3 +++ b/crypto/heimdal/lib/kafs/kafs.3 @@ -1,4 +1,4 @@ -.\" $Id: kafs.3,v 1.6 2001/11/22 08:07:50 joda Exp $ +.\" $Id: kafs.3,v 1.8 2002/08/28 20:04:31 joda Exp $ .\" .Dd May 7, 1997 .Os KTH-KRB @@ -14,6 +14,8 @@ .\" .Nm krb5_afslog , .\" .Nm krb5_afslog_uid .Nd AFS library +.Sh LIBRARY +AFS cache manager access library (libkafs, -lkafs) .Sh SYNOPSIS .Fd #include <kafs.h> .Ft int @@ -49,26 +51,26 @@ obtains new tokens (and possibly tickets) for the specified .Fa cell and .Fa realm . -If +If .Fa cell -is +is .Dv NULL , -the local cell is used. If -.Fa realm +the local cell is used. If +.Fa realm is .Dv NULL , the function tries to guess what realm to use. Unless you have some good knowledge of what cell or realm to use, you should pass -.Dv NULL . -.Fn krb_afslog +.Dv NULL . +.Fn krb_afslog will use the real user-id for the .Dv ViceId -field in the token, +field in the token, .Fn krb_afslog_uid will use .Fa uid . .Pp .\" .Fn krb5_afslog , -.\" and +.\" and .\" .Fn krb5_afslog_uid .\" are the Kerberos 5 equivalents of .\" .Fn krb_afslog , @@ -83,15 +85,15 @@ will use .\" function will be used. .\" .Pp .Fn k_afs_cell_of_file -will in +will in .Fa cell return the cell of a specified file, no more than .Fa len -characters is put in +characters is put in .Fa cell . .Pp .Fn k_pioctl -does a +does a .Fn pioctl syscall with the specified arguments. This function is equivalent to .Fn lpioctl . @@ -101,18 +103,6 @@ initializes a new PAG. .Pp .Fn k_unlog removes destroys all tokens in the current PAG. -.Sh ENVIRONMENT -The following environment variable affect the mode of operation of -.Nm kafs : -.Bl -tag -width AFS_SYSCALL -.It Ev AFS_SYSCALL -Normally, -.Nm kafs -will try to figure out the correct system call(s) that are used by AFS -by itself. If it does not manage to do that, or does it incorrectly, -you can set this variable to the system call number or list of system -call numbers that should be used. -.El .Sh RETURN VALUES .Fn k_hasafs returns 1 if AFS is present in the kernel, 0 otherwise. @@ -121,14 +111,26 @@ and .Fn krb_afslog_uid returns 0 on success, or a kerberos error number on failure. .Fn k_afs_cell_of_file , -.Fn k_pioctl , +.Fn k_pioctl , .Fn k_setpag , and .Fn k_unlog all return the value of the underlaying system call, 0 on success. +.Sh ENVIRONMENT +The following environment variable affect the mode of operation of +.Nm kafs : +.Bl -tag -width AFS_SYSCALL +.It Ev AFS_SYSCALL +Normally, +.Nm kafs +will try to figure out the correct system call(s) that are used by AFS +by itself. If it does not manage to do that, or does it incorrectly, +you can set this variable to the system call number or list of system +call numbers that should be used. +.El .Sh EXAMPLES The following code from -.Nm login +.Nm login will obtain a new PAG and tokens for the local cell and the cell of the users home directory. .Bd -literal @@ -141,7 +143,7 @@ if (k_hasafs()) { } .Ed .Sh ERRORS -If any of these functions (apart from +If any of these functions (apart from .Fn k_hasafs ) is called without AFS beeing present in the kernel, the process will usually (depending on the operating system) receive a SIGSYS signal. |