1 .\" Copyright (c) 2014, Luiz Otavio O Souza <loos@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd "GEOM based compressed disk images"
34 To compile this driver into the kernel, place the following line in your
35 kernel configuration file:
36 .Bd -ragged -offset indent
37 .Cd "options GEOM_UNCOMPRESS"
40 Alternatively, to load the driver as a module at boot time, place the
43 .Bd -literal -offset indent
44 geom_uncompress_load="YES"
49 framework provides support for compressed read only disk images.
50 This allows significant storage savings at the expense of a little CPU
52 Data written in the GEOM label area allows
54 to detect compressed images which have been created with
58 and presented to the kernel as a logical disk device via
63 device for each image.
67 device is subsequently used by the
69 kernel to access the disk images.
72 driver does not allow write operations to the underlying disk image.
78 .Bd -literal -offset indent
79 # geom uncompress list
80 Geom name: md0.uncompress
82 1. Name: md0.uncompress
83 Mediasize: 52428800 (50M)
88 Mediasize: 20864000 (20M)
102 driver was written by
103 .An "Maxim Sobolev" Aq sobomax@FreeBSD.org
105 .An "Aleksandr Rybalko" Aq ray@FreeBSD.org .
106 This manual page was written by
107 .An "Luiz Otavio O Souza" Aq loos@FreeBSD.org .