windows-notes-upd-20041130
[openafs.git] / doc / txt / winnotes / registry.txt
index c762115..064455d 100644 (file)
@@ -28,7 +28,7 @@ Variable: LANadapter
   name will be 'AFS'.
 
 Value   : CacheSize
-Type    : QWORD
+Type    : DWORD
 Default : 20480 (CM_CONFIGDEFAULT_CACHESIZE)
 Variable: cm_initParams.cacheSize
 
@@ -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
 
@@ -165,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
 
@@ -176,7 +176,9 @@ Type        : REG_SZ
 Default : "i386_nt40"
 Variable: cm_sysName
 
-  Self explanatory.
+  Provides an initial value for "fs sysname".  The string can contain
+  one or more replacement values for @sys in order of preference separated 
+  by whitespace.
 
 Value  : SecurityLevel
 Type   : DWORD {1,0}
@@ -334,6 +336,12 @@ Default : 100K
   the file will be reset to 0 bytes.  If this value is 0, it means the file
   should be allowed to grow indefinitely.
 
+Value   : FlushOnHibernate
+Type    : DWORD {0,1}
+Default : 1
+
+  If set, flushes all volumes before the machine goes on hibernate or
+  stand-by.
 
 Regkey:
 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
@@ -426,6 +434,32 @@ Default : <not defined>
   directory is used.
 
 
+Value   : VerifyServiceSignature
+Type   : REG_DWORD
+Default : 0x1
+
+  This value can be used to disable the runtime verification of 
+  the digital signatures applied to afsd_service.exe and the 
+  OpenAFS DLLs it loads.  This test is performed to verify that 
+  the DLLs which are loaded by afsd_service.exe are from the 
+  same distribution as afsd_service.exe.  This is to prevent
+  random errors caused when DLLs from one distribution of AFS
+  are loaded by another one.  This is not a security test.  The
+  reason for disabling this test is to free up additional memory
+  which can be used for a large cache size.
+
+
+Value   : IoctlDebug
+Type   : REG_DEBUG
+Default : 0x0
+
+  This value can be used to debug the cause of pioctl() failures.
+  Set a non-zero value and the pioctl() library will output status
+  information to stdout.  Executing command line tools such as
+  tokens.exe, fs.exe, etc can then be used to determine why the
+  pioctl() call is failing. 
+
+
 
 2.1 Domain specific configuration keys for the Network Provider
 ---------------------------------------------------------------
@@ -614,6 +648,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
@@ -621,7 +659,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
@@ -629,7 +679,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:
@@ -704,21 +759,38 @@ Value   : "numeric value"
 Type    : REG_SZ
 Default : <none>
 
-    This key is used to store newline terminated mount point strings 
+    This key is used to store dot terminated mount point strings 
     for use in constructing the fake root.afs volume when Freelance
     (dynamic roots) mode is activated.
 
-        "athena.mit.edu#athena.mit.edu:root.cell.\n"
-        ".athena.mit.edu%athena.mit.edu:root.cell.\n"
+        "athena.mit.edu#athena.mit.edu:root.cell."
+        ".athena.mit.edu%athena.mit.edu:root.cell."
 
     These values used to be stored in afs_freelance.ini
 
 
 Regkey:
+[HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]
+
+Value   : "numeric value"
+Type    : REG_SZ
+Default : <none>
+
+    This key is used to store a dot terminated symlink strings 
+    for use in constructing the fake root.afs volume when Freelance
+    (dynamic roots) mode is activated.
+
+        "linkname:destination-path."
+        "athena:athena.mit.edu."
+        "home:athena.mit.edu\user\j\a\jaltman."
+        "filename:path\file."
+
+
+Regkey:
 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
 
 Value   : "submount name"
-Type    : REG_SZ
+Type    : REG_EXPAND_SZ
 Default : <none>
 
     This key is used to store mappings of unix style AFS paths