share/man/man4/geom_uzip.4

   1 .\"
   2 .\" Copyright (c) 2006 Ceri Davies
   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 .\" $FreeBSD$
  27 .\"
  28 .Dd October 9, 2006
  29 .Os
  30 .Dt GEOM_UZIP 4
  31 .Sh NAME
  32 .Nm geom_uzip
  33 .Nd "GEOM based compressed disk images"
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following line in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "options GEOM_UZIP"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 geom_uzip_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 framework provides support for compressed read only
  52 disk images.
  53 This allows significant storage savings at the expense of
  54 a little CPU time on each read.
  55 Data written in the GEOM label area allows
  56 .Nm
  57 to detect compressed images which have been created with
  58 .Xr mkuzip 8
  59 and presented to the kernel as a logical disk device via
  60 .Xr md 4 .
  61 .Nm
  62 creates a unique
  63 .Pa md#.uzip
  64 device for each image.
  65 .Pp
  66 The
  67 .Nm
  68 device is subsequently used by the
  69 .Fx
  70 kernel to access the disk images.
  71 The
  72 .Nm
  73 driver does not allow write operations to the underlying disk image.
  74 To check which
  75 .Xr md 4
  76 devices match a given
  77 .Nm
  78 device:
  79 .Bd -literal -offset indent
  80 # geom uzip list
  81 Geom name: md1.uzip
  82 Providers:
  83 1. Name: md1.uzip
  84    Mediasize: 22003712 (21M)
  85    Sectorsize: 512
  86    Mode: r1w0e1
  87 Consumers:
  88 1. Name: md1
  89    Mediasize: 9563648 (9.1M)
  90    Sectorsize: 512
  91    Mode: r1w0e1
  92 .Ed
  93 .Pp
  94 .Sh SEE ALSO
  95 .Xr GEOM 4 ,
  96 .Xr md 4 ,
  97 .Xr geom 8 ,
  98 .Xr mkuzip 8
  99 .Sh AUTHORS
 100 .An -nosplit
 101 The
 102 .Nm
 103 driver was written by
 104 .An "Max Khon" Aq fjoe@FreeBSD.org .
 105 This manual page was written by
 106 .An "Ceri Davies" Aq ceri@FreeBSD.org .