summaryrefslogtreecommitdiff
path: root/man/pvscan.8_des
diff options
context:
space:
mode:
authorHeinz Mauelshagen <heinzm@redhat.com>2017-03-27 16:45:48 +0200
committerHeinz Mauelshagen <heinzm@redhat.com>2017-03-27 16:49:39 +0200
commit36cac41115cca875f5d120631933b5dfb3c3c524 (patch)
tree17655c869a2acd7e4c1843c1ddbe2541d03e2cd6 /man/pvscan.8_des
parent6165e092215c795eafa297268cddbd9dade3a82c (diff)
downloadlvm2-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/pvscan.8_des')
-rw-r--r--man/pvscan.8_des26
1 files changed, 13 insertions, 13 deletions
diff --git a/man/pvscan.8_des b/man/pvscan.8_des
index 14551ce75..d6b554ee2 100644
--- a/man/pvscan.8_des
+++ b/man/pvscan.8_des
@@ -20,25 +20,25 @@ commands.
When lvmetad is used, LVM commands avoid scanning disks by reading
metadata from lvmetad. When new disks appear, they must be scanned so
their metadata can be cached in lvmetad. This is done by the command
-pvscan \-\-cache, which scans disks and passes the metadata to lvmetad.
+pvscan --cache, which scans disks and passes the metadata to lvmetad.
-The pvscan \-\-cache command is typically run automatically by system
+The pvscan --cache command is typically run automatically by system
services when a new device appears. Users do not generally need to run
this command if the system and lvmetad are running properly.
Many scripts contain unnecessary pvscan (or vgscan) commands for
historical reasons. To avoid disrupting the system with extraneous disk
-scanning, an ordinary pvscan (without \-\-cache) will simply read metadata
+scanning, an ordinary pvscan (without --cache) will simply read metadata
from lvmetad like other LVM commands. It does not do anything beyond
displaying the current state of the cache.
.IP \[bu] 2
-When given specific device name arguments, pvscan \-\-cache will only
+When given specific device name arguments, pvscan --cache will only
read the named devices.
.IP \[bu] 2
LVM udev rules and systemd services are used to initiate automatic device
scanning.
.IP \[bu] 2
-To prevent devices from being scanned by pvscan \-\-cache, add them
+To prevent devices from being scanned by pvscan --cache, add them
to
.BR lvm.conf (5)
.B devices/global_filter.
@@ -46,11 +46,11 @@ The devices/filter setting does not
apply to system level scanning.
For more information, see:
.br
-.B lvmconfig \-\-withcomments devices/global_filter
+.B lvmconfig --withcomments devices/global_filter
.IP \[bu] 2
If lvmetad is started or restarted after devices are visible, or
if the global_filter has changed, then all devices must be rescanned
-for metadata with the command pvscan \-\-cache.
+for metadata with the command pvscan --cache.
.IP \[bu] 2
lvmetad does not cache older metadata formats, e.g. lvm1, and will
be temporarily disabled if they are seen.
@@ -62,9 +62,9 @@ minor numbers must be given, not the path.
When event-driven system services detect a new LVM device, the first step
is to automatically scan and cache the metadata from the device. This is
-done by pvscan \-\-cache. A second step is to automatically activate LVs
+done by pvscan --cache. A second step is to automatically activate LVs
that are present on the new device. This auto-activation is done by the
-same pvscan \-\-cache command when the option '\-a|\-\-activate ay' is
+same pvscan --cache command when the option '-a|--activate ay' is
included.
Auto-activation of VGs or LVs can be enabled/disabled using:
@@ -74,17 +74,17 @@ Auto-activation of VGs or LVs can be enabled/disabled using:
For more information, see:
.br
-.B lvmconfig \-\-withcomments activation/auto_activation_volume_list
+.B lvmconfig --withcomments activation/auto_activation_volume_list
When this setting is undefined, all LVs are auto-activated (when lvm is
fully integrated with the event-driven system services.)
When a VG or LV is not auto-activated, traditional activation using
-vgchange or lvchange -a|\-\-activate is needed.
+vgchange or lvchange -a|--activate is needed.
.IP \[bu] 2
-pvscan auto-activation can be only done in combination with \-\-cache.
+pvscan auto-activation can be only done in combination with --cache.
.IP \[bu] 2
-Auto-activation is designated by the "a" argument in '-a|\-\-activate ay'.
+Auto-activation is designated by the "a" argument in '-a|--activate ay'.
This is meant to distinguish system generated commands from explicit user
commands, although it can be used in any activation command. Whenever it
is used, the auto_activation_volume_list is applied.