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