1
0
mirror of git://sourceware.org/git/lvm2.git synced 2025-01-03 05:18:29 +03:00

man: Adjust some wording and update examples style.

This commit is contained in:
Alasdair G Kergon 2017-03-14 14:55:36 +00:00
parent ca905681cc
commit c891918174

View File

@ -12,8 +12,8 @@ blkdeactivate \(em utility to deactivate block devices
.RB [ \-v ] .RB [ \-v ]
.RI [ device ] .RI [ device ]
.SH DESCRIPTION .SH DESCRIPTION
blkdeactivate utility deactivates block devices. If a device The blkdeactivate utility deactivates block devices. For mounted
is mounted, the utility can unmount it automatically before block devices, it attempts to unmount it automatically before
trying to deactivate. The utility currently supports trying to deactivate. The utility currently supports
device-mapper devices (DM), including LVM volumes and device-mapper devices (DM), including LVM volumes and
software RAID MD devices. LVM volumes are handled directly software RAID MD devices. LVM volumes are handled directly
@ -35,30 +35,30 @@ Force device removal.
.BR \-e ", " \-\-errors .BR \-e ", " \-\-errors
Show errors reported from tools called by \fBblkdeactivate\fP. Without this Show errors reported from tools called by \fBblkdeactivate\fP. Without this
option, any error messages from these external tools are suppressed and the option, any error messages from these external tools are suppressed and the
\fBblkdeactivate\fP itself provides only a summary message about device being \fBblkdeactivate\fP itself provides only a summary message to indicate
skipped or not. the device was skipped.
.TP .TP
.BR \-h ", " \-\-help .BR \-h ", " \-\-help
Display the help text. Display the help text.
.TP .TP
.BR \-l ", " \-\-lvmoption \ \fIlvm_options\fP .BR \-l ", " \-\-lvmoption \ \fIlvm_options\fP
Comma separated list of LVM specific options: Comma-separated list of LVM specific options:
.RS .RS
.IP \fIretry\fP .IP \fIretry\fP
Retry removal several times in case of failure. Retry removal several times in case of failure.
.IP \fIwholevg\fP .IP \fIwholevg\fP
Deactivate the whole LVM Volume Group when processing a Logical Volume. Deactivate the whole LVM Volume Group when processing a Logical Volume.
Deactivating Volume Group as a whole takes less time than deactivating each Deactivating the Volume Group as a whole is quicker than deactivating
Logical Volume separately. each Logical Volume separately.
.RE .RE
.TP .TP
.BR \-m ", " \-\-mpathoption \ \fImpath_options\fP .BR \-m ", " \-\-mpathoption \ \fImpath_options\fP
Comma separated list of device-mapper multipath specific options: Comma-separated list of device-mapper multipath specific options:
.RS .RS
.IP \fIdisablequeueing\fP .IP \fIdisablequeueing\fP
Disable queueing on all multipath devices first before deactivation. Disable queueing on all multipath devices before deactivation.
This avoids a situation where blkdeactivate may end up waiting if This avoids a situation where blkdeactivate may end up waiting if
all paths are unavailable for any underlying device-mapper multipath all the paths are unavailable for any underlying device-mapper multipath
device. device.
.RE .RE
.TP .TP
@ -69,33 +69,42 @@ Without this option used, a device that is mounted is not deactivated.
.BR \-v ", " \-\-verbose .BR \-v ", " \-\-verbose
Run in verbose mode. Use \-\-vv for even more verbose mode. Run in verbose mode. Use \-\-vv for even more verbose mode.
.SH EXAMPLES .SH EXAMPLES
.sp .
Deactivate all supported block devices found in the system. If a device Deactivate all supported block devices found in the system, skipping mounted
is mounted, skip its deactivation. devices.
.sp .BR
#
.B blkdeactivate .B blkdeactivate
.BR
Deactivate all supported block devices found in the system. If a device .P
is mounted, unmount it first if possible. Deactivate all supported block devices found in the system, unmounting any
.sp mounted devices first, if possible.
.BR
#
.B blkdeactivate \-u .B blkdeactivate \-u
.BR
Deactivate supplied device together with all its holders. If any of the .P
devices processed is mounted, unmount it first if possible. Deactivate the device /dev/vg/lvol0 together with all its holders, unmounting
.sp any mounted devices first, if possible.
.BR
#
.B blkdeactivate \-u /dev/vg/lvol0 .B blkdeactivate \-u /dev/vg/lvol0
.BR
Deactivate all supported block devices found in the system. Retry deactivation .P
of device-mapper devices in case the deactivation fails. Deactivate the whole Deactivate all supported block devices found in the system. If the deactivation
of a device-mapper device fails, retry it. Deactivate the whole
Volume Group at once when processing an LVM Logical Volume. Volume Group at once when processing an LVM Logical Volume.
.sp .BR
#
.B blkdeactivate \-u \-d retry \-l wholevg .B blkdeactivate \-u \-d retry \-l wholevg
.BR
Deactivate all supported block devices found in the system. Retry deactivation .P
of device-mapper devices in case the deactivation fails and force removal. Deactivate all supported block devices found in the system. If the deactivation
.sp of a device-mapper device fails, retry it and force removal.
.BR
#
.B blkdeactivate \-d force,retry .B blkdeactivate \-d force,retry
.
.SH SEE ALSO .SH SEE ALSO
.BR dmsetup (8), .BR dmsetup (8),
.BR lsblk (8), .BR lsblk (8),