summaryrefslogtreecommitdiff
path: root/man/pvscan.8_pregen
diff options
context:
space:
mode:
Diffstat (limited to 'man/pvscan.8_pregen')
-rw-r--r--man/pvscan.8_pregen126
1 files changed, 63 insertions, 63 deletions
diff --git a/man/pvscan.8_pregen b/man/pvscan.8_pregen
index a13d1cd3d..472728c2f 100644
--- a/man/pvscan.8_pregen
+++ b/man/pvscan.8_pregen
@@ -1,6 +1,6 @@
.TH PVSCAN 8 "LVM TOOLS #VERSION#" "Red Hat, Inc."
.SH NAME
-pvscan \- List all physical volumes
+pvscan - List all physical volumes
.
.SH SYNOPSIS
\fBpvscan\fP \fIoption_args\fP
@@ -32,25 +32,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.
@@ -58,11 +58,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.
@@ -74,9 +74,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:
@@ -86,17 +86,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.
@@ -111,19 +111,19 @@ Display PV information.
.br
.RS 4
.ad l
-[ \fB-e\fP|\fB\-\-exported\fP ]
+[ \fB-e\fP|\fB--exported\fP ]
.ad b
.br
.ad l
-[ \fB-n\fP|\fB\-\-novolumegroup\fP ]
+[ \fB-n\fP|\fB--novolumegroup\fP ]
.ad b
.br
.ad l
-[ \fB-s\fP|\fB\-\-short\fP ]
+[ \fB-s\fP|\fB--short\fP ]
.ad b
.br
.ad l
-[ \fB-u\fP|\fB\-\-uuid\fP ]
+[ \fB-u\fP|\fB--uuid\fP ]
.ad b
.br
[ COMMON_OPTIONS ]
@@ -133,23 +133,23 @@ Display PV information.
Populate the lvmetad cache by scanning PVs.
.br
.P
-\fBpvscan\fP \fB\-\-cache\fP
+\fBpvscan\fP \fB--cache\fP
.br
.RS 4
.ad l
-[ \fB-b\fP|\fB\-\-background\fP ]
+[ \fB-b\fP|\fB--background\fP ]
.ad b
.br
.ad l
-[ \fB-a\fP|\fB\-\-activate\fP \fBy\fP|\fBn\fP|\fBay\fP ]
+[ \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP ]
.ad b
.br
.ad l
-[ \fB-j\fP|\fB\-\-major\fP \fINumber\fP ]
+[ \fB-j\fP|\fB--major\fP \fINumber\fP ]
.ad b
.br
.ad l
-[ \fB\-\-minor\fP \fINumber\fP ]
+[ \fB--minor\fP \fINumber\fP ]
.ad b
.br
[ COMMON_OPTIONS ]
@@ -163,11 +163,11 @@ Common options for command:
.
.RS 4
.ad l
-[ \fB\-\-ignorelockingfailure\fP ]
+[ \fB--ignorelockingfailure\fP ]
.ad b
.br
.ad l
-[ \fB\-\-reportformat\fP \fBbasic\fP|\fBjson\fP ]
+[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ]
.ad b
.RE
@@ -175,62 +175,62 @@ Common options for lvm:
.
.RS 4
.ad l
-[ \fB-d\fP|\fB\-\-debug\fP ]
+[ \fB-d\fP|\fB--debug\fP ]
.ad b
.br
.ad l
-[ \fB-h\fP|\fB\-\-help\fP ]
+[ \fB-h\fP|\fB--help\fP ]
.ad b
.br
.ad l
-[ \fB-q\fP|\fB\-\-quiet\fP ]
+[ \fB-q\fP|\fB--quiet\fP ]
.ad b
.br
.ad l
-[ \fB-t\fP|\fB\-\-test\fP ]
+[ \fB-t\fP|\fB--test\fP ]
.ad b
.br
.ad l
-[ \fB-v\fP|\fB\-\-verbose\fP ]
+[ \fB-v\fP|\fB--verbose\fP ]
.ad b
.br
.ad l
-[ \fB-y\fP|\fB\-\-yes\fP ]
+[ \fB-y\fP|\fB--yes\fP ]
.ad b
.br
.ad l
-[ \fB\-\-commandprofile\fP \fIString\fP ]
+[ \fB--commandprofile\fP \fIString\fP ]
.ad b
.br
.ad l
-[ \fB\-\-config\fP \fIString\fP ]
+[ \fB--config\fP \fIString\fP ]
.ad b
.br
.ad l
-[ \fB\-\-driverloaded\fP \fBy\fP|\fBn\fP ]
+[ \fB--driverloaded\fP \fBy\fP|\fBn\fP ]
.ad b
.br
.ad l
-[ \fB\-\-longhelp\fP ]
+[ \fB--longhelp\fP ]
.ad b
.br
.ad l
-[ \fB\-\-profile\fP \fIString\fP ]
+[ \fB--profile\fP \fIString\fP ]
.ad b
.br
.ad l
-[ \fB\-\-version\fP ]
+[ \fB--version\fP ]
.ad b
.RE
.SH OPTIONS
.HP
.ad l
-\fB-a\fP|\fB\-\-activate\fP \fBy\fP|\fBn\fP|\fBay\fP
+\fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP
.br
.ad b
.HP
.ad l
-\fB-b\fP|\fB\-\-background\fP
+\fB-b\fP|\fB--background\fP
.br
If the operation requires polling, this option causes the command to
return before the operation is complete, and polling is done in the
@@ -238,20 +238,20 @@ background.
.ad b
.HP
.ad l
-\fB\-\-cache\fP
+\fB--cache\fP
.br
Scan one or more devices and send the metadata to lvmetad.
.ad b
.HP
.ad l
-\fB\-\-commandprofile\fP \fIString\fP
+\fB--commandprofile\fP \fIString\fP
.br
The command profile to use for command configuration.
See \fBlvm.conf\fP(5) for more information about profiles.
.ad b
.HP
.ad l
-\fB\-\-config\fP \fIString\fP
+\fB--config\fP \fIString\fP
.br
Config settings for the command. These override lvm.conf settings.
The String arg uses the same format as lvm.conf,
@@ -260,78 +260,78 @@ See \fBlvm.conf\fP(5) for more information about config.
.ad b
.HP
.ad l
-\fB-d\fP|\fB\-\-debug\fP ...
+\fB-d\fP|\fB--debug\fP ...
.br
Set debug level. Repeat from 1 to 6 times to increase the detail of
messages sent to the log file and/or syslog (if configured).
.ad b
.HP
.ad l
-\fB\-\-driverloaded\fP \fBy\fP|\fBn\fP
+\fB--driverloaded\fP \fBy\fP|\fBn\fP
.br
If set to no, the command will not attempt to use device-mapper.
For testing and debugging.
.ad b
.HP
.ad l
-\fB-e\fP|\fB\-\-exported\fP
+\fB-e\fP|\fB--exported\fP
.br
Only show PVs belonging to exported VGs.
.ad b
.HP
.ad l
-\fB-h\fP|\fB\-\-help\fP
+\fB-h\fP|\fB--help\fP
.br
Display help text.
.ad b
.HP
.ad l
-\fB\-\-ignorelockingfailure\fP
+\fB--ignorelockingfailure\fP
.br
Allows a command to continue with read-only metadata
operations after locking failures.
.ad b
.HP
.ad l
-\fB\-\-longhelp\fP
+\fB--longhelp\fP
.br
Display long help text.
.ad b
.HP
.ad l
-\fB-j\fP|\fB\-\-major\fP \fINumber\fP
+\fB-j\fP|\fB--major\fP \fINumber\fP
.br
The major number of a device.
.ad b
.HP
.ad l
-\fB\-\-minor\fP \fINumber\fP
+\fB--minor\fP \fINumber\fP
.br
The minor number of a device.
.ad b
.HP
.ad l
-\fB-n\fP|\fB\-\-novolumegroup\fP
+\fB-n\fP|\fB--novolumegroup\fP
.br
Only show PVs not belonging to any VG.
.ad b
.HP
.ad l
-\fB\-\-profile\fP \fIString\fP
+\fB--profile\fP \fIString\fP
.br
-An alias for \-\-commandprofile or \-\-metadataprofile, depending
+An alias for --commandprofile or --metadataprofile, depending
on the command.
.ad b
.HP
.ad l
-\fB-q\fP|\fB\-\-quiet\fP ...
+\fB-q\fP|\fB--quiet\fP ...
.br
-Suppress output and log messages. Overrides \-\-debug and \-\-verbose.
+Suppress output and log messages. Overrides --debug and --verbose.
Repeat once to also suppress any prompts with answer no.
.ad b
.HP
.ad l
-\fB\-\-reportformat\fP \fBbasic\fP|\fBjson\fP
+\fB--reportformat\fP \fBbasic\fP|\fBjson\fP
.br
Overrides current output format for reports which is defined globally by
the report/output_format setting in lvm.conf.
@@ -342,13 +342,13 @@ output in JSON format. See \fBlvmreport\fP(7) for more information.
.ad b
.HP
.ad l
-\fB-s\fP|\fB\-\-short\fP
+\fB-s\fP|\fB--short\fP
.br
Short listing format.
.ad b
.HP
.ad l
-\fB-t\fP|\fB\-\-test\fP
+\fB-t\fP|\fB--test\fP
.br
Run in test mode. Commands will not update metadata.
This is implemented by disabling all metadata writing but nevertheless
@@ -358,26 +358,26 @@ back metadata it believes has changed but hasn't.
.ad b
.HP
.ad l
-\fB-u\fP|\fB\-\-uuid\fP
+\fB-u\fP|\fB--uuid\fP
.br
Show UUIDs in addition to device names.
.ad b
.HP
.ad l
-\fB-v\fP|\fB\-\-verbose\fP ...
+\fB-v\fP|\fB--verbose\fP ...
.br
Set verbose level. Repeat from 1 to 4 times to increase the detail
of messages sent to stdout and stderr.
.ad b
.HP
.ad l
-\fB\-\-version\fP
+\fB--version\fP
.br
Display version information.
.ad b
.HP
.ad l
-\fB-y\fP|\fB\-\-yes\fP
+\fB-y\fP|\fB--yes\fP
.br
Do not prompt for confirmation interactively but always assume the
answer yes. Use with extreme caution.
@@ -409,7 +409,7 @@ UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP.
b|B is bytes, s|S is sectors of 512 bytes, k|K is kilobytes,
m|M is megabytes, g|G is gigabytes, t|T is terabytes,
p|P is petabytes, e|E is exabytes.
-(This should not be confused with the output control \-\-units, where
+(This should not be confused with the output control --units, where
capital letters mean multiple of 1000.)
.SH ENVIRONMENT VARIABLES
See \fBlvm\fP(8) for information about environment variables used by lvm.