~ubuntu-branches/ubuntu/jaunty/db4.3/jaunty

« back to all changes in this revision

Viewing changes to debian/manpages/db4.3_stat.1

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2006-03-17 00:26:22 UTC
  • Revision ID: james.westby@ubuntu.com-20060317002622-qab26luea8sqznyb
Tags: 4.3.29-5build1
Fake sync, all of our diffs are now incorporated upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Manual Page for Berkely DB utils, created from upstream
 
2
.\" documentation by Thijs Kinkhorst <thijs@kinkhorst.com>.
 
3
.TH DB4.3_STAT 1 "28 January 2005"
 
4
.SH NAME
 
5
db4.3_stat \- Display statistics for Berkeley DB environments
 
6
.SH SYNOPSIS
 
7
.B db4.3_stat
 
8
-d file [-fN] [-h home] [-P password] [-s database]
 
9
 
 
10
.B db4.3_stat
 
11
[-cEelmNrtVZ] [-C Aclop] [-h home] [-L A] [-M A] [-R A] [-P password]
 
12
.SH DESCRIPTION
 
13
The db4.3_stat utility displays statistics for Berkeley DB environments.
 
14
.SH OPTIONS
 
15
.IP \fB\-C\fR
 
16
Display internal information about the locking subsystem.  (The output
 
17
from this option is often both voluminous and meaningless, and is
 
18
intended only for debugging.)
 
19
.RS
 
20
.IP A
 
21
Display all information.
 
22
.IP c
 
23
Display lock conflict matrix.
 
24
.IP l
 
25
Display lockers within hash chains.
 
26
.IP o
 
27
Display lock objects within hash chains.
 
28
.IP p
 
29
Display locking subsystem parameters.
 
30
.RE
 
31
.IP \fB\-c\fR
 
32
Display locking subsystem statistics, as described in DB_ENV->lock_stat.
 
33
.IP \fB\-d\fR
 
34
Display database statistics for the specified file, as described in
 
35
DB->stat.
 
36
.sp
 
37
If the database contains multiple databases and the \fB-s\fR flag is
 
38
not specified, the statistics are for the internal database that describes
 
39
the other databases the file contains, and not for the file as a whole.
 
40
.IP \fB\-E\fR
 
41
Display internal information about the database environment, including
 
42
all configured subsystems of the database environment.  (The
 
43
output from this option is often both voluminous and meaningless, and
 
44
is intended only for debugging.)
 
45
.IP \fB\-e\fR
 
46
Display information about the database environment, including
 
47
all configured subsystems of the database environment.
 
48
.IP \fB\-f\fR
 
49
Display only those database statistics that can be
 
50
acquired without traversing the database.
 
51
.IP \fB\-h\fR
 
52
Specify a home directory for the database environment; by
 
53
default, the current working directory is used.
 
54
.IP \fB\-l\fR
 
55
Display logging subsystem statistics, as described in DB_ENV->log_stat.
 
56
.IP \fB\-M\fR
 
57
Display internal information about the cache.  (The output from this
 
58
option is often both voluminous and meaningless, and is intended only
 
59
for debugging.)
 
60
.RS
 
61
.IP A
 
62
Display all information.
 
63
.IP h
 
64
Display buffers within hash chains.
 
65
.RE
 
66
.IP \fB\-m\fR
 
67
Display cache statistics, as described in DB_ENV->memp_stat.
 
68
.IP \fB\-N\fR
 
69
Do not acquire shared region mutexes while running.  Other problems,
 
70
such as potentially fatal errors in Berkeley DB, will be ignored as well.
 
71
This option is intended only for debugging errors, and should not be
 
72
used under any other circumstances.
 
73
.IP \fB\-P\fR
 
74
Specify an environment password.  Although Berkeley DB utilities overwrite
 
75
password strings as soon as possible, be aware there may be a window of
 
76
vulnerability on systems where unprivileged users can see command-line
 
77
arguments or where utilities are not able to overwrite the memory
 
78
containing the command-line arguments.
 
79
.IP \fB\-R\fR
 
80
Display internal information about the replication subsystem.  (The
 
81
output from this option is often both voluminous and meaningless, and
 
82
is intended only for debugging.)
 
83
.RS
 
84
.IP A
 
85
Display all information.
 
86
.RE
 
87
.IP \fB\-r\fR
 
88
Display replication statistics, as described in DB_ENV->rep_stat.
 
89
.IP \fB\-s\fR
 
90
Display statistics for the specified database contained in the file
 
91
specified with the \fB-d\fR flag.
 
92
.IP \fB\-t\fR
 
93
Display transaction subsystem statistics, as described in DB_ENV->txn_stat.
 
94
.IP \fB\-V\fR
 
95
Write the library version number to the standard output, and exit.
 
96
.IP \fB\-Z\fR
 
97
Reset the statistics after reporting them; valid only with the \fB-C\fR,
 
98
\fB-c\fR, \fB-E\fR, \fB-e\fR, \fB-L\fR, \fB-l\fR,
 
99
\fB-M\fR, \fB-m\fR, \fB-R\fR, \fB-r\fR, and \fB-t\fR
 
100
options.
 
101
.PP
 
102
Values normally displayed in quantities of bytes are displayed as a
 
103
combination of gigabytes (GB), megabytes (MB), kilobytes (KB), and bytes
 
104
(B).  Otherwise, values smaller than 10 million are displayed without
 
105
any special notation, and values larger than 10 million are displayed
 
106
as a number followed by "M".
 
107
.PP
 
108
The db4.3_stat utility may be used with a Berkeley DB environment (as described for the
 
109
\fB-h\fR option, the environment variable \fBDB_HOME\fR, or
 
110
because the utility was run in a directory containing a Berkeley DB
 
111
environment).  In order to avoid environment corruption when using a
 
112
Berkeley DB environment, db4.3_stat should always be given the chance to
 
113
detach from the environment and exit gracefully.  To cause db4.3_stat
 
114
to release all environment resources and exit cleanly, send it an
 
115
interrupt signal (SIGINT).
 
116
.PP
 
117
The db4.3_stat utility exits 0 on success, and >0 if an error occurs.
 
118
.SH ENVIRONMENT
 
119
.IP \fBDB_HOME\fR
 
120
If the \fB-h\fR option is not specified and the environment variable
 
121
DB_HOME is set, it is used as the path of the database home, as described
 
122
in DB_ENV->open.
 
123
.SH AUTHORS
 
124
Sleepycat Software, Inc. This manual page was created based on
 
125
the HTML documentation for db_stat from Sleepycat,
 
126
by Thijs Kinkhorst <thijs@kinkhorst.com>,
 
127
for the Debian system (but may be used by others).