multipath.rules: find_multipaths "smart" logic
[multipath-tools/.git] / kpartx / kpartx.8
1 .\" ----------------------------------------------------------------------------
2 .\" Update the date below if you make any significant change.
3 .\" Make sure there are no errors with:
4 .\" groff -z -wall -b -e -t kpartx/kpartx.8
5 .\"
6 .\" ----------------------------------------------------------------------------
7 .
8 .TH KPARTX 8 2016-10-28 "Linux"
9 .
10 .
11 .\" ----------------------------------------------------------------------------
12 .SH NAME
13 .\" ----------------------------------------------------------------------------
14 .
15 kpartx \- Create device maps from partition tables.
16 .
17 .
18 .\" ----------------------------------------------------------------------------
19 .SH SYNOPSIS
20 .\" ----------------------------------------------------------------------------
21 .
22 .B kpartx
23 .RB [\| \-a | \-d | \-u | \-l \|]
24 .RB [\| \-r \|]
25 .RB [\| \-p \|]
26 .RB [\| \-f \|]
27 .RB [\| \-g \|]
28 .RB [\| \-s \|]
29 .RB [\| \-v \|]
30 .B wholedisk
31 .
32 .
33 .\" ----------------------------------------------------------------------------
34 .SH DESCRIPTION
35 .\" ----------------------------------------------------------------------------
36 .
37 This tool, derived from util-linux' partx, reads partition tables on specified
38 device and create device maps over partitions segments detected. It is called
39 from hotplug upon device maps creation and deletion.
40 .
41 .
42 .\" ----------------------------------------------------------------------------
43 .SH OPTIONS
44 .\" ----------------------------------------------------------------------------
45 .
46 .TP
47 .B \-a
48 Add partition mappings.
49 .
50 .TP
51 .B \-d
52 Delete partition mappings.
53 .
54 .TP
55 .B \-u
56 Update partition mappings.
57 .
58 .TP
59 .B \-l
60 List partition mappings that would be added \-a.
61 .
62 .TP
63 .B \-r
64 Read-only partition mappings.
65 .
66 .TP
67 .B \-p
68 Set device name-partition number delimiter.
69 .
70 .TP
71 .B \-f
72 Force creation of mappings; overrides 'no_partitions' feature.
73 .
74 .TP
75 .B \-g
76 Force GUID partition table (GPT).
77 .
78 .TP
79 .B \-s
80 Sync mode. Don't return until the partitions are created.
81 .
82 .TP
83 .B \-v
84 Operate verbosely.
85 .
86 .
87 .\" ----------------------------------------------------------------------------
88 .SH EXAMPLE
89 .\" ----------------------------------------------------------------------------
90 .
91 To mount all the partitions in a raw disk image:
92 .IP
93 kpartx \-av disk.img
94 .PP
95 This will output lines such as:
96 .IP
97 add map loop1p1 (254:4): 0 409597 linear 7:1 3
98 .PP
99 The \fIloop1p1\fR is the name of a device file under \fI/dev/mapper\fR which you
100 can use to access the partition, for example to fsck it:
101 .IP
102 fsck /dev/mapper/loop1p1
103 .PP
104 When you're done, you need to remove the devices:
105 .IP
106 kpartx \-d disk.img
107 .
108 .
109 .\" ----------------------------------------------------------------------------
110 .SH "SEE ALSO"
111 .\" ----------------------------------------------------------------------------
112 .
113 .BR multipath (8)
114 .BR multipathd (8)
115 .BR hotplug (8)
116 .
117 .
118 .\" ----------------------------------------------------------------------------
119 .SH AUTHORS
120 .\" ----------------------------------------------------------------------------
121 .
122 This man page was assembled By Patrick Caulfield for the Debian project.
123 .PP
124 \fImultipath-tools\fR was developed by Christophe Varoqui <christophe.varoqui@opensvc.com>
125 and others.
126 .\" EOF