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