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

Update some man pages.

Browse Source
This commit is contained in:
Alasdair Kergon 2004-11-12 15:59:09 +00:00
parent b55c16aaf6
commit d6cf43252e
12 changed files with 156 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
man/lvchange.8
View File

@ -4,26 +4,34 @@ lvchange \- change attributes of a logical volume
.SH SYNOPSIS
.B lvchange
[\-\-addtag Tag]
[\-A/\-\-autobackup y/n] [\-a/\-\-available y/n]
[\-A/\-\-autobackup y/n] [\-a/\-\-available y/n/ey/en/ly/ln]
[\-\-alloc AllocationType]
[\-C/\-\-contiguous y/n] [\-d/\-\-debug] [\-\-deltag Tag]
[\-h/\-?/\-\-help]
[\-\-ignorelockingfailure]
[\-M/\-\-persistent y/n] [\-\-minor minor]
[\-P/\-\-partial y/n]
[\-p/\-\-permission r/w] [\-r/\-\-readahead ReadAheadSectors]
[\-\-refresh]
[\-t/\-\-test]
[\-v/\-\-verbose] LogicalVolumePath [LogicalVolumePath...]
.SH DESCRIPTION
lvchange allows you to change the attributes of a logical volume.
lvchange allows you to change the attributes of a logical volume
including making them known to the kernel ready for use.
.SH OPTIONS
See \fBlvm\fP for common options.
.TP
.I \-a, \-\-available y/n
.I \-a, \-\-available y/n/ey/en/ly/ln
Controls the availability of the logical volumes for use.
This is (among others) useful for changing the logical volume's name
( see
.B lvrename(8)
) safely.
Communicates with the kernel device-mapper driver via
libdevmapper to activate (-ay) or deactivate (-an) the
logical volumes.
.IP
If clustered locking is enabled, -ae will activate exclusively
on one node and -aly will activate only on the local node.
To deactivate only on the local node use -aln.
Logical volumes with single-host snapshots are always activated
exclusively because they can only be used on one node at once.
.TP
.I \-C, \-\-contiguous y/n
Tries to set or reset the contiguous allocation policy for
@ -42,11 +50,18 @@ Change access permission to read-only or read/write.
.TP
.I \-r, \-\-readahead ReadAheadSectors
Change read ahead sector count per logical between 2 and 120.
Not used by device-mapper.
For compatability with LVM1 only. Ignored by LVM2.
.TP
.I \-\-refresh
If the logical volume is active, reload its metadata.
This is not necessary in normal operation, but may be useful
if something has gone wrong or if you're doing clustering
manually without a clustered lock manager.
.SH Examples
"lvchange -p r vg00/lvol1" changes the permission on
"lvchange -pr vg00/lvol1" changes the permission on
volume lvol1 in volume group vg00 to be read-only.
.SH SEE ALSO
.BR lvm (8),
.BR lvcreate (8)
.BR lvcreate (8),
.BR vgchange (8)

5
man/lvdisplay.8
View File

@ -10,12 +10,15 @@ lvdisplay \- display attributes of a logical volume
.SH DESCRIPTION
lvdisplay allows you to see the attributes of a logical volume
like size, read/write status, snapshot information etc.
.P
\fBlvs\fP (8) is an alternative that provides the same information
in the style of \fBps\fP (1).
.SH OPTIONS
See \fBlvm\fP for common options.
.TP
.I \-c, \-\-colon
Deprecated. To be replaced with a more-powerful reporting tool.
Generate colon separated output for easier parsing in scripts or programs.
N.B. \fBlvs\fP (8) provides considerably more control over the output.
.nf
The values are:

54
man/lvm.8
View File

@ -18,23 +18,44 @@ If \fBlvm\fP is invoked with argv[0] set to the name of a specific
LVM command (for example by using a hard or soft link) it acts as
that command.
.LP
Where commands take VG or LV names as arguments, the full path name is
optional. An LV called "lvol0" in a VG called "vg0" can be specified
as "vg0/lvol0". Where a list of VGs is required but is left empty,
a list of all VGs will be substituted. Where a list of LVs is required
but a VG is given, a list of all the LVs in that VG will be substituted.
So "lvdisplay vg0" will display all the LVs in "vg0".
Tags can also be used - see \fBaddtag\fP below.
.LP
One advantage of using the built-in shell is that configuration
information is cached internally between commands.
information gets cached internally between commands.
.LP
A file containing a simple script with one command per line
can also be given on the command line. The script can also be
executed directly if the first line is #! followed by the absolute
path of \fBlvm\fP.
.SH BUILT-IN COMMANDS
The following commands are built into lvm without links normally
being created in the filesystem for them.
.TP
\fBdumpconfig\fP \(em Display the configuration information after
loading \fBlvm.conf\fP (8) and any other configuration files.
.TP
\fBformats\fP \(em Display recognised metadata formats.
.TP
\fBhelp\fP \(em Display the help text.
.TP
\fBpvdata\fP \(em Not implemented in LVM2.
.TP
\fBsegtypes\fP \(em Display recognised logical volume segment types.
.TP
\fBversion\fP \(em Display version information.
.LP
Where commands take VG or LV names as arguments, the full path name is
optional. An LV called "lvol0" in a VG called "vg0" can be specified
as "vg0/lvol0". If a list of VGs is required but is left empty, a list of
all VGs will be substituted. If a list of LVs is required
but a VG is given, a list of all the LVs in that VG will be substituted.
So "lvdisplay vg0" will display all the LVs in "vg0".
The following commands are not implemented in LVM2 but might be
in future: lvmsadc, lvmsar, pvdata, pvresize.
.SH OPTIONS
The following options are available for many of the commands and are
not documented on individual manual pages.
The following options are available for many of the commands.
They are implemented generically and documented here rather
than repeated on individual manual pages.
.TP
\fB-h | --help\fP \(em Display the help text.
.TP
@ -54,6 +75,10 @@ Overrides -d and -v.
.TP
\fB-t | --test\fP \(em Run in test mode.
Commands will not update metadata.
This is implemented by disabling all metadata writing but nevertheless
returning success to the calling function. This may lead to unusual
error messages in multi-stage operations if a tool relies on reading
back metadata it believes has changed but hasn't.
.TP
\fB--driverloaded\fP { \fBy\fP | \fBn\fP }
Whether or not the device-mapper kernel driver is loaded.
@ -131,31 +156,42 @@ All tools return a status code of zero on success or non-zero on failure.
.br
.I $HOME/.lvm_history
.SH SEE ALSO
.BR clvmd (8),
.BR lvchange (8),
.BR lvcreate (8),
.BR lvdisplay (8),
.BR lvextend (8),
.BR lvmchange (8),
.BR lvmdiskscan (8),
.BR lvreduce (8),
.BR lvremove (8),
.BR lvrename (8),
.BR lvresize (8),
.BR lvs (8),
.BR lvscan (8),
.BR pvchange (8),
.BR pvcreate (8),
.BR pvdisplay (8),
.BR pvmove (8),
.BR pvremove (8),
.BR pvs (8),
.BR pvscan (8),
.BR vgcfgbackup (8),
.BR vgchange (8),
.BR vgck (8),
.BR vgconvert (8),
.BR vgcreate (8),
.BR vgdisplay (8),
.BR vgextend (8),
.BR vgimport (8),
.BR vgmerge (8),
.BR vgmknodes (8),
.BR vgreduce (8),
.BR vgremove (8),
.BR vgrename (8),
.BR vgs (8),
.BR vgscan (8),
.BR vgsplit (8),
.BR readline (3),
.BR lvm.conf (5)

27
man/lvremove.8
View File

@ -8,17 +8,28 @@ lvremove \- remove a logical volume
[\-t/\-\-test]
[\-v/\-\-verbose] LogicalVolumePath [LogicalVolumePath...]
.SH DESCRIPTION
lvremove allows you to remove one or more inactive logical volumes.
\fBlvremove\fP removes one or more logical volumes.
Confirmation will be requested before deactivating any active logical
volume prior to removal. Logical volumes cannot be deactivated
or removed while they are open (e.g. if they contain a mounted filesystem).
.SH OPTIONS
See \fBlvm\fP for common options.
See \fBlvm\fP(8) for common options.
.TP
.I \-f, \-\-force
Force remove without confirmation.
.SH Example
"lvremove -f /dev/vg00/lvol1" removes that inactive logical volume
unconditionally.
Remove active logical volumes without confirmation.
.SH EXAMPLES
Remove the active logical volume lvol1 in volume group vg00
without asking for confirmation:
.sp
\ \fBlvremove -f vg00/lvol1\fP
.sp
Remove all logical volumes in volume group vg00:
.sp
\ \fBlvremove vg00\fP
.SH SEE ALSO
.BR lvm (8),
.BR lvcreate (8),
.BR lvdisplay (8),
.BR lvscan (8)
.BR lvm (8),
.BR lvs (8),
.BR lvscan (8),
.BR vgremove (8)

38
man/lvs.8
View File

@ -13,7 +13,7 @@ lvs \- report information about logical volumes
[\-v/\-\-verbose]
[\-\-version] [VolumeGroupName [VolumeGroupName...]]
.SH DESCRIPTION
vgs produces formatted output about volume groups
lvs produces formatted output about logical volumes.
.SH OPTIONS
See \fBlvm\fP for common options.
.TP
@ -30,16 +30,35 @@ if processing the output.
.TP
.I \-o, \-\-options
Comma-separated ordered list of columns. Precede the list with '+' to append
to the default selection of columns. Column names are:
lv_uuid, lv_name, lv_attr, lv_minor, lv_size, seg_count, origin,
snap_percent (suppressed if no kernel driver), segtype, stripes,
stripesize, chunksize, seg_start, seg_size.
to the default selection of columns instead of replacing it. Column names are:
lv_uuid, lv_name, lv_attr, lv_major, lv_minor, lv_kernel_major, lv_kernel_minor,
lv_size, seg_count, origin, snap_percent,
copy_percent, move_pv, lv_tags,
segtype, stripes,
stripesize, chunksize, seg_start, seg_size, seg_tags, devices.
.IP
With \-\-segments, any "seg_" prefixes are optional; otherwise any "lv_"
prefixes are optional. Columns mentioned in \fBvgs (8)\fP
can also be chosen
The lv_attr bits are: (o)rigin, (s)napshot, (w)riteable, (r)eadonly,
(c)ontiguous allocation, (n)ext free allocation, fixed (m)inor, (s)uspended,
(a)ctive, device (o)pen.
can also be chosen.
.IP
The lv_attr bits are:
.RS
.IP 1 3
Volume type: (m)irrored, (o)rigin, (p)vmove, (s)napshot,
invalid (S)napshot, (v)irtual
.IP 2 3
Permissions: (w)riteable, (r)ead-only
.IP 3 3
Allocation policy: (c)ontiguous, (n)ormal, (a)nywhere, (i)nherited
This is capitalised if the volume is currently locked against allocation
changes, for example during \fBpvmove\fP (8).
.IP 4 3
fixed (m)inor
.IP 5 3
State: (a)ctive, (s)uspended, (I)nvalid snapshot, invalid (S)uspended snapshot
.IP 6 3
device (o)pen
.RE
.TP
.I \-\-segments
Use default columns that emphasize segment information.
@ -60,5 +79,6 @@ All sizes are output in these units: (h)uman-readable, (s)ectors, (b)ytes,
of 1000 (S.I.) instead of 1024. Can also specify custom (u)nits e.g.
\-\-units 3M
.SH SEE ALSO
.BR lvdisplay (8),
.BR pvs (8),
.BR vgs (8)

4
man/pvdisplay.8
View File

@ -10,11 +10,15 @@ PhysicalVolumePath [PhysicalVolumePath...]
pvdisplay allows you to see the attributes of one or more physical volumes
like size, physical extent size, space used for the volume group descriptor
area and so on.
.P
\fBpvs\fP (8) is an alternative that provides the same information
in the style of \fBps\fP (1).
.SH OPTIONS
See \fBlvm\fP for common options.
.TP
.I \-c, \-\-colon
Generate colon separated output for easier parsing in scripts or programs.
N.B. \fBpvs\fP (8) provides considerably more control over the output.
.nf
The values are:

6
man/pvs.8
View File

@ -12,7 +12,7 @@ pvs \- report information about physical volumes
[\-v/\-\-verbose]
[\-\-version] [PhysicalVolume [PhysicalVolume...]]
.SH DESCRIPTION
pvs produces formatted output about physical volumes
pvs produces formatted output about physical volumes.
.SH OPTIONS
See \fBlvm\fP for common options.
.TP
@ -30,7 +30,8 @@ if processing the output.
.I \-o, \-\-options
Comma-separated ordered list of columns. Precede the list with '+' to append
to the default selection of columns. Column names are: pv_fmt, pv_uuid,
pv_size, pv_free, pv_used, pv_name, pv_attr, pv_pe_count, pv_pe_alloc_count.
pv_size, dev_size, pv_free, pv_used, pv_name, pv_attr, pv_pe_count,
pv_pe_alloc_count, pv_tags.
The "pv_" prefix is optional. Columns mentioned in \fBvgs (8)\fP can also
be chosen. The pv_attr bits are: (a)llocatable and e(x)ported.
.TP
@ -50,5 +51,6 @@ All sizes are output in these units: (h)uman-readable, (s)ectors, (b)ytes,
of 1000 (S.I.) instead of 1024. Can also specify custom (u)nits e.g.
\-\-units 3M
.SH SEE ALSO
.BR pvdisplay (8),
.BR lvs (8),
.BR vgs (8)

16
man/vgchange.8
View File

@ -6,7 +6,7 @@ vgchange \- change attributes of a volume group
.RB [\-\-addtag
.IR Tag ]
.RB [\-A | \-\-autobackup " {" y | n }]
.RB [\-a | \-\-available " {" y | n }]
.RB [\-a | \-\-available " [e|l] {" y | n }]
.RB [\-d | \-\-debug]
.RB [\-\-deltag
.IR Tag ]
@ -42,9 +42,16 @@ Controls automatic backup of metadata after the change. See
.B vgcfgbackup (8).
Default is yes.
.TP
.BR \-a ", " \-\-available { y | n }
Controls the availability of the volume group for input/output.
In other words: makes a volume group known/unknown to the kernel.
.BR \-a ", " \-\-available [e|l] { y | n }
Controls the availability of the logical volumes in the volume
group for input/output.
In other words, makes the logical volumes known/unknown to the kernel.
.IP
If clustered locking is enabled, add 'e' to activate/deactivate
exclusively on one node or 'l' to activate/deactivate only
on the local node.
Logical volumes with single-host snapshots are always activated
exclusively because they can only be used on one node at once.
.TP
.BR \-l ", " \-\-logicalvolume " " \fIMaxLogicalVolumes\fR
Changes the maximum logical volume number of an existing inactive
@ -69,5 +76,6 @@ to 128.
.fi
.SH SEE ALSO
.BR lvchange (8),
.BR lvm (8),
.BR vgcreate (8)

5
man/vgdisplay.8
View File

@ -19,6 +19,9 @@ allows you to see the attributes of
.I VolumeGroupName
(or all volume groups if none is given) with it's physical and logical
volumes and their sizes etc.
.P
\fBvgs\fP (8) is an alternative that provides the same information
in the style of \fBps\fP (1).
.SH OPTIONS
See \fBlvm\fP for common options.
.TP
@ -27,6 +30,7 @@ Only select the active volume groups.
.TP
.BR \-c ", " \-\-colon
Generate colon separated output for easier parsing in scripts or programs.
N.B. \fBvgs\fP (8) provides considerably more control over the output.
.nf
The values are:
@ -63,6 +67,7 @@ information of vgdisplay's activities.
Display version and exit successfully.
.SH SEE ALSO
.BR lvm (8),
.BR vgs (8),
.BR pvcreate (8),
.BR vgcreate (8),
.BR lvcreate (8)

7
man/vgremove.8
View File

@ -7,13 +7,12 @@ vgremove \- remove a volume group
VolumeGroupName [VolumeGroupName...]
.SH DESCRIPTION
vgremove allows you to remove one or more volume groups.
The volume group(s) must not have any logical volumes allocated
and must also be inactive (see
.B vgchange(8)
).
The volume group(s) must not have any logical volumes allocated:
Remove them first with \fBlvremove\fP.
.SH OPTIONS
See \fBlvm\fP for common options.
.SH SEE ALSO
.BR lvm (8),
.BR lvremove (8),
.BR vgcreate (8),
.BR vgreduce (8)

6
man/vgs.8
View File

@ -13,7 +13,7 @@ vgs \- report information about volume groups
[\-v/\-\-verbose]
[\-\-version] [VolumeGroupName [VolumeGroupName...]]
.SH DESCRIPTION
vgs produces formatted output about volume groups
vgs produces formatted output about volume groups.
.SH OPTIONS
See \fBlvm\fP for common options.
.TP
@ -32,7 +32,8 @@ if processing the output.
Comma-separated ordered list of columns. Precede the list with '+' to append
to the default selection of columns. Column names are: vg_fmt, vg_uuid,
vg_name, vg_attr, vg_size, vg_free, vg_sysid, vg_extent_size, vg_extent_count,
vg_free_count, max_lv, max_pv, pv_count, lv_count, snap_count, vg_seqno.
vg_free_count, max_lv, max_pv, pv_count, lv_count, snap_count, vg_seqno,
vg_tags.
Any "vg_" prefixes are optional. Columns mentioned in either \fBpvs (8)\fP
or \fBlvs (8)\fP can also be chosen, but columns cannot be taken from both
at the same time. The vg_attr bits are: (w)riteable, (r)eadonly,
@ -54,5 +55,6 @@ All sizes are output in these units: (h)uman-readable, (s)ectors, (b)ytes,
of 1000 (S.I.) instead of 1024. Can also specify custom (u)nits e.g.
\-\-units 3M
.SH SEE ALSO
.BR vgdisplay (8),
.BR pvs (8),
.BR lvs (8)

4
tools/commands.h
View File

@ -54,7 +54,7 @@ xx(lvchange,
"Change the attributes of logical volume(s)",
"lvchange\n"
"\t[-A|--autobackup y|n]\n"
"\t[-a|--available y|n]\n"
"\t[-a|--available [e|l]y|n]\n"
"\t[--addtag Tag]\n"
"\t[--alloc AllocationType]\n"
"\t[-C|--contiguous y|n]\n"
@ -564,7 +564,7 @@ xx(vgchange,
"\t[-u|--uuid] " "\n"
"\t[-v|--verbose] " "\n"
"\t[--version]" "\n"
"\t{-a|--available {y|n} |" "\n"
"\t{-a|--available [e|l]{y|n} |" "\n"
"\t -x|--resizeable {y|n} |" "\n"
"\t -l|--logicalvolume MaxLogicalVolumes |" "\n"
"\t --addtag Tag |\n"