btrfs-progs/Documentation/btrfs-find-root.rst
Sidong Yang 2d039cc815 btrfs-progs: docs: add cross reference for manualpages
RST format provides cross reference function that users can navigate
manual pages click. This patch is written by macro that replaces old
references to doc role in RST format.

Issue: #495
Signed-off-by: Sidong Yang <realwakka@gmail.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2022-10-11 09:08:08 +02:00

37 lines
796 B
ReStructuredText

btrfs-find-root(8)
==================
SYNOPSIS
--------
**btrfs-find-root** [options] <device>
DESCRIPTION
-----------
**btrfs-find-root** is used to find the satisfied root, you can filter by
root tree's objectid, generation, level.
OPTIONS
-------
-a
Search through all metadata extents, even the root has been already found.
-g <generation>
Filter root tree by it's original transaction id, tree root's generation in default.
-o <objectid>
Filter root tree by it's objectid,tree root's objectid in default.
-l <level>
Filter root tree by b-tree's level, level 0 in default.
EXIT STATUS
-----------
**btrfs-find-root** will return 0 if no error happened.
If any problems happened, 1 will be returned.
SEE ALSO
--------
:doc:`mkfs.btrfs(8)<mkfs.btrfs>`