tests: add description for j_recover_fast_commit
[e2fsprogs.git] / misc / e2mmpstatus.8.in
blob5f0e9dbb3dd5d2adb199afd87521a0d323c89cf2
1 .\" -*- nroff -*-
2 .\" This file may be copied under the terms of the GNU Public License.
3 .\"
4 .TH E2MMPSTATUS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
5 .SH NAME
6 e2mmpstatus \- Check MMP status of an ext4 filesystem
7 .SH SYNOPSIS
8 .BR e2mmpstatus " [" \-i ]
9 .RI < filesystem >
10 .SH OPTIONS
11 .TP
12 .B \-i
13 prints out the MMP information rather than check it.
14 .SH DESCRIPTION
15 .B e2mmpstatus
16 is used to check Multiple-Mount Protection (MMP) status of an ext4
17 filesystem with the
18 .B mmp
19 feature enabled.  The specified
20 .I filesystem
21 can be a device name (e.g.
22 .IR /dev/hdc1 ", " /dev/sdb2 ),
23 or an ext4 filesystem label or UUID, for example
24 .B UUID=8868abf6-88c5-4a83-98b8-bfc24057f7bd
26 .BR LABEL=root .
27 By default, the
28 .B e2mmpstatus
29 program checks whether it is safe to mount the filesystem without taking
30 the risk of mounting it more than once.
31 .PP
32 MMP (multiple-mount protection) is a feature that adds protection against
33 the filesystem being modified simultaneously by more than one node.
34 It is NOT safe to mount a filesystem when one of the following conditions
35 is true:
36 .br
37         1. e2fsck is running on the filesystem.
38 .br
39         2. the filesystem is in use by another node.
40 .br
41         3. The MMP block is corrupted or cannot be read for some reason.
42 .br
43 The
44 .B e2mmpstatus
45 program might wait for some time to see whether the MMP block is being
46 updated by any node during this period.  The time taken depends on how
47 frequently the MMP block is being written by the other node.
48 .SH EXIT CODE
49 The exit code returned by
50 .B e2mmpstatus
51 is 0 when it is safe to mount the filesystem, 1 when the MMP block shows
52 the filesystem is in use on another node and it is NOT safe to mount
53 the filesystem, and 2 if some other failure occurred that prevents the
54 check from properly detecting the current MMP status.
55 .SH SEE ALSO
56 .BR dumpe2fs (8),
57 .BR e2fsck (8),
58 .BR fstab (5),
59 .BR fsck (8),