multipath-tools: clean stealth whitespaces for the rest
[multipath-tools/.git] / kpartx / kpartx.8
1 .TH KPARTX 8 "July 2006" "" "Linux Administrator's Manual"
2 .SH NAME
3 kpartx \- Create device maps from partition tables
4 .SH SYNOPSIS
5 .B kpartx
6 .RB [\| \-a\ \c
7 .BR |\ -d\ |\ -l \|]
8 .RB [\| \-v \|]
9 .RB wholedisk
10 .SH DESCRIPTION
11 This tool, derived from util-linux' partx, reads partition
12 tables on specified device and create device maps over partitions
13 segments detected. It is called from hotplug upon device maps
14 creation and deletion.
15 .SH OPTIONS
16 .TP
17 .B \-a
18 Add partition mappings
19 .TP
20 .B \-r
21 Read-only partition mappings
22 .TP
23 .B \-d
24 Delete partition mappings
25 .TP
26 .B \-u
27 Update partition mappings
28 .TP
29 .B \-l
30 List partition mappings that would be added \-a
31 .TP
32 .B \-p
33 set device name-partition number delimiter
34 .TP
35 .B \-f
36 force creation of mappings; overrides 'no_partitions' feature
37 .TP
38 .B \-g
39 force GUID partition table (GPT)
40 .TP
41 .B \-v
42 Operate verbosely
43 .TP
44 .B \-s
45 Sync mode. Don't return until the partitions are created
46 .SH EXAMPLE
47 To mount all the partitions in a raw disk image:
48 .IP
49 kpartx \-av disk.img
50 .PP
51 This will output lines such as:
52 .IP
53 add map loop1p1 (254:4): 0 409597 linear 7:1 3
54 .PP
55 The
56 .I loop1p1
57 is the name of a device file under
58 .I /dev/mapper
59 which you can use to access the partition, for example to fsck it:
60 .IP
61 fsck /dev/mapper/loop1p1
62 .PP
63 When you're done, you need to remove the devices:
64 .IP
65 kpartx \-d disk.img
66 .SH "SEE ALSO"
67 .BR multipath (8)
68 .BR multipathd (8)
69 .BR hotplug (8)
70 .SH "AUTHORS"
71 This man page was assembled By Patrick Caulfield
72 for the Debian project. From documentation provided
73 by the multipath author Christophe Varoqui, <christophe.varoqui@opensvc.com> and others.