1
0
mirror of git://sourceware.org/git/lvm2.git synced 2025-12-03 16:23:49 +03:00
Files
lvm2/man/lvs.8_end
Zdenek Kabelac c1bfc8737f man: updates and typography
Manually enhance pages for thin, cache, raid, vdo.

Replace usage of .HP with .TP when it makes sense (but keep .HP
where so far we don't have replacement giving same visual results).

Use .CMS, .CME  macros in dmsetup/dmstats so it easy to switch
But keep using .HP when the rendering looks simply better in terminal
although HTML output does not looks that well - so we may eventually
switch here to .TP.

For basic command synopsis use .NSY macro that will
use .SY for graphical rendering (postscript/pdf) but keep
using .TP for ASCII terminal output, as here many HTML renderers
are emitting unreadable pages.

For options use '\ ' (non-breakable space) between option and
its argument and option are not across line.

Reformat lines to fit in 80 columns.

Use  .EX .. .EE  for example output - this improves
character alignment for poststrict/pdf rendering as
it use monospace fonts (unlike .nf .. .fi).
Also with Example section never let the line being with space
and use '\' for such line.
If the Example line should being with '.' it needs to be
prefix with \&.
Add .nf/.fi macros for cases where .EX & .EE are undefined
(this happens i.e. with man2html)

Avoid use of tables (.TS .. .TE) as HTML renderers often use
images (.png) files for such tables and this does not scale well
when user changes font size in browser.
(and the large/long table were split into 2 pieces
so it does fit to 80 columns).

Use .MT .ME for emails.

Use .UR .UE. for URL.

Use  .\|.\|.\& as sequence of 3 dots and add \& to not create end of
sentence and possibly wrong alignment.

On lines starting with .BR & .IR avoid using \fB \fI as this
can cause problem when i.e. html rendered may keep use
italic bold when just italic was really wanted.

When using series of .TP/.IP - set the size only with the
first tag - and let renderer align others to match the column.

Correct some small typographical rendering issues.

Rendering was evaluated for readable results with:
- mandoc -T html  (-O style=mandoc.css)
- groff  -Thtml -mman
- man2html
- man -Thtml
- man -Tps
- man

Unfortunatelly various g/troff troubles are with each of them,
so we need to select usage of macros in a way, that is not mangling
results for above engines.
2025-04-28 14:19:18 +02:00

112 lines
4.2 KiB
Plaintext

.
.SH NOTES
.
The lv_attr bits are:
.
.IP 1 3
Volume type: (\fBC\fP)ache, (\fBm\fP)irrored,
(\fBM\fP)irrored without initial sync,
(\fBo\fP)rigin, (\fBO\fP)rigin with merging snapshot, inte(\fBg\fP)rity,
(\fBr\fP)aid, (\fBR\fP)aid without initial sync, (\fBs\fP)napshot,
merging (\fBS\fP)napshot, (\fBp\fP)vmove, (\fBv\fP)irtual,
mirror or raid (\fBi\fP)mage, mirror or raid (\fBI\fP)mage out-of-sync,
mirror (\fBl\fP)og device, under (\fBc\fP)onversion, thin (\fBV\fP)olume,
(\fBt\fP)hin pool, (\fBT\fP)hin pool data,
v(\fBd\fP)o pool, v(\fBD\fP)o pool data,
raid or pool m(\fBe\fP)tadata or pool metadata spare.
.
.IP 2
Permissions: (\fBw\fP)riteable, (\fBr\fP)ead-only, (\fBR\fP)ead-only activation
of non-read-only volume
.
.IP 3
Allocation policy: (\fBa\fP)nywhere, (\fBc\fP)ontiguous, (\fBi\fP)nherited,
c(\fBl\fP)ing, (\fBn\fP)ormal
This is capitalised if the volume is currently locked against allocation
changes, for example during
.BR pvmove (8).
.
.IP 4
fixed (\fBm\fP)inor
.
.IP 5
State: (\fBa\fP)ctive, (\fBh\fP)istorical, (\fBs\fP)uspended,
(\fBI\fP)nvalid snapshot, invalid (\fBS\fP)uspended snapshot,
snapshot (\fBm\fP)erge failed, suspended snapshot (\fBM\fP)erge failed,
mapped (\fBd\fP)evice present without tables,
mapped device present with (\fBi\fP)nactive table,
thin-pool (\fBc\fP)heck needed,
suspended thin-pool (\fBC\fP)heck needed, (\fBX\fP) unknown
.
.IP 6
device (\fBo\fP)pen, (\fBX\fP) unknown
.
.IP 7
Target type: (\fBC\fP)ache, (\fBm\fP)irror, (\fBr\fP)aid,
(\fBs\fP)napshot, (\fBt\fP)hin, (\fBu\fP)nknown, (\fBv\fP)irtual.
This groups logical volumes related to the same kernel target together. So,
for example, mirror images, mirror logs as well as mirrors themselves appear as
(\fBm\fP) if they use the original device-mapper mirror kernel driver;
whereas the raid equivalents using the md raid kernel driver
all appear as (\fBr\fP).
Snapshots using the original device-mapper driver appear as (\fBs\fP);
whereas snapshots of thin volumes using the new thin provisioning
driver appear as (\fBt\fP).
.
.IP 8
Newly-allocated data blocks are overwritten with blocks
of (\fBz\fP)eroes before use.
.
.IP 9
Volume Health, where there are currently three groups of attributes identified:
.
.IP
Common ones for all Logical Volumes: (\fBp\fP)artial, (\fBX\fP) unknown.
.br
(\fBp\fP)artial signifies that one or more of the Physical Volumes this Logical
Volume uses is missing from the system. (\fBX\fP) unknown signifies the status
is unknown.
.
.IP
Related to RAID Logical Volumes: (\fBr\fP)efresh needed,
(\fBm\fP)ismatches exist, (\fBw\fP)ritemostly.
.br
(\fBr\fP)efresh signifies that one or more of the Physical Volumes
this RAID Logical Volume uses had suffered a write error.
The write error could be due to a temporary failure of that Physical Volume
or an indication that it is failing.
The device should be refreshed or replaced. (\fBm\fP)ismatches signifies
that the RAID logical volume has portions of the array that are not coherent.
Inconsistencies are detected by initiating a "check" on a RAID logical volume.
(The scrubbing operations, "check" and "repair", can be performed on a RAID
logical volume via the 'lvchange' command.) (\fBw\fP)ritemostly signifies the
devices in a RAID 1 logical volume that have been marked write-mostly.
Re(\fBs\fP)haping signifies a RAID Logical Volume is either undergoing
a stripe addition/removal, a stripe size or RAID algorithm change.
(\fBR\fP)emove after reshape signifies freed striped raid images to be removed.
.
.IP
Related to Thin pool Logical Volumes: (\fBF\fP)ailed, out of (\fBD\fP)ata space,
(\fBM\fP)etadata read only.
.br
(\fBF\fP)ailed is set if thin pool encounters serious failures
and hence no further I/O is permitted at all.
The out of (\fBD\fP)ata space is set if thin pool has run out of data space.
(\fBM\fP)etadata read only signifies that thin pool encounters certain
types of failures but it's still possible to do reads at least,
but no metadata changes are allowed.
.
.IP
Related to Thin Logical Volumes: (\fBF\fP)ailed.
.br
(\fBF\fP)ailed is set when related thin pool enters Failed state and
no further I/O is permitted at all.
.
.IP
Related to writecache logical volumes: (\fBE\fP)rror.
.br
(\fBE\fP)rror is set dm-writecache reports an error.
.
.IP 10
s(\fBk\fP)ip activation: this volume is flagged to be skipped during activation.