diff options
author | Heinz Mauelshagen <heinzm@redhat.com> | 2017-03-27 16:45:48 +0200 |
---|---|---|
committer | Heinz Mauelshagen <heinzm@redhat.com> | 2017-03-27 16:49:39 +0200 |
commit | 36cac41115cca875f5d120631933b5dfb3c3c524 (patch) | |
tree | 17655c869a2acd7e4c1843c1ddbe2541d03e2cd6 /man/blkdeactivate.8_main | |
parent | 6165e092215c795eafa297268cddbd9dade3a82c (diff) | |
download | lvm2-36cac41115cca875f5d120631933b5dfb3c3c524.tar.gz |
man-generator/man/help: simplify hyphen escaping
Commits a29bb6a14b5e920092495fb9a1623e527d22daac
... 5c199d99f4dc9911d62673baba7643ea649ffe64
narrowed down on addressing the escaping of hyphens
in the dynamic creation of manuals whilst avoiding
them in creating help texts. This lead to a sequence
of slipping through hyphens adrressed by additional
patches in aforementioned commit series.
On the other hand, postprocessing dynamically man-generator
created and statically provided manuals catches all hyphens
in need of escaping.
Changes:
- revert the above commits whilst keeping man-generator
streamlining and the detection of any '\' when generating
help texts in order to avoid escapes to slip in
- Dynamically escape hyphens in manaual pages using sed(1)
in the respective Makefile targets
- remove any manually added escaping on hyphens from any
static manual sources or headers
Diffstat (limited to 'man/blkdeactivate.8_main')
-rw-r--r-- | man/blkdeactivate.8_main | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/man/blkdeactivate.8_main b/man/blkdeactivate.8_main index fbfd02531..9a0e84e69 100644 --- a/man/blkdeactivate.8_main +++ b/man/blkdeactivate.8_main @@ -3,27 +3,27 @@ blkdeactivate \(em utility to deactivate block devices .SH SYNOPSIS .B blkdeactivate -.RB [ \-d \ \fIdm_options\fP ] -.RB [ \-e ] -.RB [ \-h ] -.RB [ \-l \ \fIlvm_options\fP ] -.RB [ \-m \ \fImpath_options\fP ] -.RB [ \-u ] -.RB [ \-v ] +.RB [ -d \ \fIdm_options\fP ] +.RB [ -e ] +.RB [ -h ] +.RB [ -l \ \fIlvm_options\fP ] +.RB [ -m \ \fImpath_options\fP ] +.RB [ -u ] +.RB [ -v ] .RI [ device ] .SH DESCRIPTION The blkdeactivate utility deactivates block devices. For mounted block devices, it attempts to unmount it automatically before 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 -using the \fBlvm\fP(8) command, the rest of device\-mapper +using the \fBlvm\fP(8) command, the rest of device-mapper based devices are handled using the \fBdmsetup\fP(8) command. MD devices are handled using the \fBmdadm\fP(8) command. .SH OPTIONS .TP -.BR \-d ", " \-\-dmoption \ \fIdm_options\fP -Comma separated list of device\-mapper specific options. +.BR -d ", " --dmoption \ \fIdm_options\fP +Comma separated list of device-mapper specific options. Accepted \fBdmsetup\fP(8) options are: .RS .IP \fIretry\fP @@ -32,17 +32,17 @@ Retry removal several times in case of failure. Force device removal. .RE .TP -.BR \-e ", " \-\-errors +.BR -e ", " --errors 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 to indicate the device was skipped. .TP -.BR \-h ", " \-\-help +.BR -h ", " --help Display the help text. .TP -.BR \-l ", " \-\-lvmoption \ \fIlvm_options\fP -Comma\-separated list of LVM specific options: +.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. @@ -52,22 +52,22 @@ Deactivating the Volume Group as a whole is quicker than deactivating each Logical Volume separately. .RE .TP -.BR \-m ", " \-\-mpathoption \ \fImpath_options\fP -Comma\-separated list of device\-mapper multipath specific options: +.BR -m ", " --mpathoption \ \fImpath_options\fP +Comma-separated list of device-mapper multipath specific options: .RS .IP \fIdisablequeueing\fP Disable queueing on all multipath devices before deactivation. This avoids a situation where blkdeactivate may end up waiting if -all the paths are unavailable for any underlying device\-mapper multipath +all the paths are unavailable for any underlying device-mapper multipath device. .RE .TP -.BR \-u ", " \-\-umount +.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. Use \-\-vv for even more verbose mode. +.BR -v ", " --verbose +Run in verbose mode. Use --vv for even more verbose mode. .SH EXAMPLES . Deactivate all supported block devices found in the system, skipping mounted @@ -81,29 +81,29 @@ Deactivate all supported block devices found in the system, unmounting any mounted devices first, if possible. .BR # -.B blkdeactivate \-u +.B blkdeactivate -u .BR .P Deactivate the device /dev/vg/lvol0 together with all its holders, unmounting any mounted devices first, if possible. .BR # -.B blkdeactivate \-u /dev/vg/lvol0 +.B blkdeactivate -u /dev/vg/lvol0 .BR .P Deactivate all supported block devices found in the system. If the deactivation -of a device\-mapper device fails, retry it. Deactivate the whole +of a device-mapper device fails, retry it. Deactivate the whole Volume Group at once when processing an LVM Logical Volume. .BR # -.B blkdeactivate \-u \-d retry \-l wholevg +.B blkdeactivate -u -d retry -l wholevg .BR .P Deactivate all supported block devices found in the system. If the deactivation -of a device\-mapper device fails, retry it and force removal. +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 .BR dmsetup (8), |