1272bf9a8SCeri Davies.\" 2272bf9a8SCeri Davies.\" Copyright (c) 2006 Ceri Davies 3272bf9a8SCeri Davies.\" All rights reserved. 4272bf9a8SCeri Davies.\" 5272bf9a8SCeri Davies.\" Redistribution and use in source and binary forms, with or without 6272bf9a8SCeri Davies.\" modification, are permitted provided that the following conditions 7272bf9a8SCeri Davies.\" are met: 8272bf9a8SCeri Davies.\" 1. Redistributions of source code must retain the above copyright 9272bf9a8SCeri Davies.\" notice, this list of conditions and the following disclaimer. 10272bf9a8SCeri Davies.\" 2. Redistributions in binary form must reproduce the above copyright 11272bf9a8SCeri Davies.\" notice, this list of conditions and the following disclaimer in the 12272bf9a8SCeri Davies.\" documentation and/or other materials provided with the distribution. 13272bf9a8SCeri Davies.\" 14272bf9a8SCeri Davies.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15272bf9a8SCeri Davies.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16272bf9a8SCeri Davies.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17272bf9a8SCeri Davies.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18272bf9a8SCeri Davies.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19272bf9a8SCeri Davies.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20272bf9a8SCeri Davies.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21272bf9a8SCeri Davies.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22272bf9a8SCeri Davies.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23272bf9a8SCeri Davies.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24272bf9a8SCeri Davies.\" SUCH DAMAGE. 25272bf9a8SCeri Davies.\" 26272bf9a8SCeri Davies.\" $FreeBSD$ 27272bf9a8SCeri Davies.\" 28272bf9a8SCeri Davies.Dd October 8, 2006 29272bf9a8SCeri Davies.Os 30272bf9a8SCeri Davies.Dt GEOM_UZIP 4 31272bf9a8SCeri Davies.Sh NAME 32272bf9a8SCeri Davies.Nm geom_uzip 33272bf9a8SCeri Davies.Nd "GEOM based compressed disk images" 34272bf9a8SCeri Davies.Sh SYNOPSIS 35272bf9a8SCeri DaviesTo compile this driver into the kernel, 36272bf9a8SCeri Daviesplace the following line in your 37272bf9a8SCeri Davieskernel configuration file: 38272bf9a8SCeri Davies.Bd -ragged -offset indent 39272bf9a8SCeri Davies.Cd "options GEOM_UZIP" 40272bf9a8SCeri Davies.Ed 41272bf9a8SCeri Davies.Pp 42272bf9a8SCeri DaviesAlternatively, to load the driver as a 43272bf9a8SCeri Daviesmodule at boot time, place the following line in 44272bf9a8SCeri Davies.Xr loader.conf 5 : 45272bf9a8SCeri Davies.Bd -literal -offset indent 46272bf9a8SCeri Daviesgeom_uzip_load="YES" 47272bf9a8SCeri Davies.Ed 48272bf9a8SCeri Davies.Sh DESCRIPTION 49272bf9a8SCeri DaviesThe 50272bf9a8SCeri Davies.Nm 51272bf9a8SCeri Daviesframework provides support for compressed read only 52272bf9a8SCeri Daviesdisk images. 53272bf9a8SCeri DaviesThis allows significant storage savings at the expense of 54272bf9a8SCeri Daviesa little CPU time on each read. 55272bf9a8SCeri DaviesData written in the GEOM label area allows 56272bf9a8SCeri Davies.Nm 57272bf9a8SCeri Daviesto detect compressed images which have been created with 58272bf9a8SCeri Davies.Xr mkuzip 8 59272bf9a8SCeri Daviesand presented to the kernel as a logical disk device via 60272bf9a8SCeri Davies.Xr md 4 . 61272bf9a8SCeri Davies.Nm 62272bf9a8SCeri Daviescreates a unique 63272bf9a8SCeri Davies.Pa md#.uzip 64272bf9a8SCeri Daviesdevice for each image. 65272bf9a8SCeri Davies.Pp 66272bf9a8SCeri DaviesThe 67272bf9a8SCeri Davies.Nm 68272bf9a8SCeri Daviesdevice is subsequently used by the 69272bf9a8SCeri Davies.Fx 70272bf9a8SCeri Davieskernel to access the disk images. 71272bf9a8SCeri DaviesThe 72272bf9a8SCeri Davies.Nm 73272bf9a8SCeri Daviesdriver does not allow write operations to the underlying disk image. 74272bf9a8SCeri DaviesTo check which 75272bf9a8SCeri Davies.Xr md 4 76272bf9a8SCeri Daviesdevices match a given 77272bf9a8SCeri Davies.Nm 78272bf9a8SCeri Daviesdevice: 79272bf9a8SCeri Davies.Bd -literal -offset indent 80272bf9a8SCeri Davies# geom uzip list 81272bf9a8SCeri DaviesGeom name: md1.uzip 82272bf9a8SCeri DaviesProviders: 83272bf9a8SCeri Davies1. Name: md1.uzip 84272bf9a8SCeri Davies Mediasize: 22003712 (21M) 85272bf9a8SCeri Davies Sectorsize: 512 86272bf9a8SCeri Davies Mode: r1w0e1 87272bf9a8SCeri DaviesConsumers: 88272bf9a8SCeri Davies1. Name: md1 89272bf9a8SCeri Davies Mediasize: 9563648 (9.1M) 90272bf9a8SCeri Davies Sectorsize: 512 91272bf9a8SCeri Davies Mode: r1w0e1 92272bf9a8SCeri Davies.Ed 93272bf9a8SCeri Davies.Pp 94272bf9a8SCeri Davies.Sh SEE ALSO 95272bf9a8SCeri Davies.Xr GEOM 4 , 96272bf9a8SCeri Davies.Xr geom 8 97272bf9a8SCeri Davies.Sh AUTHORS 98272bf9a8SCeri Davies.An -nosplit 99272bf9a8SCeri DaviesThe 100272bf9a8SCeri Davies.Nm 101272bf9a8SCeri Daviesdriver was written by 102272bf9a8SCeri Davies.An "Max Khon" Aq fjoe@FreeBSD.org . 103272bf9a8SCeri DaviesThis manual page was written by 104272bf9a8SCeri Davies.An "Ceri Davies" Aq ceri@FreeBSD.org . 105