025202ca429d1550462aa9a64cb63c4242c57070
[openafs.git] / doc / man-pages / pod1 / fs_memdump.pod
1 =head1 NAME
2
3 fs_memdump - Dump AFS cache state and memory allocations [Windows only]
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs memdump> S<<< [B<-begin>|B<-end>] >>>
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 This command dumps the state of AFS cache manager objects and statistics.
18 If a checked build of the C run-time library is in use, memory allocations
19 will also be included.
20
21 =head1 CAUTIONS
22
23 This command is only available on Windows.
24
25 =head1 OPTIONS
26
27 (One of either B<-begin> or B<-end> must be specified.)
28
29 =over 4
30
31 =item B<-begin>
32
33 Set a memory checkpoint.
34
35 =item B<-end>
36
37 Create a dump-file containing information about memory allocation that has
38 taken place since the B<-begin> command was issued.
39
40 =back
41
42 =head1 OUTPUT
43
44 If successful, the output of this command (for B<-begin> I<or> B<-end>)
45 will be:
46
47    AFS memdump created
48
49 If unsuccessful:
50
51    AFS memdump failed
52
53 =head1 EXAMPLES
54
55 The following command starts a memory allocation dump:
56
57    % fs memdump -begin
58
59 The following command ends it:
60
61    % fs memdump -end
62
63 =head1 PRIVILEGE REQUIRED
64
65 The issuer must be have AFS Client Administrator access to issue this
66 command.
67
68 =head1 COPYRIGHT
69
70 This document was written by Mike Robinson, and is released under the IBM
71 Public License Version 1.0.