diff options
author | Sami Kerola <kerolasa@iki.fi> | 2012-06-10 18:20:48 +0200 |
---|---|---|
committer | Sami Kerola <kerolasa@iki.fi> | 2012-06-11 22:06:03 +0200 |
commit | 957a3eede931d864b2c8e1fff0f06fc5ece46143 (patch) | |
tree | 90010af58b98b9a044493ea50238553c12376b9a /partx | |
parent | 667d375ea8de0c47d604fff0a75c2d653a387537 (diff) | |
download | util-linux-957a3eede931d864b2c8e1fff0f06fc5ece46143.tar.gz |
docs: clean up partx.8 manual
* Remove bold & italic noise.
* Reformat text to be 70 characters wide.
* Use option and option argument highlights consistently.
* Indent option argument list for --nr.
* Squeeze examples where the same is done multiple different ways.
* Use URL and email macros where appropriate.
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
Diffstat (limited to 'partx')
-rw-r--r-- | partx/partx.8 | 231 |
1 files changed, 135 insertions, 96 deletions
diff --git a/partx/partx.8 b/partx/partx.8 index dd5ebe7b..86350c41 100644 --- a/partx/partx.8 +++ b/partx/partx.8 @@ -3,132 +3,171 @@ .\" Copyright 2007 Red Hat, Inc. .\" Copyright 2010 Davidlohr Bueso <dave@gnu.org> .\" May be distributed under the GNU General Public License -.TH PARTX 8 "February 2011" "util-linux" "System Administration" +.TH PARTX "8" "June 2012" "util-linux" "System Administration" .SH NAME -partx \- -tell the Linux kernel about the presence and numbering of on-disk partitions +partx \- tell the Linux kernel about the presence and numbering of +on-disk partitions .SH SYNOPSIS -.B partx -.RB [ \-a | \-d | \-s ] -.RB [ \-t -.IR TYPE ] -.RB [ \-n -.IR M:N ] -.RI [ \- ] -.I disk - -.B partx -.RB [ \-a | \-d | \-s ] -.RB [ \-t -.IR TYPE ] -.I partition -.RI [ disk ] - +partx [\-a|\-d|\-s] [\-t TYPE] [\-n M:N] [\-] disk +.br +partx [\-a|\-d|\-s] [\-t TYPE] partition [disk] .SH DESCRIPTION -Given a device or disk-image, \fBpartx\fP tries to parse the partition table and -list its contents. It optionally adds or removes partitions. - +Given a device or disk-image, +.B partx +tries to parse the partition table and list its contents. It +optionally adds or removes partitions. +.PP The .I disk -argument is optional when a -.I partition -argument is provided. To force scanning a partition as if it were a whole disk -(for example to list nested subpartitions), use the argument "-". For example: - -.RS -.br -.B partx \-\-show \- /dev/sda3 +argument is optional when a +.I partition +argument is provided. To force scanning a partition as if it were a +whole disk (for example to list nested subpartitions), use the argument +"-". For example: +.RS 7 +.TP +partx \-\-show \- /dev/sda3 .RE - +.PP This will see sda3 as a whole-disk rather than a partition. - -.B This is not an fdisk program -\-\- adding and removing partitions -does not change the disk, it just tells the kernel -about the presence and numbering of on-disk partitions. - +.PP +The +.B partx is not an fdisk program +\-\- adding and removing partitions does not change the disk, it just +tells the kernel about the presence and numbering of on-disk +partitions. .SH OPTIONS -.IP "\fB\-a, \-\-add\fP" +.IP "\fB\-a\fR, \fB\-\-add\fP" Add the specified partitions, or read the disk and add all partitions. -.IP "\fB\-b, \-\-bytes\fP" +.IP "\fB\-b\fR, \fB\-\-bytes\fP" Print the SIZE column in bytes rather than in human-readable format. -.IP "\fB\-d, \-\-delete\fP" +.IP "\fB\-d\fR, \fB\-\-delete\fP" Delete the specified partitions or all partitions. -.IP "\fB\-g, \-\-noheadings\fP" +.IP "\fB\-g\fR, \fB\-\-noheadings\fP" Do not print a header line. -.IP "\fB\-h, \-\-help\fP" +.IP "\fB\-h\fR, \fB\-\-help\fP" Print a help text and exit. -.IP "\fB\-l, \-\-list\fP" -List the partitions. Note that all numbers are in 512-byte sectors. This output -format is DEPRECATED in favour of \fB\-\-show\fP. Don't use it in newly written -scripts. -.IP "\fB\-o, \-\-output \fIlist\fP" -Define the output columns to use for \fB\-\-show\fP and \fB\-\-raw\fP output. -If no output arrangement is specified, then a default set is used. -Use \fB\-\-help\fP to get list of all supported columns. -.IP "\fB\-P, \-\-pairs\fP" -Use key="value" output format. -.IP "\fB\-n, \-\-nr \fIM:N\fP" -Specify the range of partitions. For backward compatibility also the format -<M-N> is supported. The range may contain negative -numbers, for example "--nr :-1" means the last partition, and "--nr -2:-1" means -the last two partitions. Supported range specifications are: -.RS +.IP "\fB\-l\fR, \fB\-\-list\fP" +List the partitions. Note that all numbers are in 512-byte sectors. +This output format is DEPRECATED in favour of +.BR \-\-show . +Do not use it in newly written scripts. +.IP "\fB\-o\fR, \fB\-\-output \fIlist\fP" +Define the output columns to use for +.B \-\-show +and +.B \-\-raw +output. If no output arrangement is specified, then a default set is +used. Use +.B \-\-help +to get +.I list +of all supported columns. This option cannot be combined with +.BR \-\-add , +.B \-\-delete +or +.B \-\-list +options. +.IP "\fB\-P\fR, \fB\-\-pairs\fP" +Output using key="value" format. +.IP "\fB\-n\fR, \fB\-\-nr \fIM:N\fP" +Specify the range of partitions. For backward compatibility also the +format +.I M-N +is supported. The range may contain negative numbers, for example +.BI \-\-nr \ :\-1 +means the last partition, and +.BI \-\-nr \ \-2:\-1 +means the last two partitions. Supported range specifications are: +.RS 14 .TP -.B <M> -Specifies just one partition (e.g. --nr 3). +.I M +Specifies just one partition (e.g. \fB\-\-nr\fR +.IR 3 ). .TP -.B <M:> -Specifies lower limit only (e.g. --nr 2:). +.I M: +Specifies lower limit only (e.g. \fB\-\-nr\fR +.IR 2: ). .TP -.B <:N> -Specifies upper limit only (e.g. --nr :4). +.I :N +Specifies upper limit only (e.g. \fB\-\-nr\fR +.IR :4 ). .TP -.B <M:N> -or -.B <M-N> -Specifies lower and upper limits (e.g. --nr 2:4). +.IR M:N \ or +.TQ +.I M-N +Specifies lower and upper limits (e.g. \fB--nr\fR +.IR 2:4 ). .RE -.IP "\fB\-r, \-\-raw\fP" +.IP "\fB\-r\fR, \fB\-\-raw\fP" Use the raw output format. -.IP "\fB\-s, \-\-show\fP" -List the partitions. All numbers (except SIZE) are in 512-byte sectors. The output -columns can be rearranged with the \fB\-\-output\fP option. -.IP "\fB\-t, \-\-type \fItype\fP" -Specify the partition table type -- aix, bsd, dos, gpt, mac, minix, sgi, solaris_x86, -sun, ultrix or unixware. -.IP "\fB\-v, \-\-verbose\fP" +.IP "\fB\-s\fR, \fB\-\-show\fP" +List the partitions. All numbers (except SIZE) are in 512-byte +sectors. The output columns can be rearranged with the +.B \-\-output +option. +.IP "\fB\-t\fR, \fB\-\-type \fItype\fP" +Specify the partition table type +.IR aix , +.IR bsd , +.IR dos , +.IR gpt , +.IR mac , +.IR minix , +.IR sgi , +.IR solaris_x86 , +.IR sun , +.I ultrix +or +.IR unixware . +.IP "\fB\-v\fR, \fB\-\-verbose\fP" Verbose mode. .SH EXAMPLES -.IP "\fBpartx \-\-show /dev/sdb3\fP" -.IP "\fBpartx \-\-show --nr 3 /dev/sdb\fP" -.IP "\fBpartx \-\-show /dev/sdb3 /dev/sdb\fP" +.TP +partx \-\-show /dev/sdb3 +.TQ +partx \-\-show --nr 3 /dev/sdb +.TQ +partx \-\-show /dev/sdb3 /dev/sdb All three commands list partition 3 of /dev/sdb. -.IP "\fBpartx \-\-show \- /dev/sdb3\fP" -Lists all subpartitions on /dev/sdb3 (the device is used as whole-disk). -.IP "\fBpartx \-o START -g --nr 3 /dev/sdb\fP" -Prints the start sector of partition 5 on /dev/sda without header. -.IP "\fBpartx \-o SECTORS,SIZE /dev/sda5 /dev/sda\fP" -Lists the length in sectors and human-readable size of partition 5 on /dev/sda. -.IP "\fBpartx \-\-add --nr 3:5 /dev/sdd\fP" +.TP +partx \-\-show \- /dev/sdb3 +Lists all subpartitions on /dev/sdb3 (the device is used as +whole-disk). +.TP +partx \-o START -g --nr 5 /dev/sdb +Prints the start sector of partition 5 on /dev/sdb without header. +.TP +partx \-o SECTORS,SIZE /dev/sda5 /dev/sda +Lists the length in sectors and human-readable size of partition 5 on +/dev/sda. +.TP +partx \-\-add --nr 3:5 /dev/sdd Adds all available partitions from 3 to 5 (inclusive) on /dev/sdd. -.IP "\fBpartx \-d --nr :-1 /dev/sdd\fP" +.TP +partx \-d --nr :-1 /dev/sdd Removes the last partition on /dev/sdd. - .SH SEE ALSO .BR addpart (8), .BR delpart (8), .BR fdisk (8), .BR parted (8), .BR partprobe (8) - .SH AUTHORS -.nf -Davidlohr Bueso <dave@gnu.org> -Karel Zak <kzak@redhat.com> -.fi - -The original version was written by Andries E. Brouwer <aeb@cwi.nl>. +.MT dave@gnu.org +Davidlohr Bueso +.ME +.br +.MT kzak@redhat.com +Karel Zak +.ME +.PP +The original version was written by +.MT aeb@cwi.nl +Andries E. Brouwer +.ME . .SH AVAILABILITY The partx command is part of the util-linux package and is available from -ftp://ftp.kernel.org/pub/linux/utils/util-linux/. +.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ +Linux Kernel Archive +.UE . |