]> git.ipfire.org Git - thirdparty/util-linux.git/blob - disk-utils/partx.8
Manual pages: Standardize on EXAMPLE as section title
[thirdparty/util-linux.git] / disk-utils / partx.8
1 .\" partx.8 -- man page for partx
2 .\" Copyright 2007 Karel Zak <kzak@redhat.com>
3 .\" Copyright 2007 Red Hat, Inc.
4 .\" Copyright 2010 Davidlohr Bueso <dave@gnu.org>
5 .\" May be distributed under the GNU General Public License
6 .\"
7 .TH PARTX "8" "December 2014" "util-linux" "System Administration"
8 .SH NAME
9 partx \- tell the kernel about the presence and numbering of on-disk partitions
10 .SH SYNOPSIS
11 .B partx
12 .RB [ \-a | \-d | \-P | \-r | \-s | \-u ]
13 .RB [ \-t " \fItype\fR]"
14 .RB [ \-n " \fIM" : \fIN\fR]
15 .RB [ \- "] " \fIdisk
16 .br
17 .B partx
18 .RB [ \-a | \-d | \-P | \-r | \-s | \-u ]
19 .RB [ \-t " \fItype\fR]"
20 .IR partition " [" disk ]
21 .SH DESCRIPTION
22 Given a device or disk-image,
23 .B partx
24 tries to parse the partition table and list its contents. It
25 can also tell the kernel to add or remove partitions from its
26 bookkeeping.
27 .PP
28 The
29 .I disk
30 argument is optional when a
31 .I partition
32 argument is provided. To force scanning a partition as if it were a whole disk
33 (for example to list nested subpartitions), use the argument "\-" (hyphen-minus).
34 For example:
35
36 .RS 7
37 .TP
38 partx \-\-show \- /dev/sda3
39 .RE
40 .PP
41 This will see sda3 as a whole-disk rather than as a partition.
42 .PP
43 .B partx is not an fdisk program
44 \(en adding and removing partitions does not change the disk, it just
45 tells the kernel about the presence and numbering of on-disk
46 partitions.
47 .SH OPTIONS
48 .TP
49 .BR \-a , " \-\-add"
50 Add the specified partitions, or read the disk and add all partitions.
51 .TP
52 .BR \-b , " \-\-bytes"
53 Print the SIZE column in bytes rather than in human-readable format.
54 .TP
55 .BR \-d , " \-\-delete"
56 Delete the specified partitions or all partitions. It is not error to
57 remove non-existing partitions, so this option is possible to use together with
58 large \fB\-\-nr\fR ranges without care about the current partitions set on
59 the device.
60 .TP
61 .BR \-g , " \-\-noheadings"
62 Do not print a header line with \fB\-\-show\fR or \fB\-\-raw\fR.
63 .TP
64 .BR \-l , " \-\-list"
65 List the partitions. Note that all numbers are in 512-byte sectors.
66 This output format is DEPRECATED in favour of
67 .BR \-\-show .
68 Do not use it in newly written scripts.
69 .TP
70 .BR \-n , " \-\-nr " \fIM : \fIN
71 Specify the range of partitions. For backward compatibility also the
72 format \fIM\fB\-\fIN\fR is supported.
73 The range may contain negative numbers, for example
74 .B \-\-nr \-1:\-1
75 means the last partition, and
76 .B \-\-nr \-2:\-1
77 means the last two partitions. Supported range specifications are:
78 .RS 14
79 .TP
80 .I M
81 Specifies just one partition (e.g.\& \fB\-\-nr 3\fR).
82 .TP
83 .IB M :
84 Specifies the lower limit only (e.g.\& \fB\-\-nr 2:\fR).
85 .TP
86 .BI : N
87 Specifies the upper limit only (e.g.\& \fB\-\-nr :4\fR).
88 .TP
89 .IB M : N
90 Specifies the lower and upper limits (e.g.\& \fB\-\-nr 2:4\fR).
91 .RE
92 .TP
93 .BR \-o , " \-\-output " \fIlist
94 Define the output columns to use for
95 .BR \-\-show ,
96 .B \-\-pairs
97 and
98 .B \-\-raw
99 output. If no output arrangement is specified, then a default set is
100 used. Use
101 .B \-\-help
102 to get
103 .I list
104 of all supported columns. This option cannot be combined with the
105 .BR \-\-add ,
106 .BR \-\-delete ,
107 .B \-\-update
108 or
109 .B \-\-list
110 options.
111 .TP
112 .B \-\-output\-all
113 Output all available columns.
114 .TP
115 .BR \-P , " \-\-pairs"
116 List the partitions using the KEY="value" format.
117 .TP
118 .BR \-r , " \-\-raw"
119 List the partitions using the raw output format.
120 .TP
121 .BR \-s , " \-\-show"
122 List the partitions.
123 The output columns can be selected and rearranged with the
124 \fB\-\-output\fR option.
125 All numbers (except SIZE) are in 512-byte sectors.
126 .TP
127 .BR \-t , " \-\-type " \fItype
128 Specify the partition table type.
129 .TP
130 .B \-\-list\-types
131 List supported partition types and exit.
132 .TP
133 .BR \-u , " \-\-update"
134 Update the specified partitions.
135 .TP
136 .BR \-S , " \-\-sector\-size " \fIsize
137 Overwrite default sector size.
138 .TP
139 .BR \-v , " \-\-verbose"
140 Verbose mode.
141 .TP
142 .BR \-V , " \-\-version"
143 Display version information and exit.
144 .TP
145 .BR \-h , " \-\-help"
146 Display help text and exit.
147 .SH EXAMPLE
148 .TP
149 partx \-\-show /dev/sdb3
150 .TQ
151 partx \-\-show \-\-nr 3 /dev/sdb
152 .TQ
153 partx \-\-show /dev/sdb3 /dev/sdb
154 All three commands list partition 3 of /dev/sdb.
155 .TP
156 partx \-\-show \- /dev/sdb3
157 Lists all subpartitions on /dev/sdb3 (the device is used as
158 whole-disk).
159 .TP
160 partx \-o START \-g \-\-nr 5 /dev/sdb
161 Prints the start sector of partition 5 on /dev/sdb without header.
162 .TP
163 partx \-o SECTORS,SIZE /dev/sda5 /dev/sda
164 Lists the length in sectors and human-readable size of partition 5 on
165 /dev/sda.
166 .TP
167 partx \-\-add \-\-nr 3:5 /dev/sdd
168 Adds all available partitions from 3 to 5 (inclusive) on /dev/sdd.
169 .TP
170 partx \-d \-\-nr :\-1 /dev/sdd
171 Removes the last partition on /dev/sdd.
172 .SH SEE ALSO
173 .BR addpart (8),
174 .BR delpart (8),
175 .BR fdisk (8),
176 .BR parted (8),
177 .BR partprobe (8)
178 .SH AUTHORS
179 .MT dave@gnu.org
180 Davidlohr Bueso
181 .ME
182 .br
183 .MT kzak@redhat.com
184 Karel Zak
185 .ME
186 .PP
187 The original version was written by
188 .MT aeb@cwi.nl
189 Andries E.\& Brouwer
190 .ME .
191 .SH ENVIRONMENT
192 .IP LIBBLKID_DEBUG=all
193 enables libblkid debug output.
194 .SH AVAILABILITY
195 The partx command is part of the util-linux package and is available from
196 .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
197 Linux Kernel Archive
198 .UE .