btrfs-progs: docs: annual typo, clarity, & grammar review & fixups
[platform/upstream/btrfs-progs.git] / Documentation / btrfs-find-root.asciidoc
1 btrfs-find-root(8)
2 ==================
3
4 NAME
5 ----
6 btrfs-find-root - filter to find btrfs root
7
8 SYNOPSIS
9 --------
10 *btrfs-find-root* [options] <device>
11
12 DESCRIPTION
13 -----------
14 *btrfs-find-root* is used to find the satisfied root, you can filter by
15 root tree's objectid, generation, level.
16
17 OPTIONS
18 -------
19 -a::
20 Search through all metadata extents, even the root has been already found.
21 -g <generation>::
22 Filter root tree by it's original transaction id, tree root's generation in default.
23 -o <objectid>::
24 Filter root tree by it's objectid,tree root's objectid in default.
25 -l <level>::
26 Filter root tree by B-+ tree's level, level 0 in default.
27
28 EXIT STATUS
29 -----------
30 *btrfs-find-root* will return 0 if no error happened.
31 If any problems happened, 1 will be returned.
32
33 SEE ALSO
34 --------
35 `mkfs.btrfs`(8)