[thirdparty/util-linux.git] / disk-utils / swaplabel.8

.\" Copyright 2010 Jason Borden <jborden@bluehost.com>
.\"
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH SWAPLABEL 8 "April 2010" "util-linux" "System Administration"
.SH NAME
swaplabel \- print or change the label or UUID of a swap area
.SH SYNOPSIS
.B swaplabel
.RB [ \-L
.IR label ]
.RB [ \-U
.IR UUID ]
.I device
.SH DESCRIPTION
.B swaplabel
will display or change the label or UUID of a swap partition located on
.I device
(or regular file).
.PP
If the optional arguments
.B \-L
and
.B \-U
are not given,
.B swaplabel
will simply display the current swap-area label and UUID of
.IR device .
.PP
If an optional argument is present, then
.B swaplabel
will change the appropriate value on
.IR device .
These values can also be set during swap creation using
.BR mkswap (8).
The
.B swaplabel
utility allows to change the label or UUID on an actively used swap device.
.SH OPTIONS
.TP
.BR \-h , " \-\-help"
Display help text and exit.
.TP
.BR \-L , " \-\-label " \fIlabel\fR
Specify a new \fIlabel\fR for the device.
Swap partition labels can be at most 16 characters long.  If
.I label
is longer than 16 characters,
.B swaplabel
will truncate it and print a warning message.
.TP
.BR \-U , " \-\-uuid " \fIUUID\fR
Specify a new \fIUUID\fR for the device.
The \fI UUID\fR
must be in the standard 8-4-4-4-12 character format, such as is output by
.BR uuidgen (1).
.PP
.SH ENVIRONMENT
.IP LIBBLKID_DEBUG=all
enables libblkid debug output.
.SH AUTHORS
.B swaplabel
was written by Jason Borden <jborden@bluehost.com> and Karel Zak <kzak@redhat.com>.
.SH SEE ALSO
.BR uuidgen (1),
.BR mkswap (8),
.BR swapon (8)
.SH AVAILABILITY
The swaplabel command is part of the util-linux package and is available from
https://www.kernel.org/pub/linux/utils/util-linux/.
Commit	Line	Data
	1	.\" Copyright 2010 Jason Borden <jborden@bluehost.com>
	2	.\"
	3	.\" This file may be copied under the terms of the GNU Public License.
	4	.\"
	5	.TH SWAPLABEL 8 "April 2010" "util-linux" "System Administration"
	6	.SH NAME
	7	swaplabel \- print or change the label or UUID of a swap area
	8	.SH SYNOPSIS
	9	.B swaplabel
	10	.RB [ \-L
	11	.IR label ]
	12	.RB [ \-U
	13	.IR UUID ]
	14	.I device
	15	.SH DESCRIPTION
	16	.B swaplabel
	17	will display or change the label or UUID of a swap partition located on
	18	.I device
	19	(or regular file).
	20	.PP
	21	If the optional arguments
	22	.B \-L
	23	and
	24	.B \-U
	25	are not given,
	26	.B swaplabel
	27	will simply display the current swap-area label and UUID of
	28	.IR device .
	29	.PP
	30	If an optional argument is present, then
	31	.B swaplabel
	32	will change the appropriate value on
	33	.IR device .
	34	These values can also be set during swap creation using
	35	.BR mkswap (8).
	36	The
	37	.B swaplabel
	38	utility allows to change the label or UUID on an actively used swap device.
	39	.SH OPTIONS
	40	.TP
	41	.BR \-h , " \-\-help"
	42	Display help text and exit.
	43	.TP
	44	.BR \-L , " \-\-label " \fIlabel\fR
	45	Specify a new \fIlabel\fR for the device.
	46	Swap partition labels can be at most 16 characters long. If
	47	.I label
	48	is longer than 16 characters,
	49	.B swaplabel
	50	will truncate it and print a warning message.
	51	.TP
	52	.BR \-U , " \-\-uuid " \fIUUID\fR
	53	Specify a new \fIUUID\fR for the device.
	54	The \fI UUID\fR
	55	must be in the standard 8-4-4-4-12 character format, such as is output by
	56	.BR uuidgen (1).
	57	.PP
	58	.SH ENVIRONMENT
	59	.IP LIBBLKID_DEBUG=all
	60	enables libblkid debug output.
	61	.SH AUTHORS
	62	.B swaplabel
	63	was written by Jason Borden <jborden@bluehost.com> and Karel Zak <kzak@redhat.com>.
	64	.SH SEE ALSO
	65	.BR uuidgen (1),
	66	.BR mkswap (8),
	67	.BR swapon (8)
	68	.SH AVAILABILITY
	69	The swaplabel command is part of the util-linux package and is available from
	70	https://www.kernel.org/pub/linux/utils/util-linux/.