windows-notes-20050317
[openafs.git] / doc / txt / winnotes / registry.txt
1
2 Registry keys and Environment Variables used in the Windows AFS Client
3 ----------------------------------------------------------------------
4
5 REGISTRY KEYS:
6
7 1. Service parameters
8 ---------------------
9
10 The service parameters primarily affect the behavior of the AFS client
11 service (afsd_service.exe).
12
13 Regkey:
14 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
15
16 Value   : LANadapter
17 Type    : DWORD
18 Default : -1
19 Variable: LANadapter
20
21   LAN adapter number to use.  This is the lana number of the LAN
22   adapter that the SMB server should bind to.  If unspecified or set
23   to -1, a LAN adapter with named 'AFS' or a loopback adapter will be
24   selected.  If neither are present, then all available adapters will
25   be bound to.  When binding to a non-loopback adapter, the NetBIOS
26   name '%hostname%-AFS' will be used (where %hostname% is the NetBIOS
27   name of the host truncated to 11 characters). Otherwise, the NetBIOS
28   name will be 'AFS'.
29
30 Value   : CacheSize
31 Type    : DWORD
32 Default : 98304 (CM_CONFIGDEFAULT_CACHESIZE)
33 Variable: cm_initParams.cacheSize
34
35   Size of the AFS cache in 1k blocks.
36
37 Value   : ChunkSize
38 Type    : DWORD
39 Default : 17 (CM_CONFIGDEFAULT_CHUNKSIZE)
40 Variable: cm_logChunkSize (cm_chunkSize = 1 << cm_logChunkSize)
41
42   Size of chunk for reading and writing. Actual chunk size is 2^cm_logChunkSize.
43
44 Value   : Daemons
45 Type    : DWORD
46 Default : 2 (CM_CONFIGDEFAULT_DAEMONS)
47 Variable: numBkgD
48
49   Number of background daemons (number of threads of
50   cm_BkgDaemon). (see cm_BkgDaemon in cm_daemon.c)
51
52 Value   : ServerThreads
53 Type    : DWORD
54 Default : 25 (CM_CONFIGDEFAULT_SVTHREADS)
55 Variable: numSvThreads
56
57   Number of SMB server threads (number of threads of smb_Server). (see
58   smb_Server in smb.c).
59
60 Value   : Stats
61 Type    : DWORD
62 Default : 10000 (CM_CONFIGDEFAULT_STATS)
63 Variable: cm_initParams.nStatCaches
64
65   Cache configuration.
66
67 Value   : LogoffTokenTransfer
68 Type    : DWORD {1,0}
69 Default : 1
70 Variable: smb_LogoffTokenTransfer
71
72   If enabled (set to 1), activates functionality where the user's
73   tokens are kept intact until smb_LogoffTokenTransferTimeout seconds
74   elapse after user logs off.  If roaming profiles are used and the
75   roaming profile takes a long time to be written back, this ensures
76   that the tokens remain valid until the profile save is complete.
77
78 Value   : LogoffTokenTransferTimeout
79 Type    : DWORD
80 Default : 10
81 Variable: smb_LogoffTokenTransferTimeout
82
83   See LogoffTokenTransfer above.
84
85 Value   : RootVolume
86 Type    : REG_SZ
87 Default : "root.afs"
88 Variable: cm_rootVolumeName
89
90   Root volume name.
91
92 Value   : Mountroot
93 Type    : REG_SZ
94 Default : "/afs"
95 Variable: cm_mountRoot
96
97   Name of root mount point.  In symlinks, if a path starts with
98   cm_mountRoot, it is assumed that the path is absolute (as opposed to
99   relative) and is adjusted accordingly. Eg: if a path is specified as
100   /afs/athena.mit.edu/foo/bar/baz and cm_mountRoot is "/afs", then the
101   path is interpreted as \\afs\all\athena.mit.edu\foo\bar\baz.  If a
102   path does not start with with cm_mountRoot, the path is assumed to
103   be relative and suffixed to the reference directory (i.e. directory
104   where the symlink exists)
105  
106
107 Value   : CachePath
108 Type    : REG_SZ or REG_EXPAND_SZ
109 Default : "%TEMP%\AFSCache"
110 Variable: cm_CachePath
111
112   Location of on-disk cache file.  The default is the SYSTEM account's
113   TEMP directory.  The attributes assigned to the file are HIDDEN and
114   SYSTEM.
115
116
117 Value   : NonPersistentCaching
118 Type    : DWORD [0..1]
119 Default : 0
120 Variable: buf_CacheType
121
122   When this registry value is set to a non-zero value, the CachePath
123   value is ignored and the cache data is stored in the windows paging
124   file.  This prevents the use of persistent caching (when available)
125   as well as the ability to alter the size of the cache at runtime
126   using the "fs setcachesize" command.
127
128
129 Value   : ValidateCache
130 Type    : DWORD [0..2]
131 Default : 1
132 Variable: buf_CacheType
133
134   This value determines if and when persistent cache validation is 
135   performed.
136     0 - Validation is disabled
137     1 - Validation is performed at startup
138     2 - Validation is performed at shutdown
139
140
141 Value   : TrapOnPanic
142 Type    : DWORD {1,0}
143 Default : 0
144 Variable: traceOnPanic
145
146   Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).
147
148 Value   : NetbiosName
149 Type    : REG_EXPAND_SZ
150 Default : "AFS"
151 Variable: cm_NetbiosName
152
153   Specifies the NetBIOS name to be used when binding to a Loopback
154   adapter.  To provide the old behavior specify a value of 
155   "%COMPUTERNAME%-AFS"
156
157 Value   : IsGateway
158 Type    : DWORD {1,0}
159 Default : 0
160 Variable: isGateway
161
162   Select whether or not this AFS client should act as a gateway.  If
163   set and the NetBIOS name hostname-AFS is bound to a physical NIC,
164   other machines in the subnet can access AFS via SMB connections to
165   hostname-AFS.
166
167   When IsGateway is non-zero, the LAN adapter detection code will
168   avoid binding to a loopback adapter.  This will ensure that the
169   NetBIOS name will be of the form hostname-AFS instead of the value
170   set by the "NetbiosName" registry value.
171
172 Value   : ReportSessionStartups
173 Type    : DWORD {1,0}
174 Default : 0
175 Variable: reportSessionStartups
176
177   If enabled, all SMB sessions created are recorded in the Application
178   event log.  This also enables other events such as drive mappings
179   or various error types to be logged.
180
181 Value   : TraceBufferSize
182 Type    : DWORD
183 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
184 Variable: traceBufSize
185
186   Number of entries to keep in trace log.
187
188 Value   : SysName
189 Type    : REG_SZ
190 Default : "i386_nt40"
191 Variable: cm_sysName
192
193   Provides an initial value for "fs sysname".  The string can contain
194   one or more replacement values for @sys in order of preference separated 
195   by whitespace.
196
197 Value   : SecurityLevel
198 Type    : DWORD {1,0}
199 Default : 0
200 Variable: cryptall
201
202   Enables encryption on RX calls.
203
204 Value   : UseDNS
205 Type    : DWORD {1,0}
206 Default : 1
207 Variable: cm_dnsEnabled
208
209   Enables resolving volservers using AFSDB DNS queries. (see
210   afsdb-freelance-notes).
211
212   As of 1.3.60, this value is ignored as the DNS query support
213   utilizes the Win32 DNSQuery API which is available on Win2000
214   and above.
215
216 Value   : FreelanceClient
217 Type    : DWORD {1,0}
218 Default : 0
219 Variable: cm_freelanceEnabled
220
221   Enables freelance client. (see afsdb-freelance-notes)
222
223 Value   : HideDotFiles
224 Type    : DWORD {1,0}
225 Default : 1
226 Variable: smb_hideDotFiles
227
228   Enables marking dotfiles with the hidden attribute.  Dot files are
229   files whose name starts with a period (excluding "." and "..").
230
231 Value   : MaxMpxRequests
232 Type    : DWORD
233 Default : 50
234 Variable: smb_maxMpxRequests
235
236   Maximum number of multiplexed SMB requests that can be made.
237
238 Value   : MaxVCPerServer
239 Type    : DWORD
240 Default : 100
241 Variable: smb_maxVCPerServer
242
243   Maximum number of SMB virtual circuits.
244
245 Value   : Cell
246 Type    : REG_SZ
247 Default : <none>
248 Variable: rootCellName
249
250   Name of root cell (the cell from which root.afs should be mounted in
251   \\afs\all).
252
253 Value   : RxNoJumbo
254 Type    : DWORD {0,1}
255 Default : 0
256 Variable: rx_nojumbo
257
258   If enabled, does not send or indicate that we are able to send or
259   receive RX jumbograms.
260
261 Value   : RxMaxMTU
262 Type    : DWORD
263 Default : -1
264 Variable: rx_mtu
265
266   If set to anything other than -1, uses that value as the maximum MTU
267   supported by the RX interface.
268
269   In order to enable OpenAFS to operate across the Cisco IPSec VPN
270   client, this value must be set to 1264 or smaller.
271
272 Value   : ConnDeadTimeout
273 Type    : DWORD
274 Default : 60 (seconds)
275 Variable: ConnDeadtimeout
276
277   The Connection Dead Time is enforced to be at a minimum 15 seconds 
278   longer than the minimum SMB timeout as specified by 
279
280   HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters
281     SessTimeout
282
283   If the minimum SMB timeout is not specified the value is 45 seconds.
284   See http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp
285
286
287 Value   : HardDeadTimeout
288 Type    : DWORD
289 Default : 120 (seconds)
290 Variable: HardDeadtimeout
291
292   The Hard Dead Time is enforced to be at least double the ConnDeadTimeout.
293   The provides an opportunity for at least one retry.
294
295
296 Value  : TraceOption
297 Type   : DWORD {0, 1, 2, 3}
298 Default : 0
299
300   Enables logging of debug output to the Windows Event Log.
301   Bit 0 enables logging of "Logon Events" processed by the Network Provider
302   and Winlogon Event Notification Handler.  
303   Bit 1 enables logging of events captured by the AFS Client Service.
304
305 Value   : AllSubmount
306 Type    : DWORD {0, 1}
307 Default : 1
308 Variable: allSubmount (smb.c)
309
310   By setting this value to 0, the "\\NetbiosName\all" mount point 
311   will not be created.  This allows the read-write versions of 
312   root.afs to be hidden.
313
314 Value   : NoFindLanaByName
315 Type    : DWORD {0, 1}
316 Default : 0
317
318   Disables the attempt to identity the network adapter to use by 
319   looking for an adapter with a display name of "AFS".
320
321 Value   : MaxCPUs
322 Type    : DWORD {1..32} or {1..64} depending on the architecture
323 Default : <no default>
324
325   If this value is specified, afsd_service.exe will restrict itself
326   to executing on the specified number of CPUs if there are a greater
327   number installed in the machine.  
328
329   NOTE: Setting this entry to "1" may be required on hyperthreaded 
330   systems to avoid crashes in the RX library.
331
332 Value   : smbAuthType
333 Type    : DWORD {0..2} 
334 Default : 2
335
336   If this value is specified, it defines the type of SMB authentication    
337   which must be present in order for the Windows SMB client to connect
338   to the AFS Client Service's SMB server.  The values are:
339     0 = No authentication required
340     1 = NTLM authentication required
341     2 = Extended (GSS SPNEGO) authentication required
342   The default is Extended authentication
343
344 Value   : MaxLogSize
345 Type    : DWORD {0 .. MAXDWORD}
346 Default : 100K
347
348   This entry determines the maximum size of the %WINDIR%\TEMP\afsd_init.log 
349   file.  If the file is larger than this value when afsd_service.exe starts
350   the file will be reset to 0 bytes.  If this value is 0, it means the file
351   should be allowed to grow indefinitely.
352
353 Value   : FlushOnHibernate
354 Type    : DWORD {0,1}
355 Default : 1
356
357   If set, flushes all volumes before the machine goes on hibernate or
358   stand-by.
359
360 Regkey:
361 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
362
363 Value   : <Drive Letter:> for example "G:"
364 Type    : SZ
365
366     Specifies the submount name to be mapped by afsd_service.exe at startup
367     to the provided drive letter.
368
369
370 Regkey:
371 [HKLM\SOFTWARE\OpenAFS\Client]
372
373 Value   : CellServDBDir
374 Type    : REG_SZ
375 Default : <not defined>
376
377   Specifies the directory containing the CellServDB file.
378   When this value is not specified, the AFS Client install
379   directory is used.
380
381
382 Value   : VerifyServiceSignature
383 Type    : REG_DWORD
384 Default : 0x1
385
386   This value can be used to disable the runtime verification of 
387   the digital signatures applied to afsd_service.exe and the 
388   OpenAFS DLLs it loads.  This test is performed to verify that 
389   the DLLs which are loaded by afsd_service.exe are from the 
390   same distribution as afsd_service.exe.  This is to prevent
391   random errors caused when DLLs from one distribution of AFS
392   are loaded by another one.  This is not a security test.  The
393   reason for disabling this test is to free up additional memory
394   which can be used for a large cache size.
395
396
397 Value   : IoctlDebug
398 Type    : REG_DWORD
399 Default : 0x0
400
401   This value can be used to debug the cause of pioctl() failures.
402   Set a non-zero value and the pioctl() library will output status
403   information to stdout.  Executing command line tools such as
404   tokens.exe, fs.exe, etc can then be used to determine why the
405   pioctl() call is failing. 
406
407
408 Value   : StoreAnsiFilenames
409 Type    : REG_DWORD
410 Default : 0x0
411
412   This value can be used to force the AFS Client Service to
413   store filenames using the Windows system's ANSI character set
414   instead of the OEM Code Page character set which has traditionally
415   been used by SMB file systems.  
416
417   Note: The use of ANSI characters will render access to files
418   with 8-bit OEM file names unaccessible from Windows.  This option
419   is of use primarily when you wish to allow file names produced
420   on Windows to be accessible from Latin-1 Unix systems and vice
421   versa.
422
423
424 Regkey:
425 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
426
427 Value   : "smb/cifs share name"
428 Type    : REG_SZ
429 Default : <none>
430
431     This key is used to map SMB/CIFS shares to Client Side Caching 
432     (off-line access) policies. For each share one of the following
433     policies may be used: "manual", "programs", "documents", "disable"
434
435     These values used to be stored in afsdsbmt.ini
436
437 Regkey:
438 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
439
440 Value   : "numeric value"
441 Type    : REG_SZ
442 Default : <none>
443
444     This key is used to store dot terminated mount point strings 
445     for use in constructing the fake root.afs volume when Freelance
446     (dynamic roots) mode is activated.
447
448         "athena.mit.edu#athena.mit.edu:root.cell."
449         ".athena.mit.edu%athena.mit.edu:root.cell."
450
451     These values used to be stored in afs_freelance.ini
452
453
454 Regkey:
455 [HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]
456
457 Value   : "numeric value"
458 Type    : REG_SZ
459 Default : <none>
460
461     This key is used to store a dot terminated symlink strings 
462     for use in constructing the fake root.afs volume when Freelance
463     (dynamic roots) mode is activated.
464
465         "linkname:destination-path."
466         "athena:athena.mit.edu."
467         "home:athena.mit.edu\user\j\a\jaltman."
468         "filename:path\file."
469
470
471 Regkey:
472 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
473
474 Value   : "submount name"
475 Type    : REG_EXPAND_SZ
476 Default : <none>
477
478     This key is used to store mappings of unix style AFS paths
479     to submount names which can be referenced as UNC paths.
480     For example the submount string "/athena.mit.edu/user/j/a/jaltman"
481     can be associated with the submount name "jaltman.home".
482     This can then be referenced as the UNC path \\AFS\jaltman.home.
483
484     These values used to be stored in afsdsbmt.ini
485
486     NOTE: Submounts should no longer be used with OpenAFS.
487     Use the Windows Explorer to create drive mappings to AFS UNC
488     paths instead of using the AFS Submount mechanism.
489
490
491 Regkey:
492 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\VLDB]
493
494 Value   : "hostname or ip address"
495 Type    : REG_DWORD
496 Default : <none>
497
498     This key is used to specify a default set of VLDB server preferences.
499     For each entry the value name will be either the IP address of a server
500     or a fully qualified domain name.  The value will be the ranking.  The
501     ranking will be adjusted by a random value between 0 and 256 prior to
502     the preference being set.
503
504
505 Regkey:
506 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\File]
507
508 Value   : "hostname or ip address"
509 Type    : REG_DWORD
510 Default : <none>
511
512     This key is used to specify a default set of File server preferences.
513     For each entry the value name will be either the IP address of a server
514     or a fully qualified domain name.  The value will be the ranking.  The
515     ranking will be adjusted by a random value between 0 and 256 prior to
516     the preference being set.
517
518
519
520 2. Network provider parameters
521 ------------------------------
522 Affects the network provider (afslogon.dll).
523
524 Regkey:
525 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
526
527 Value   : FailLoginsSilently
528 Type    : DWORD
529 Default : 0
530
531   Do not display message boxes if the login fails.
532
533 Regkey:
534 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
535
536 Value   : NoWarnings
537 Type    : DWORD
538 Default : 0
539
540   Disables visible warnings during logon.
541
542 Value   : AuthentProviderPath
543 Type    : REG_SZ
544 NSIS    : %WINDIR%\SYSTEM32\afslogon.dll
545
546   Specifies the install location of the authentication provider dll.
547
548 Value   : Class
549 Type    : DWORD
550 NSIS    : 0x02
551
552   Specifies the class of network provider
553
554 Value   : DependOnGroup
555 Type    : REG_MULTI_SZ
556 NSIS    : PNP_TDI
557
558   Specifies the service groups upon which the AFS Client Service 
559   depends.  Windows should not attempt to start the AFS Client Service
560   until all of the services within these groups have successfully 
561   started.
562
563 Value   : DependOnService
564 Type    : REG_MULTI_SZ
565 NSIS    : Tcpip NETBIOS RpcSs
566
567   Specifies a list of services upon which the AFS Client Service 
568   depends.  Windows should not attempt to start the AFS Client Service
569   until all of the specified services have successfully started.
570   
571 Value   : Name
572 Type    : REG_SZ
573 NSIS    : "OpenAFSDaemon"
574
575   Specifies the display name of the AFS Client Service
576
577 Value   : ProviderPath
578 Type    : REG_SZ
579 NSIS    : %WINDIR%\SYSTEM32\afslogon.dll
580
581   Specifies the DLL to use for the network provider
582
583
584 2.1 Domain specific configuration keys for the Network Provider
585 ---------------------------------------------------------------
586
587 The network provider can be configured to have different behavior
588 depending on the domain that the user logs into.  These settings are
589 only relevant when using integrated login.  A domain refers to an
590 Active Directory (AD) domain, a trusted Kerberos (non-AD) realm or the
591 local machine (i.e. local account logins).  The domain name that is
592 used for selecting the domain would be the domain that is passed into
593 the NPLogonNotify function of the network provider.
594
595 Domain specific registry keys are :
596
597 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
598   (NP key)
599
600 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
601   (Domains key)
602
603 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
604   (Specific domain key. One per domain.)
605
606 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
607   (Localhost key)
608
609 eg:
610  HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider
611   |
612   +- Domain
613      +-AD1.EXAMPLE.COM
614      +-AD2.EXAMPLE.NET
615      +-LOCALHOST
616
617 Each of the domain specific keys can have the set of values described
618 in 2.1.1.  The effective values are chosen as described in 2.1.2.
619
620 2.1.1  Domain specific configuration values
621 -------------------------------------------
622 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
623 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
624 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
625 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
626
627   Value   : LogonOptions
628   Type    : DWORD
629   Default : 0x01
630   NSIS/WiX: depends on user configuration
631
632   0x00 - Integrated Logon is not used
633   0x01 - Integrated Logon is used
634   0x02 - High Security Mode is used
635   0x03 - Integrated Logon with High Security Mode is used
636
637   High Security Mode generates random SMB names for the creation of
638   Drive Mappings.  This mode should not be used without Integrated Logon.
639
640   As of 1.3.65 the SMB server supports SMB authentication.  The High
641   Security Mode should not be used when using SMB authentication
642   (SMBAuthType setting is non zero).
643
644   Value   : FailLoginsSilently
645   Type    : DWORD (1|0)
646   Default : 0
647   NSIS/WiX: (not set)
648
649      If true, does not display any visible warnings in the event of an
650      error during the integrated login process.
651
652   Value   : LogonScript
653   Type    : REG_SZ or REG_EXPAND_SZ
654   Default : (null)
655   NSIS/WiX: (only value under NP key) <install path>\afscreds.exe -:%s -x -a -m -n -q
656
657      A logon script that will be scheduled to be run after the profile
658      load is complete.  If using the REG_EXPAND_SZ type, you can use
659      any system environment variable as "%varname%" which would be
660      expanded at the time the network provider is run.  Optionally
661      using a "%s" in the value would result in it being expanded into
662      the AFS SMB username for the session.
663
664   Value   : LoginRetryInterval
665   Type    : DWORD
666   Default : 30
667   NSIS/WiX: (not set)
668
669      If the OpenAFS client service has not started yet, the network
670      provider will wait for a maximum of "LoginRetryInterval" seconds
671      while retrying every "LoginSleepInterval" seconds to check if the
672      service is up.
673
674   Value   : LoginSleepInterval
675   Type    : DWORD
676   Default : 5
677   NSIS/WiX: (not set)
678
679      See description of LoginRetryInterval.
680
681   Value   : TheseCells
682   Type    : REG_MULTI_SZ
683   NSIS    : <not set>
684
685     When Kerberos 5 is being used, TheseCells provides a list of additional
686     cells for which tokens should be obtained with the default Kerberos 5 
687     principal.
688
689
690 2.1.2  Selection of effective values for domain specific configuration
691 ----------------------------------------------------------------------
692
693   During login to domain X, where X is the domain passed into
694   NPLogonNotify as lpAuthentInfo->LogonDomainName or the string
695   'LOCALHOST' if lpAuthentInfo->LogonDomainName equals the name of the
696   computer, the following keys will be looked up.
697
698     1. NP key. ("HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider")
699     2. Domains key. (NP key\"Domain")
700     3. Specific domain key. (Domains key\X)
701
702   If the specific domain key does not exist, then the domains key will
703   be ignored.  All the configuration information in this case will
704   come from the NP key.
705
706   If the specific domain key exists, then for each of the values
707   metioned in (2), they will be looked up in the specific domain key,
708   domains key and the NP key successively until the value is found.
709   The first instance of the value found this way will be the effective
710   for the login session.  If no such instance can be found, the
711   default will be used.  To re-iterate, a value in a more specific key
712   supercedes a value in a less specific key.  The exceptions to this
713   rule are stated below.
714
715 2.1.3  Exceptions to 2.1.2
716 --------------------------
717
718   To retain backwards compatibility, the following exceptions are made
719   to 2.1.2.
720
721 2.1.3.1 'FailLoginsSilently'
722
723   Historically, the 'FailLoginsSilently' value was in
724   HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters
725   key and not in the NP key.  Therefore, for backwards compatibility,
726   the value in the Parameters key will supercede all instances of this
727   value in other keys.  In the absence of this value in the Parameters
728   key, normal scope rules apply.
729
730 2.1.3.2 'LogonScript'
731
732   If a 'LogonScript' is not specified in the specific domain key nor
733   in the domains key, the value in the NP key will only be checked if
734   the effective 'LogonOptions' specify a high security integrated
735   login.  If a logon script is specified in the specific domain key or
736   the domains key, it will be used regardless of the high security
737   setting.  Please be aware of this when setting this value.
738
739
740 3. AFS Credentials System Tray Tool parameters
741 ----------------------------------------------
742 Affects the behavior of afscreds.exe
743
744 Regkey:
745 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
746
747 Value   : Gateway
748 Type    : REG_SZ
749 Default : ""
750 Function: GetGatewayName()
751
752   If the AFS client is utilizing a gateway to obtain AFS access, 
753   the name of the gateway is specified by this value.
754
755 Value   : Cell
756 Type    : REG_SZ
757 Default : <none>
758 Variable: IsServiceConfigured()
759
760   The value Cell is used to determine if the AFS Client Service has
761   been properly configured or not.
762
763
764 Regkey:
765 [HKLM\SOFTWARE\OpenAFS\Client]
766 [HKCU\SOFTWARE\OpenAFS\Client]
767
768 Value   : ShowTrayIcon
769 Type    : DWORD {0, 1}
770 Default : 1
771 Function: InitApp(), Main_OnCheckTerminate()
772
773   This value is used to determine whether or not a shortcut should be
774   maintained in the user's Start Menu->Programs->Startup folder. 
775
776   This value used to be stored at 
777   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
778
779   The current user value is checked first; if it does not exist the local 
780   machine value is checked.
781
782
783 Value   : EnableKFW
784 Type    : DWORD {0, 1}
785 Default : 1
786 Function: KFW_is_available()
787
788   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
789   to obtain AFS credentials.  By setting this value to 0, the internal
790   Kerberos 4 implementation will be used instead.  The current user value 
791   is checked first; if it does not exist the local machine value is checked.
792
793 Value   : Use524
794 Type    : DWORD {0, 1}
795 Default : 0
796 Function: KFW_use_krb524()
797
798   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
799   to obtain AFS credentials.  By setting this value to 1, the Kerberos 5
800   tickets will be converted to Kerberos 4 tokens via a call to the krb524
801   daemon.  The current user value is checked first; if it does not exist 
802   the local machine value is checked.
803
804 Value   : AfscredsShortcutParams
805 Type    : REG_SZ
806 Default : "-A -M -N -Q"
807 Function: Shortcut_FixStartup
808
809   This value specifies the command line options which should be set
810   as part of the shortcut to afscreds.exe.  afscreds.exe rewrites the 
811   shortcut each time it exits so as to ensure that the shortcut points
812   to the latest version of the program.  This value is used to determine
813   which values should be used for command line parameters.  The current
814   user value is checked first; if it does not exist the local machine
815   value is checked.
816
817
818 Regkey:
819 [HKCU\SOFTWARE\OpenAFS\Client]
820
821 Value   : Authentication Cell
822 Type    : REG_SZ
823 Default : <none>
824 Function: Afscreds.exe GetDefaultCell()
825
826   This value allows the user to configure a different cell name to
827   be used as the default cell when acquiring tokens in afscreds.exe
828
829
830 Regkey:
831 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
832
833 Value   : "afs cell name"
834 Type    : DWORD {0, 1}
835 Default : <none>
836 Function: LoadRemind(), SaveRemind()
837
838   These values are used to save and restore the state of the reminder
839   flag for each cell for which the user has obtained tokens.
840
841   This value used to be stored at 
842   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
843
844
845 Regkey:
846 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
847
848 Value   : "upper case drive letter"
849 Type    : DWORD {0, 1}
850 Default : <none>
851
852   These values are used to store the persistence state of the AFS 
853   drive mappings as listed in the [...\Client\Mappings] key
854
855   These values used to be stored in the afsdsbmt.ini file
856
857 Regkey:
858 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
859
860 Value   : "upper case drive letter"
861 Type    : REG_SZ
862 Default : <none>
863
864   These values are used to store the AFS path in Unix notation
865   to which the drive letter is to be mapped.
866
867   These values used to be stored in the afsdsbmt.ini file.
868
869
870 ENVIRONMENT VARIABLES:
871
872 Variable: AFS_RPC_ENCRYPT 
873 Values:   "OFF" disables the use of RPC encryption
874           any other value allows RPC encryption to be used
875 Default:  RPC encryption is on
876
877
878 Variable: AFS_RPC_PROTSEQ
879 Values:   "ncalrpc"  - local RPC 
880           "ncacn_np" - named pipes
881           "ncacn_ip_tcp" - tcp/ip
882 Default:  local RPC
883