btrfs-progs: Convert man page for mkfs.btrfs.
[platform/upstream/btrfs-progs.git] / man / fsck.btrfs.8.in
1 .TH fsck.btrfs 8
2 .SH NAME
3 fsck.btrfs \- do nothing, successfully
4 .SH SYNOPSIS
5 .B fsck.btrfs
6 [\fB-aApy\fP]
7 [\fBdevice...\fP]
8 .SH DESCRIPTION
9 .B fsck.btrfs
10 is a type of utility that should exist for any filesystem and is
11 called during system setup when the corresponding
12 .BR /etc/fstab
13 entries contain non-zero value for
14 .BR fs_passno
15 , see
16 .BR fstab(5)
17 for more.
18 .PP
19 Traditional filesystems need to run their respective fsck utility in case the
20 filesystem was not unmounted cleanly and the log needs to be replayed before
21 mount. This is not needed for BTRFS. You should set fs_passno to 0.
22 .PP
23 If you wish to check the consistency of a BTRFS filesystem or repair a damaged
24 filesystem, see
25 .BR btrfs(8)
26 subcommand 'check'. By default the filesystem
27 consistency is checked, the repair mode is enabled via --repair option (use
28 with care!).
29 .SH OPTIONS
30 The options detect if \fBfsck.btrfs\fP is executed in non-interactive mode and exits
31 with success, otherwise prints a message about \fBbtrfs check\fP.
32 .SH EXIT CODE
33 There are two possible exit code returned:
34 .RS
35 .IP 0 5
36 No errors
37 .IP 8 5
38 Operational error, eg. device does not exist
39 .RE
40 .
41 .SH FILES
42 .IR /etc/fstab .
43 .SH SEE ALSO
44 .BR btrfs (8),
45 .BR fsck (8),
46 .BR fstab (5),
47 .\" btrfsck is intentionally left out