windows-force-krb524-20030921

[openafs.git] / doc / txt / winnotes / registry.txt

diff --git a/doc/txt/winnotes/registry.txt b/doc/txt/winnotes/registry.txt
index 2d94d82..3ba0797 100644 (file)
--- a/doc/txt/winnotes/registry.txt
+++ b/doc/txt/winnotes/registry.txt
@@ -28,11 +28,11 @@ Variable: LANadapter
   name will be 'AFS'.
 
 Value   : CacheSize
-Type    : QWORD
+Type    : DWORD
 Default : 20480 (CM_CONFIGDEFAULT_CACHESIZE)
 Variable: cm_initParams.cacheSize
 
-  Size of the AFS cache.
+  Size of the AFS cache in 1k blocks.
 
 Value   : ChunkSize
 Type    : DWORD
@@ -58,7 +58,7 @@ Variable: numSvThreads
   smb_Server in smb.c).
 
 Value  : Stats
-Type   : QWORD
+Type   : DWORD
 Default : 1000 (CM_CONFIGDEFAULT_STATS)
 Variable: cm_initParams.nStatCaches
 
@@ -76,7 +76,7 @@ Variable: smb_LogoffTokenTransfer
   that the tokens remain valid until the profile save is complete.
 
 Value  : LogoffTokenTransferTimeout
-Type   : QWORD
+Type   : DWORD
 Default : 10
 Variable: smb_LogoffTokenTransferTimeout
 
@@ -104,13 +104,26 @@ Variable: cm_mountRoot
   where the symlink exists)
  
 Value  : CachePath
-Type   : REG_SZ
-Default : "\AFSCache"
+Type   : REG_SZ or REG_EXPAND_SZ
+Default : "%SYSTEMDRIVE%\AFSCache"
 Variable: cm_CachePath
 
   Location of on-disk cache file.  The default implies the root 
   directory of the boot disk
 
+
+Value   : NonPersistentCaching
+Type    : DWORD [0..1]
+Default : 0
+Variable: buf_CacheType
+
+  When this registry value is set to a non-zero value, the CachePath
+  value is ignored and the cache data is stored in the windows paging
+  file.  This prevents the use of persistent caching (when available)
+  as well as the ability to alter the size of the cache at runtime
+  using the "fs setcachesize" command.
+
+
 Value  : TrapOnPanic
 Type   : DWORD {1,0}
 Default : 0
@@ -152,7 +165,7 @@ Variable: reportSessionStartups
   or various error types to be logged.
 
 Value  : TraceBufferSize
-Type   : QWORD
+Type   : DWORD
 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
 Variable: traceBufSize
 
@@ -601,6 +614,10 @@ Function: InitApp(), Main_OnCheckTerminate()
   This value used to be stored at 
   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
 
+  The current user value is checked first; if it does not exist the local 
+  machine value is checked.
+
+
 Value   : EnableKFW
 Type    : DWORD {0, 1}
 Default : 1
@@ -608,7 +625,19 @@ Function: KFW_is_available()
 
   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
   to obtain AFS credentials.  By setting this value to 0, the internal
-  Kerberos 4 implementation will be used instead.
+  Kerberos 4 implementation will be used instead.  The current user value 
+  is checked first; if it does not exist the local machine value is checked.
+
+Value   : Use524
+Type    : DWORD {0, 1}
+Default : 0
+Function: KFW_use_krb524()
+
+  When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
+  to obtain AFS credentials.  By setting this value to 1, the Kerberos 5
+  tickets will be converted to Kerberos 4 tokens via a call to the krb524
+  daemon.  The current user value is checked first; if it does not exist 
+  the local machine value is checked.
 
 Value   : AfscredsShortcutParams
 Type    : REG_SZ
@@ -616,7 +645,12 @@ Default : "-A -M -N -Q"
 Function: Shortcut_FixStartup
 
   This value specifies the command line options which should be set
-  as part of the shortcut to afscreds.exe.
+  as part of the shortcut to afscreds.exe.  afscreds.exe rewrites the 
+  shortcut each time it exits so as to ensure that the shortcut points
+  to the latest version of the program.  This value is used to determine
+  which values should be used for command line parameters.  The current
+  user value is checked first; if it does not exist the local machine
+  value is checked.
 
 
 Regkey: