Btrfs-progs: add missing man page for btrfs-map-logical
[platform/upstream/btrfs-progs.git] / man / btrfs-map-logical.8.in
1 .TH BTRFS-MAP-LOGICAL 8
2 .SH NAME
3 btrfs-map-logical \- map btrfs logical extent to physical extent
4 .SH SYNOPSIS
5 .B btrfs-map-logical [\fIoptions\fP] \fI<device>\fP
6 .SH DESCRIPTION
7 \fBbtrfs-map-logical\fP can be used to find out what the physical offsets are
8 on the mirrors, the result is dumped into stdout in default.
9
10 \fIOptions\fP
11 .IP "\fB-l|--logical \fI<logical_num>\fP" 5
12 Logical extent to map.
13 .IP "\fB-c|--copy \fI<copy>\fP" 5
14 Copy of the extent to read(usually 1 or 2).
15 .IP "\fB-o|--output \fI<filename>\fP" 5
16 Output file to hold the extent.
17 .IP "\fB-b|--bytes \fI<bytes>\fP" 5
18 Number of bytes to read.
19
20 .SH EXIT CODE
21 \fBbtrfs-map-logical\fP will return 0 if no error happened.
22 If any problems happened, 1 will be returned.
23
24 .SH AUTHOR
25 Written by Shilong Wang and Wenruo Qu.
26
27 .SH COPYRIGHT
28 Copyright \(co 2013 Fujitsu, Inc.
29 License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
30 .br
31 This is free software: you are free  to  change  and  redistribute  it. There is NO WARRANTY, to the extent permitted by law.
32 .SH SEE ALSO
33 .BR mkfs.btrfs (8)