[lvm-devel] [PATCH 06/12] Replicator: lvcreate, lvm man pages

[Zdenek Kabelac]

Update man pages to cover basic usage of lvcreate

Current descriptions shows how to create replicator,
add site, add replicated device.

Signed-off-by: Zdenek Kabelac <zkabelac at redhat.com>
---
 man/lvcreate.8.in |   66 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 man/lvm.8.in      |    3 +-
 2 files changed, 68 insertions(+), 1 deletions(-)

diff --git a/man/lvcreate.8.in b/man/lvcreate.8.in
index 0d0976f..ce9c078 100644
--- a/man/lvcreate.8.in
+++ b/man/lvcreate.8.in
@@ -36,6 +36,26 @@ VolumeGroupName [PhysicalVolumePath[:PE[-PE]]...]
 OriginalLogicalVolumePath | 
 [\-s|\-\-snapshot]
 VolumeGroupName \-\-virtualsize VirtualSize}
+.br
+
+.br
+.B lvcreate
+{\-l|\-\-extents LogicalExtentsNumber[%{VG|FREE|ORIGIN}] |
+ \-L|\-\-size LogicalVolumeSize[bBsSkKmMgGtTpPeE]}
+[\-\-replicatorlogtype ReplicatorLogType]
+{[\-\-replicatorsynclog {disk|core}] | [\-\-corelog]}
+[\-R|\-\-regionsize ReplicatorSyncLogRegionSize]]
+{[\-\-fallbehinddata Size[bBsSkKmMgGtTpPeE]] |
+[\-\-fallbehindios  IOS] |
+[\-\-fallbehindtimeout sec]}
+[\-\-sitemode [sync|warn|stall|drop|fail]
+[\-\-remotevg RemoteVolumeGroupName]
+[\-\-nosync]
+\-n|\-\-name ReplicatorName
+\-\-replicator [ReplicatorName[Path]]
+VolumeGroupName
+.br
+
 .SH DESCRIPTION
 lvcreate creates a new logical volume in a volume group ( see
 .B vgcreate(8), vgchange(8)
@@ -52,6 +72,9 @@ extents will be restricted to these volumes.
 .br
 The second form supports the creation of snapshot logical volumes which 
 keep the contents of the original logical volume for backup purposes.
+.br
+The third form supports the creation of replicator logical volumes which 
+keep the contents of the replicators.
 .SH OPTIONS
 See \fBlvm\fP for common options.
 .TP
@@ -120,6 +143,33 @@ device is activated, for example, after every reboot.  Using "mirrored"
 will create a persistent log that is itself mirrored.
 
 The optional argument --corelog is equivalent to --mirrorlog core.
+.TP
+.I \-\-replicator
+Creates empty replicator logical volume. ( see
+.B lvchange(8)
+) for options, how to customize created replicator LV.
+
+Specifying optional argument --nosync will cause the creation
+of the replicator to skip the initial resynchronization. Any data written
+afterwards will be replicated, but the original content will not be
+copied.  This is useful for skipping a potentially long and resource
+intensive initial sync of an empty device.
+
+The optional argument --replicatorsynclog specifies the type of synclog to be
+used. The default is disk, which is persistent and requires a small amount of
+storage space. Using core means the replicator is regenerated by copying the
+data from the first device again each time the device is activated, for
+example, after every reboot.
+
+The optional argument --replicatorlogtype specifies type of the backing store
+log. The default and currently the only valid and supported type is
+\fBringbuffer\fP.
+
+
+.TP
+.I \-\-replicatordev
+Creates empty replicated logical volume in given ReplicatorName.
+(Future: If the --site is not specified, local site is found inside replicator LV.) 
 
 .TP
 .I \-n, \-\-name LogicalVolumeName
@@ -246,10 +296,26 @@ under 100MB of actual data on it.
 creates a linear logical volume "vg00/lvol1" using physical extents
 /dev/sda:0-7 and /dev/sdb:0-7 for allocation of extents.
 
+"lvcreate --replicator -L 1G -n rep0 vg00"
+.br
+creates a replicator vg00/rep0 and hidden replicator backing store device 
+"vg00/rep0_rlog" of size 1G.
+
+"lvcreate --replicator vg00/rep0 --site Remote --remotevg remotevg00 --fallbehinddata 100M"
+.br
+creates a remote site Remote in replicator vg00/rep0 which uses remote volume group
+remotevg00 and could get upto 100MiB asynchronous behind replicated volume.
+For this version remote LVs must be created by hand in remote volume group.
+
+"lvcreate --replicatordev -n lvol1 -L 64M --replicator vg00/rep0"
+.br
+creates a replicated device named /dev/vg00/lvol1 of size 64M attached to replicator 
+vg00/rep0.
 
 .SH SEE ALSO
 .BR lvm (8), 
 .BR vgcreate (8), 
+.BR lvchange (8),
 .BR lvremove (8), 
 .BR lvrename (8)
 .BR lvextend (8), 
diff --git a/man/lvm.8.in b/man/lvm.8.in
index e38ce4f..7d070f7 100644
--- a/man/lvm.8.in
+++ b/man/lvm.8.in
@@ -271,7 +271,8 @@ The following characters are valid for VG and LV names:
 VG and LV names cannot begin with a hyphen.
 There are also various reserved names that are used internally by lvm that can not be used as LV or VG names.
 A VG cannot be called anything that exists in /dev/ at the time of creation, nor can it be called '.' or '..'.
-A LV cannot be called '.' '..' 'snapshot' or 'pvmove'. The LV name may also not contain the strings '_mlog' or '_mimage'
+A LV cannot be called '.' '..' 'snapshot' or 'pvmove'. The LV name may also not contain the strings 
+'_mlog', '_mimage', '_rlog', '_slog', '_rimage'.
 
 
 .SH DIAGNOSTICS
-- 
1.7.1