xref: /freebsd/share/man/man4/geom_linux_lvm.4 (revision 61e21613)
1.\"
2.\" Copyright (c) 2008 Andrew Thompson
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd October 1, 2013
27.Dt GEOM_LINUX_LVM 4
28.Os
29.Sh NAME
30.Nm geom_linux_lvm
31.Nd "GEOM based Linux LVM logical volume mapping"
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following line in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "options GEOM_LINUX_LVM"
38.Ed
39.Pp
40Alternatively, to load the driver as a
41module at boot time, place the following line in
42.Xr loader.conf 5 :
43.Bd -literal -offset indent
44geom_linux_lvm_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49framework provides support for mapping Linux LVM volumes to GEOM providers.
50.Nm
51currently supports linear stripes with segments on one or more physical disks.
52The parser is able to read LVM2 Text Format metadata, the logical volumes will
53be assembled and made available under
54.Pa /dev/linux_lvm/ .
55The metadata is read-only, logical volumes cannot be allocated or resized.
56.Sh EXAMPLES
57To view which
58.Nm
59devices are available:
60.Bd -literal -offset indent
61# geom linux_lvm list
62Geom name: vg1
63Providers:
641. Name: linux_lvm/vg1-home
65   Mediasize: 4294967296 (4.0G)
66   Sectorsize: 512
67   Mode: r0w0e0
682. Name: linux_lvm/vg1-logs
69   Mediasize: 4294967296 (4.0G)
70   Sectorsize: 512
71   Mode: r0w0e0
72Consumers:
731. Name: ada0s1
74   Mediasize: 80023716864 (75G)
75   Sectorsize: 512
76   Mode: r0w0e0
77.Ed
78.Sh SEE ALSO
79.Xr GEOM 4 ,
80.Xr geom 8
81.Sh AUTHORS
82.An -nosplit
83The
84.Nm
85driver was written by
86.An Andrew Thompson Aq Mt thompsa@FreeBSD.org .
87