shaba/lvm2
1
0
Fork 0
mirror of git://sourceware.org/git/lvm2.git synced 2024-10-27 01:55:10 +03:00
Code Releases Activity

man: blkdeactivate help output

Browse Source 
- Closer to the recommendation of man-pages and groff_man (7) if
  possible
- Sort options and crossrefs
- Relocate sub-options on the right places

Signed-off-by: Stéphane Aulery <saulery@free.fr>
This commit is contained in:
Zdenek Kabelac 2014-11-19 00:35:04 +01:00
parent 731e99025b
commit 10330b8782
1 changed files with 40 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
man/blkdeactivate.8.in
View File

@ -3,57 +3,61 @@
blkdeactivate \(em utility to deactivate block devices
.SH SYNOPSIS
.B blkdeactivate
.RI [ options ]
.RI [ device... ]
.sp
.RB [ \-d \ \fIdm_options\fP ]
.RB [ \-e ]
.RB [ \-h ]
.RB [ \-l \ \fIlvm_options\fP ]
.RB [ \-u ]
.RB [ \-v ]
.RS
.RI [ device ]
.RE
.SH DESCRIPTION
blkdeactivate utility deactivates block devices. If a device
is mounted, the utility can unmount it automatically before
trying to deactivate. The utility currently supports
\fIdevice-mapper\fP devices, including \fILVM\fP volumes.
LVM volumes are handled directly using the \fIlvm\fP command.
device-mapper devices, including LVM volumes.
LVM volumes are handled directly using the \fBlvm\fP(8) command.
Other device-mapper based devices are handled using the
\fIdmsetup\fP command.
\fBdmsetup\fP(8) command.
.SH OPTIONS
.TP
.BR \-d ", " \-\-dmoption \ \fIdm_options\fP
Comma separated list of device-mapper specific options.
Accepted \fBdmsetup\fP(8) options are:
.RS
.IP \fIretry\fP
Retry removal several times in case of failure.
.IP \fIforce\fP
Force device removal.
.RE
.TP
.BR \-e ", " \-\-errors
Show errors reported from tools called by blkdeactivate.
Without this option, any error messages from these external tools
are suppressed and the blkdeactivate itself provides only a summary
message about device being skipped or not.
Show errors reported from tools called by \fBblkdeactivate\fP. Without this
option, any error messages from these external tools are suppressed and the
\fBblkdeactivate\fP itself provides only a summary message about device being
skipped or not.
.TP
.BR \-h ", " \-\-help
Display the help text.
.TP
.BR \-l ", " \-\-lvmoption \ \fIlvm_options\fP
Comma separated list of LVM specific options:
.RS
.IP \fIretry\fP
Retry removal several times in case of failure.
.IP \fIwholevg\fP
Deactivate the whole LVM Volume Group when processing a Logical Volume.
Deactivating Volume Group as a whole takes less time than deactivating each
Logical Volume separately.
.RE
.TP
.BR \-u ", " \-\-umount
Unmount a mounted device before trying to deactivate it.
Without this option used, a device that is mounted is not deactivated.
.TP
.BR \-v ", " \-\-verbose
Run in verbose mode.
.TP
.BR \-d ", " \-\-dmoption " " \fIdm_options
Comma separated list of device-mapper specific options.
.TP
.BR \-l ", " \-\-lvmoption " " \fIlvm_options
Comma separated list of LVM specific options.
.SH DM_OPTIONS
.TP
.B retry
Retry removal several times in case of failure.
.TP
.B force
Force device removal. See \fBdmsetup\fP(8) for more information.
.SH LVM_OPTIONS
.TP
.B retry
Retry removal several times in case of failure.
.TP
.B wholevg
Deactivate the whole LVM Volume Group when processing a Logical Volume.
Deactivating Volume Group as a whole takes less time than deactivating
each Logical Volume separately.
.SH EXAMPLES
.sp
Deactivate all supported block devices found in the system. If a device
@ -83,7 +87,7 @@ of device-mapper devices in case the deactivation fails and force removal.
.B blkdeactivate \-d force,retry
.SH SEE ALSO
.BR lsblk (8)
.BR dmsetup (8),
.BR lsblk (8),
.BR lvm (8),
.BR umount (8)
.BR dmsetup (8)
.BR lvm (8)