Merge 1.8.0~pre4 packaging into master
[pkg-k5-afs_openafs.git] / doc / man-pages / pod1 / fs_minidump.pod
blobbf05fdde0021f2a4e595ff4c7d72b796bd4b9854
1 =head1 NAME
3 fs_minidump - Generate a minidump from the current afsd service
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<fs minidump> [B<-help>]
12 =for html
13 </div>
15 =head1 DESCRIPTION
17 B<fs minidump> generates a mini dump file containing the current stack
18 of the afsd_service.exe process.  This output can be very helpful when
19 debugging the AFS Client Service when it is unresponsive to SMB/CIFS
20 requests.
22 If the AFS Client Service becomes unresponsive to any form of
23 communication there may be a serious error that can only be diagnosed
24 by someone with access to the source code and a debugger.  The "fs
25 minidump" command can be used to force the generation of a MiniDump
26 file containing the state of all of the threads in the AFS Client
27 Service process.
29 The "MiniDumpType" registry value can be used to adjust the scope of the
30 process information included within the dump file.
32 In a standard install the default location for the dump file is %windir%\temp.
34 =head1 CAUTIONS
36 This command is only available in OpenAFS for Windows version 1.4 and later.
38 =head1 OPTIONS
40 =over 4
42 =item B<-help>
44 Prints the online help for this command. All other valid options are
45 ignored.
47 =back
49 =head1 SEE ALSO
51 L<fs(1)>
53 =head1 COPYRIGHT
55 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
57 This documentation is covered by the BSD License as written in the
58 doc/LICENSE file. This man page was written by Jason Edgecombe for
59 OpenAFS.