LVM2/man dmsetup.8.in

LVM2/man dmsetup.8.in

[agk]

CVSROOT:	/cvs/lvm2
Module name:	LVM2
Changes by:	agk@sourceware.org	2011-11-30 22:32:37

Modified files:
	man            : dmsetup.8.in 

Log message:
	refer to kernel docs for target info
	FIXME thin still missing

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/LVM2/man/dmsetup.8.in.diff?cvsroot=lvm2&r1=1.46&r2=1.47

--- LVM2/man/dmsetup.8.in	2011/11/13 01:41:57	1.46
+++ LVM2/man/dmsetup.8.in	2011/11/30 22:32:37	1.47
@@ -532,16 +532,13 @@
 To wait until the next event is triggered, use \fBinfo\fP to find
 the last event number.
 .SH TABLE FORMAT
-// FIXME Rewrite safely (a lot of work) or remove.
 Each line of the table specifies a single target and is of the form:
 .P
 .I logical_start_sector num_sectors
 .B target_type
 .RI < target_args >
 .P
-There are currently three simple target types available (linear,
-striped, error) together with more complex optional ones that implement
-e.g. snapshots and mirrors.
+Simple target types and <target_args> include: 
 .HP
 .B linear
 .I destination_device start_sector
@@ -572,83 +569,49 @@
 Errors any I/O that goes to this area.  Useful for testing or
 for creating devices with holes in them.
 .TP
+.B zero
+.br
+Returns blocks of zeroes on reads.  Any data written is discarded silently.
+This is a block-device equivalent of the /dev/zero character-device data sink
+described in \fBnull(4)\fP.
+.P
+More complex targets include:
+.TP
 .B crypt
-.I cipher key iv_offset destination offset
-.RI [ num_params
-.RI < params >]
 .br
-Target for transparent encryption of block devices
-using the kernel crypto API.
+Transparent encryption of block devices using the kernel crypto API.
 .TP
 .B delay
-.I read_device read_offset read_delay
-.RI [ write_device
-.I write_offset
-.IR write_delay ]
 .br
-Creates mapping that "delays" reads and/or writes
-to different devices.
+Delays reads and/or writes to different devices.  Useful for testing.
 .TP
 .B flakey
-.I destination_device start_sector up_interval
-.I down_interval
-.RI [ num_features
-.RI [< feature_arguments >]]
-.br
-Creates the same mapping as the linear target except
-that it exhibits unreliable behaviour periodically.
-Useful for simulating failing devices for testing
-purposes.
+.br
+Creates a similar mapping to the linear target but
+exhibits unreliable behaviour periodically.
+Useful for simulating failing devices when testing.
 .TP
 .B mirror
-.I log_type num_logargs
-.RI < logargs >
-.I num_devices
-.RI < device
-.IR offset >+
 .br
-Creates mirror mapping target for mirrored logical devices.
+Mirrors data across two or more devices.
 .HP
 .B multipath
-.I num_features
-.RI < features >
-.I num_handle_args
-.RI < handle_args >
-.I num_path_groups
-.I path_group
-.RI < path_group_args1\.\.N >
-.br
-Creates multipath mapping.
-.TP
-.BR raid1 | raid4 | raid5_ { la | ra | ls | rs }| raid6_ { zr | mr | nc }
-.I num_raid_params
-.RI < raid_params >
-.I num_raid_devs
-.RI < metadata_device
-.IR device >+
-.br
-Creates RAID "bridge" mapping between DM and MD.
-It allows the MD RAID drivers to be
-accessed using a device-mapper interface.
-.HP
-.B snapshot
-.I origin_device cow_device persistant chunksize
 .br
-.HP
-.B snapshot-merge
-.I origin_device cow_device persistant chunksize
+Mediates access through multiple paths to the same device.
+.TP
+.BR raid
 .br
+Offers an interface to the kernel's software raid driver, md.
 .HP
-.B snapshot-origin
-.I origin_device
-.br
-Supports device snapshots.
-.TP
-.B zero
+.B snapshot
 .br
-Returns always zeroed data on reads and silently drops writes.
-This is similar behavior to /dev/zero, but as a block-device instead
-of a character device.
+Supports snapshots of devices.
+.P
+To find out more about the various targets and their table formats and status
+lines, please read the files in the Documentation/device-mapper directory in
+the kernel source tree.  
+(Your distribution might include a copy of this information in the 
+documentation directory for the device-mapper package.)
 
 .SH EXAMPLES
 

LVM2/man dmsetup.8.in

[prajnoha]

CVSROOT:	/cvs/lvm2
Module name:	LVM2
Changes by:	prajnoha@sourceware.org	2012-02-15 12:25:24

Modified files:
	man            : dmsetup.8.in 

Log message:
	Add dmsetup manpage entries for mangle command and --manglename option.

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/LVM2/man/dmsetup.8.in.diff?cvsroot=lvm2&r1=1.50&r2=1.51

--- LVM2/man/dmsetup.8.in	2012/01/18 18:52:02	1.50
+++ LVM2/man/dmsetup.8.in	2012/02/15 12:25:23	1.51
@@ -64,6 +64,9 @@
 .B dmsetup mknodes
 .RI [ device_name ]
 .br
+.B dmsetup mangle
+.RI [ device_name ]
+.br
 .B dmsetup reload
 .I device_name
 .RB [ \-\-table
@@ -186,6 +189,17 @@
 inactive table instead of the live table.
 Requires kernel driver version 4.16.0 or above.
 .TP
+.IR \fB\-\-manglename \ < mangling_mode >
+Mangle any character not on a whitelist using mangling_mode when
+processing device-mapper device names. The names are mangled on
+input and unmangled on output where the mangling_mode is one of:
+none (no mangling), hex (always do the mangling) and auto
+(only do the mangling if not mangled yet, do nothing if already
+mangled, error on mixed; this is used by default).
+Character whitelist: 0-9, A-Z, a-z, #+-.:=@_. This whitelist is
+also supported by udev. Any character not on a whitelist is replaced
+with its hex value (two digits) prefixed by \\x.
+.TP
 .BR \-j | \-\-major\ \fImajor
 Specify the major number.
 .TP
@@ -382,6 +396,15 @@
 driver, adding, changing or removing nodes as necessary.
 .br
 .HP
+.B mangle
+.RI [ device_name ]
+.br
+Ensure existing device-mapper device name is in the correct mangled
+form containing only whitelisted characters (supported by udev) and do
+a rename if necessary. Any character not on the whitelist will be mangled
+based on the --manglename settting.
+.br
+.HP
 .B remove
 .RB [ \-f | \-\-force ]
 .RB [ \-\-retry ]

LVM2/man dmsetup.8.in

[agk]

CVSROOT:	/cvs/lvm2
Module name:	LVM2
Changes by:	agk@sourceware.org	2011-11-13 01:41:57

Modified files:
	man            : dmsetup.8.in 

Log message:
	Incomplete documentation is worse than no documentation.
	Any documentation less-detailed than Documentation/device-mapper is
	dangerous for the non-trivial ctr lines.  And anyway, this should be in s4
	not here.

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/LVM2/man/dmsetup.8.in.diff?cvsroot=lvm2&r1=1.45&r2=1.46

--- LVM2/man/dmsetup.8.in	2011/11/12 22:48:44	1.45
+++ LVM2/man/dmsetup.8.in	2011/11/13 01:41:57	1.46
@@ -532,6 +532,7 @@
 To wait until the next event is triggered, use \fBinfo\fP to find
 the last event number.
 .SH TABLE FORMAT
+// FIXME Rewrite safely (a lot of work) or remove.
 Each line of the table specifies a single target and is of the form:
 .P
 .I logical_start_sector num_sectors

LVM2/man dmsetup.8.in

[mbroz]

CVSROOT:	/cvs/lvm2
Module name:	LVM2
Changes by:	mbroz@sourceware.org	2011-03-10 13:11:45

Modified files:
	man            : dmsetup.8.in 

Log message:
	Fix dmsetup man page typo (John Bradshaw)

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/LVM2/man/dmsetup.8.in.diff?cvsroot=lvm2&r1=1.37&r2=1.38

--- LVM2/man/dmsetup.8.in	2011/02/04 19:33:54	1.37
+++ LVM2/man/dmsetup.8.in	2011/03/10 13:11:45	1.38
@@ -290,7 +290,7 @@
 be removed because uninterruptible processes are waiting for
 I/O to return from them, adding --force will replace the table 
 with one that fails all I/O, which might allow the 
-process to be killed.  This also runs \fBmknodes\fP afterwards.
+process to be killed.  This also runs \fBmknodes\fP afterward.
 .IP \fBrename
 .I device_name new_name
 .br
@@ -374,7 +374,7 @@
 .br
 Parses given cookie value and extracts any udev control flags encoded.
 The output is in environment key format that is suitable for use in udev
-rules. If the flag has its symbolic name assigned then the ouput is
+rules. If the flag has its symbolic name assigned then the output is
 DM_UDEV_FLAG_<flag_name>='1', DM_UDEV_FLAG<flag_position>='1' otherwise.
 Subsystem udev flags don't have symbolic names assigned and these ones are
 always reported as DM_SUBSYSTEM_UDEV_FLAG<flag_position>='1'. There are

LVM2/man dmsetup.8.in

[prajnoha]

CVSROOT:	/cvs/lvm2
Module name:	LVM2
Changes by:	prajnoha@sourceware.org	2010-02-15 16:32:24

Modified files:
	man            : dmsetup.8.in 

Log message:
	Update man page for dmsetup: --udevcookie, udevcreatecookie and udevreleasecookie.

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/LVM2/man/dmsetup.8.in.diff?cvsroot=lvm2&r1=1.30&r2=1.31

--- LVM2/man/dmsetup.8.in	2010/01/07 19:45:12	1.30
+++ LVM2/man/dmsetup.8.in	2010/02/15 16:32:24	1.31
@@ -64,6 +64,11 @@
 .B dmsetup mknodes
 .I [device_name]
 .br
+.B dmsetup udevcreatecookie
+.br
+.B dmsetup udevreleasecookie
+.I [cookie]
+.br
 .B dmsetup udevflags
 .I cookie
 .br
@@ -127,6 +132,9 @@
 .IP \fB--notable
 .br
 When creating a device, don't load any table.
+.IP \fB--udevcookie\ \fIcookie
+.br
+Use cookie for udev synchronisation.
 .IP \fB--noudevrules
 Do not allow udev to manage nodes for devices in device-mapper directory.
 .br
@@ -315,6 +323,26 @@
 .br
 Displays the names and versions of the currently-loaded targets.
 .br
+.IP \fBudevcreatecookie
+.br
+Creates a new cookie to synchronize actions with udev processing.
+The output is a cookie value. Normally we don't need to create cookies since
+dmsetup creates and destroys them for each action automatically. However, we can
+generate one explicitly to group several actions together and use only one
+cookie instead. We can define a cookie to use for each relevant command by using
+--udevcookie option. Alternatively, we can export this value into the environment
+of the dmsetup process as DM_UDEV_COOKIE variable and it will be used automatically
+with all subsequent commands until it is unset.
+Invoking this command will create system-wide semaphore that needs to be cleaned
+up explicitly by calling udevreleasecookie command.
+.br
+.IP \fBudevreleasecookie
+.I [cookie]
+.br
+Waits for all pending udev processing bound to given cookie value and clean up
+the cookie with underlying semaphore. If the cookie is not given directly,
+the command will try to use a value defined by DM_UDEV_COOKIE environment variable.
+.br
 .IP \fBudevflags
 .I cookie
 .br
@@ -412,6 +440,10 @@
 \fBDM_DEV_DIR\fP
 The device directory name.
 Defaults to "/dev" and must be an absolute path.
+.TP
+\fBDM_UDEV_COOKIE\fP
+A cookie to use for all relevant commands to synchronize with udev processing.
+It is an alternative to using --udevcookie option.
 
 .SH AUTHORS
 Original version: Joe Thornber (thornber@sistina.com)

LVM2/man dmsetup.8.in

[agk]

CVSROOT:	/cvs/lvm2
Module name:	LVM2
Changes by:	agk@sourceware.org	2009-11-06 01:40:59

Modified files:
	man            : dmsetup.8.in 

Log message:
	.

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/LVM2/man/dmsetup.8.in.diff?cvsroot=lvm2&r1=1.28&r2=1.29

--- LVM2/man/dmsetup.8.in	2009/11/06 00:43:09	1.28
+++ LVM2/man/dmsetup.8.in	2009/11/06 01:40:59	1.29
@@ -282,7 +282,7 @@
 Splits given device name into subsystem constituents.
 Default subsystem is LVM.
 .IP \fBstatus
-.I [--target target_type] [--inactive]
+.I [--target target_type]
 .I [device_name]
 .br
 Outputs status information for each of the device's targets.
@@ -301,7 +301,7 @@
 the --noflush option.  This lets outstanding I/O that has not yet reached the
 device to remain unflushed.
 .IP \fBtable
-.I [--target target_type] [--inactive]
+.I [--target target_type]
 .I [device_name]
 .br
 Outputs the current table for the device in a format that can be fed

LVM2/man dmsetup.8.in

[prajnoha]

CVSROOT:	/cvs/lvm2
Module name:	LVM2
Changes by:	prajnoha@sourceware.org	2009-10-22 13:12:20

Modified files:
	man            : dmsetup.8.in 

Log message:
	Add manpage entry for dmsetup udevflags.

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/LVM2/man/dmsetup.8.in.diff?cvsroot=lvm2&r1=1.26&r2=1.27

--- LVM2/man/dmsetup.8.in	2009/09/23 12:52:52	1.26
+++ LVM2/man/dmsetup.8.in	2009/10/22 13:12:20	1.27
@@ -64,6 +64,9 @@
 .B dmsetup mknodes
 .I [device_name]
 .br
+.B dmsetup udevflags
+.I cookie
+.br
 .B dmsetup udevcomplete
 .I cookie
 .br
@@ -303,6 +306,18 @@
 .IP \fBtargets
 .br
 Displays the names and versions of the currently-loaded targets.
+.br
+.IP \fBudevflags
+.I cookie
+.br
+Parses given cookie value and extracts any udev control flags encoded.
+The output is in environment key format that is suitable for use in udev
+rules. If the flag has its symbolic name assigned then the ouput is
+DM_UDEV_FLAG_<flag_name>='1', DM_UDEV_FLAG<flag_position>='1' otherwise.
+Subsystem udev flags don't have symbolic names assigned and these ones are
+always reported as DM_SUBSYSTEM_UDEV_FLAG<flag_position>='1'. There are
+16 udev flags altogether.
+.br
 .IP \fBudevcomplete
 .I cookie
 .br

LVM2/man dmsetup.8.in

[agk]

CVSROOT:	/cvs/lvm2
Module name:	LVM2
Changes by:	agk@sourceware.org	2009-04-23 12:20:15

Modified files:
	man            : dmsetup.8.in 

Log message:
	fix typo reported by "A. Costa" <agcosta@gis.net>

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/LVM2/man/dmsetup.8.in.diff?cvsroot=lvm2&r1=1.22&r2=1.23

--- LVM2/man/dmsetup.8.in	2007/12/28 15:13:38	1.22
+++ LVM2/man/dmsetup.8.in	2009/04/23 12:20:15	1.23
@@ -232,7 +232,7 @@
 .br
 Attempts to remove all device definitions i.e. reset the driver.
 Use with care!  From version 4.8.0 onwards, if devices can't
-be removed because uninterruptible processess are waiting for
+be removed because uninterruptible processes are waiting for
 I/O to return from them, adding --force will replace the table 
 with one that fails all I/O, which might allow the 
 process to be killed.  This also runs \fBmknodes\fP afterwards.