src/libuafs/README

   1 Copyright 2000, International Business Machines Corporation.
   2 All Rights Reserved.
   3
   4 This software has been released under the terms of the IBM Public
   5 License.  For details, see the LICENSE file in the top-level source
   6 directory or online at http://www.openafs.org/dl/license10.html.
   7
   8 README file for libuafs, Version 1.2 06/04/2003.
   9
  10
  11 ### INTRODUCTION ###
  12
  13 This Makefile generates two libraries, the standard libuafs.a and
  14 libuafs_pic.a, suitable for linking into shared libraries.
  15
  16 The libuafs.a library facilitates user authentication at a process
  17 level and enables access and manipulation of the files and access
  18 control lists (ACLs).  By way of the libuafs.a klog function
  19 (uafs_klog), the authenticated user's credentials are bound to the
  20 executing process and therefore is granted permission to act on behalf
  21 of the authenticated user.
  22
  23
  24 ### LIBUAFS ###
  25
  26 As of 05/13/2002 the libuafs.a library remains unchanged with respect
  27 to OpenAFS release 1.2.3.
  28
  29
  30 *afs_setpag_val
  31 A function like setpag but sets the current thread's pag id to a
  32 caller-provided value instead of calling genpag().  This implements a
  33 form of token caching since the caller can recall a particular pag value
  34 for the thread to restore tokens, rather than reauthenticating.
  35
  36
  37 ### BUILD ###
  38
  39 A simple "make" will build libuafs.a and libuafs_pic.a.
  40
  41
  42 ### DIRECTORIES ###
  43
  44 The libuafs/UAFS directory is generated by the Makefile and contains the
  45 object files and local copy of libuafs.a resulting from the build process.
  46 The libuafs/UAFS.pic directory is the same as libuafs/UAFS, however it
  47 contains output files respective to libuafs_pic.a.