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/lvmdump.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/lvmdump.8_main')
-rw-r--r-- | man/lvmdump.8_main | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/man/lvmdump.8_main b/man/lvmdump.8_main index d62c736c0..ec3dbb2ea 100644 --- a/man/lvmdump.8_main +++ b/man/lvmdump.8_main @@ -3,16 +3,16 @@ lvmdump \(em create lvm2 information dumps for diagnostic purposes .SH SYNOPSIS .B lvmdump -.RB [ \-a ] -.RB [ \-c ] -.RB [ \-d +.RB [ -a ] +.RB [ -c ] +.RB [ -d .IR directory ] -.RB [ \-h ] -.RB [ \-l ] -.RB [ \-m ] -.RB [ \-p ] -.RB [ \-s ] -.RB [ \-u ] +.RB [ -h ] +.RB [ -l ] +.RB [ -m ] +.RB [ -p ] +.RB [ -s ] +.RB [ -u ] .SH DESCRIPTION lvmdump is a tool to dump various information concerning LVM2. By default, it creates a tarball suitable for submission along @@ -34,69 +34,69 @@ The content of the tarball is as follows: .br - list of files present /sys/devices/virtual/block .br -- if enabled with \-m, metadata dump will be also included +- if enabled with -m, metadata dump will be also included .br -- if enabled with \-a, debug output of vgscan, pvscan and list of all available volume groups, physical volumes and logical volumes will be included +- if enabled with -a, debug output of vgscan, pvscan and list of all available volume groups, physical volumes and logical volumes will be included .br -- if enabled with \-c, cluster status info +- if enabled with -c, cluster status info .br -- if enabled with \-l, lvmetad state if running +- if enabled with -l, lvmetad state if running .br -- if enabled with \-p, lvmpolld state if running +- if enabled with -p, lvmpolld state if running .br -- if enabled with \-s, system info and context +- if enabled with -s, system info and context .br -- if enabled with \-u, udev info and context +- if enabled with -u, udev info and context .SH OPTIONS .TP -.B \-a +.B -a Advanced collection. \fBWARNING\fR: if lvm is already hung, then this script may hang as well -if \fB\-a\fR is used. +if \fB-a\fR is used. .TP -.B \-c +.B -c If clvmd is running, gather cluster data as well. .TP -.B \-d \fIdirectory +.B -d \fIdirectory Dump into a directory instead of tarball By default, lvmdump will produce a single compressed tarball containing all the information. Using this option, it can be instructed to only produce the raw dump tree, rooted in \fIdirectory\fP. .TP -.B \-h +.B -h Print help message .TP -.B \-l +.B -l Include \fBlvmetad\fP(8) daemon dump if it is running. The dump contains cached information that is currently stored in lvmetad: VG metadata, PV metadata and various mappings in between these metadata for quick access. .TP -.B \-m +.B -m Gather LVM metadata from the PVs This option generates a 1:1 dump of the metadata area from all PVs visible to the system, which can cause the dump to increase in size considerably. However, the metadata dump may represent a valuable diagnostic resource. .TP -.B \-p +.B -p Include \fBlvmpolld\fP(8) daemon dump if it is running. The dump contains -all in\-progress operation currently monitored by the daemon and partial +all in-progress operation currently monitored by the daemon and partial history for all yet uncollected results of polling operations already finished including reason. .TP -.B \-s +.B -s Gather system info and context. Currently, this encompasses info gathered by calling lsblk command and various systemd info and context: overall state of systemd units present in the system, more detailed status of units controlling LVM functionality and the content of systemd journal for current boot. .TP -.B \-u +.B -u Gather udev info and context: /etc/udev/udev.conf file, udev daemon version -(output of 'udevadm info \-\-version' command), udev rules currently used in the system +(output of 'udevadm info --version' command), udev rules currently used in the system (content of /lib/udev/rules.d and /etc/udev/rules.d directory), list of files in /lib/udev directory and dump of current udev -database content (the output of 'udevadm info \-\-export\-db' command). +database content (the output of 'udevadm info --export-db' command). .SH ENVIRONMENT VARIABLES .TP \fBLVM_BINARY\fP |