~ubuntu-branches/debian/sid/lvm2/sid

« back to all changes in this revision

Viewing changes to man/dmsetup.8.in

  • Committer: Package Import Robot
  • Author(s): Bastian Blank
  • Date: 2014-08-19 15:37:06 UTC
  • mfrom: (1.1.18)
  • Revision ID: package-import@ubuntu.com-20140819153706-i1gaio8lg534dara
Tags: 2.02.109-1
New upstream version.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.TH DMSETUP 8 "Apr 06 2006" "Linux" "MAINTENANCE COMMANDS"
2
2
.SH NAME
3
 
dmsetup \- low level logical volume management
 
3
dmsetup \(em low level logical volume management
4
4
.SH SYNOPSIS
5
5
.ad l
6
6
.B dmsetup clear
40
40
.IR fields ]
41
41
.RB [ \-O | \-\-sort
42
42
.IR sort_fields ]
 
43
.RB [ \-S | \-\-select
 
44
.IR Selection ]
43
45
.RI [ device_name ]
44
46
.RE
45
47
.br
192
194
inactive table instead of the live table.
193
195
Requires kernel driver version 4.16.0 or above.
194
196
.TP
195
 
.IR \fB\-\-manglename \ < mangling_mode >
 
197
.IR \fB\-\-manglename \ { none | hex | auto }
196
198
Mangle any character not on a whitelist using mangling_mode when
197
199
processing device-mapper device names and UUIDs. The names and UUIDs
198
 
are mangled on input and unmangled on output where the mangling_mode
199
 
is one of: none (no mangling), hex (always do the mangling) and auto
200
 
(only do the mangling if not mangled yet, do nothing if already
201
 
mangled, error on mixed; this is used by default).
 
200
are mangled on input and unmangled on output where the mangling mode
 
201
is one of:
 
202
\fInone\fP (no mangling),
 
203
\fIhex\fP (always do the mangling) and
 
204
\fIauto\fP (only do the mangling if not mangled yet, do nothing
 
205
if already mangled, error on mixed)
 
206
Default mode is \fI#DEFAULT_MANGLING#\fP.
202
207
Character whitelist: 0-9, A-Z, a-z, #+-.:=@_. This whitelist is
203
208
also supported by udev. Any character not on a whitelist is replaced
204
209
with its hex value (two digits) prefixed by \\x.
 
210
Mangling mode could be also set through
 
211
.B DM_DEFAULT_NAME_MANGLING_MODE
 
212
environment variable.
205
213
.TP
206
214
.BR \-j | \-\-major\ \fImajor
207
215
Specify the major number.
238
246
.BR \-r | \-\-readonly
239
247
Set the table being loaded read-only.
240
248
.TP
 
249
.BR \-S | \-\-select \ \fISelection
 
250
Display only rows that match Selection criteria. All rows are displayed
 
251
with the additional "selected" column (-o selected) showing 1 if the row
 
252
matches the Selection and 0 otherwise. The Selection criteria are defined
 
253
by specifying column names and their valid values while making use of
 
254
supported comparison operators. As a quick help and to see full list of
 
255
column names that can be used in Selection and the set of supported
 
256
selection operators, check the output of \fBdmsetup info -c -S help\fP
 
257
command.
 
258
.TP
241
259
.IR \fB\-\-table \ < table >
242
260
Specify a one-line table directly on the command line.
243
261
.TP
244
262
.B \-\-udevcookie \fIcookie
245
263
Use cookie for udev synchronisation.
 
264
Note: Same cookie should be used for same type of operations i.e. creation of
 
265
multiple different devices. It's not adviced to combine different
 
266
operations on the single device.
246
267
.TP
247
268
.BR \-u | \-\-uuid
248
269
Specify the uuid.
380
401
.br
381
402
Wait for any I/O in-flight through the device to complete, then
382
403
replace the table with a new table that fails any new I/O
383
 
sent to the device.  If successful, this should release any devices 
 
404
sent to the device.  If successful, this should release any devices
384
405
held open by the device's table(s).
385
406
.br
386
407
.HP
423
444
In this case the device will be deleted when its open_count
424
445
drops to zero.  From version 4.8.0 onwards, if a device can't
425
446
be removed because an uninterruptible process is waiting for
426
 
I/O to return from it, adding \-\-force will replace the table
 
447
I/O to return from it, adding \fB\-\-force\fP will replace the table
427
448
with one that fails all I/O, which might allow the
428
449
process to be killed. If an attempt to remove a device fails,
429
450
perhaps because a process run from a quick udev rule
430
 
temporarily opened the device, the \-\-retry option will cause
 
451
temporarily opened the device, the \fB\-\-retry\fP option will cause
431
452
the operation to be retried for a few seconds before failing.
 
453
Do NOT combine \fB\-\-force\fP and \fB\-\-udevcookie\fP,
 
454
as udev may start to process udev rules in the middle of error target
 
455
replacement and result in nondeterministic result.
432
456
.br
433
457
.HP
434
458
.B remove_all
437
461
Attempts to remove all device definitions i.e. reset the driver.
438
462
Use with care!  From version 4.8.0 onwards, if devices can't
439
463
be removed because uninterruptible processes are waiting for
440
 
I/O to return from them, adding \-\-force will replace the table
 
464
I/O to return from them, adding \fB\-\-force\fP will replace the table
441
465
with one that fails all I/O, which might allow the
442
466
process to be killed.  This also runs \fBmknodes\fP afterwards.
443
467
.br
478
502
.RI [ subsystem ]
479
503
.br
480
504
Splits given device name into subsystem constituents.
481
 
Default subsystem is LVM.
 
505
The default subsystem is LVM.  
 
506
LVM currently generates device names by concatenating the names of the Volume
 
507
Group, Logical Volume and any internal Layer with a hyphen as separator.
 
508
Any hyphens within the names are doubled to escape them.
 
509
The precise encoding might change without notice in any future
 
510
release, so we recommend you always decode using the current version of
 
511
this command.
482
512
.br
483
513
.TP
484
514
.B status
488
518
.RI [ device_name ]
489
519
.br
490
520
Outputs status information for each of the device's targets.
491
 
With \-\-target, only information relating to the specified target type
 
521
With \fB\-\-target\fP, only information relating to the specified target type
492
522
any is displayed.  With \fB\-\-noflush\fP, the thin target (from version 1.3.0)
493
523
doesn't commit any outstanding changes to disk before reporting its statistics.
494
524
.br
603
633
.B target_type
604
634
.RI < target_args >
605
635
.P
606
 
Simple target types and <target_args> include: 
 
636
Simple target types and <target_args> include:
607
637
.HP
608
638
.B linear
609
639
.I destination_device start_sector
674
704
.P
675
705
To find out more about the various targets and their table formats and status
676
706
lines, please read the files in the Documentation/device-mapper directory in
677
 
the kernel source tree.  
678
 
(Your distribution might include a copy of this information in the 
 
707
the kernel source tree.
 
708
(Your distribution might include a copy of this information in the
679
709
documentation directory for the device-mapper package.)
680
710
 
681
711
.SH EXAMPLES
706
736
.TP
707
737
.B DM_UDEV_COOKIE
708
738
A cookie to use for all relevant commands to synchronize with udev processing.
709
 
It is an alternative to using \-\-udevcookie option.
 
739
It is an alternative to using \fB\-\-udevcookie\fP option.
 
740
.TP
 
741
.B DM_DEFAULT_NAME_MANGLING_MODE
 
742
A default mangling mode. Defaults to "\fI#DEFAULT_MANGLING#\fP"
 
743
and it is an alternative to using \fB\-\-manglename\fP option.
710
744
 
711
745
.SH AUTHORS
712
746
Original version: Joe Thornber (thornber@redhat.com)
713
747
 
714
748
.SH SEE ALSO
 
749
LVM2 resource page https://www.sourceware.org/lvm2/
 
750
.br
715
751
Device-mapper resource page: http://sources.redhat.com/dm/