Import lvm2 from NetBSD
[dragonfly.git] / contrib / lvm2 / dist / man / lvmdump.8.in
1 .TH LVMDUMP 8 "LVM TOOLS #VERSION#" "Red Hat, Inc."
2 .SH NAME
3 lvmdump - create lvm2 information dumps for diagnostic purposes
4 .SH SYNOPSIS
5 \fBlvmdump\fP [options] [-d directory]
6 .SH DESCRIPTION
7 \fBlvmdump\fP is a tool to dump various information concerning LVM2. By default, it creates a tarball suitable for submission along with a problem report.
8 .PP
9 The content of the tarball is as follows:
10 .br
11 - dmsetup info
12 .br
13 - table of currently running processes
14 .br
15 - recent entries from /var/log/messages (containing system messages)
16 .br
17 - complete lvm configuration and cache
18 .br
19 - list of device nodes present under /dev
20 .br
21 - if enabled with -m, metadata dump will be also included
22 .br
23 - if enabled with -a, debug output of vgscan, pvscan and list of all available volume groups, physical volumes and logical volumes will be included
24 .br
25 - if enabled with -c, cluster status info
26 .SH OPTIONS
27 .TP
28 \fB\-h\fR \(em print help message
29 .TP
30 \fB\-a\fR \(em advanced collection 
31 \fBWARNING\fR: if lvm is already hung, then this script may hang as well if \fB\-a\fR is used
32 .TP
33 \fB\-m\fR \(em gather LVM metadata from the PVs
34 This option generates a 1:1 dump of the metadata area from all PVs visible to the system, which can cause the dump to increase in size considerably. However, the metadata dump may represent a valuable diagnostic resource.
35 .TP
36 \fB\-d\fR directory \(em dump into a directory instead of tarball
37 By default, lvmdump will produce a single compressed tarball containing all the information. Using this option, it can be instructed to only produce the raw dump tree, rooted in \fBdirectory\fP.
38 .TP
39 \fB\-c\fR \(em if clvmd is running, gather cluster data as well
40 .SH ENVIRONMENT VARIABLES
41 .TP
42 \fBLVM_BINARY\fP 
43 The LVM2 binary to use.
44 Defaults to "lvm".
45 Sometimes you might need to set this to "/sbin/lvm.static", for example.
46 .TP
47 \fBDMSETUP_BINARY\fP 
48 The dmsetup binary to use.
49 Defaults to "dmsetup".
50 .PP