share/man/man4/geom_uncompress.4

   1 .\" Copyright (c) 2014, Luiz Otavio O Souza <loos@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd January 9, 2014
  28 .Dt GEOM_UNCOMPRESS 4
  29 .Os
  30 .Sh NAME
  31 .Nm geom_uncompress
  32 .Nd "GEOM based compressed disk images"
  33 .Sh SYNOPSIS
  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"
  38 .Ed
  39 .Pp
  40 Alternatively, to load the driver as a module at boot time, place the
  41 following line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 geom_uncompress_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 framework provides support for compressed read only disk images.
  50 This allows significant storage savings at the expense of a little CPU
  51 time on each read.
  52 Data written in the GEOM label area allows
  53 .Nm
  54 to detect compressed images which have been created with
  55 .Xr mkulzma 8
  56 or
  57 .Xr mkuzip 8
  58 and presented to the kernel as a logical disk device via
  59 .Xr md 4 .
  60 .Nm
  61 creates a unique
  62 .Pa md#.uncompress
  63 device for each image.
  64 .Pp
  65 The
  66 .Nm
  67 device is subsequently used by the
  68 .Fx
  69 kernel to access the disk images.
  70 The
  71 .Nm
  72 driver does not allow write operations to the underlying disk image.
  73 To check which
  74 .Xr md 4
  75 devices match a given
  76 .Nm
  77 device:
  78 .Bd -literal -offset indent
  79 # geom uncompress list
  80 Geom name: md0.uncompress
  81 Providers:
  82 1. Name: md0.uncompress
  83    Mediasize: 52428800 (50M)
  84    Sectorsize: 512
  85    Mode: r1w0e0
  86 Consumers:
  87 1. Name: md0
  88    Mediasize: 20864000 (20M)
  89    Sectorsize: 512
  90    Mode: r1w0e0
  91 .Ed
  92 .Sh SEE ALSO
  93 .Xr GEOM 4 ,
  94 .Xr md 4 ,
  95 .Xr geom 8 ,
  96 .Xr mkulzma 8 ,
  97 .Xr mkuzip 8
  98 .Sh AUTHORS
  99 .An -nosplit
 100 The
 101 .Nm
 102 driver was written by
 103 .An "Maxim Sobolev" Aq sobomax@FreeBSD.org
 104 and
 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 .