diff options
author | ceri <ceri@FreeBSD.org> | 2006-10-08 17:05:15 +0000 |
---|---|---|
committer | ceri <ceri@FreeBSD.org> | 2006-10-08 17:05:15 +0000 |
commit | 3605ec17e550b7ced754ff7fbf923e90829dc155 (patch) | |
tree | 636eaa05ae932ece1bb16f557ff64060a708719e /share/man | |
parent | eefbee99bedddea7321cc36dddb207b9653f6e36 (diff) | |
download | FreeBSD-src-3605ec17e550b7ced754ff7fbf923e90829dc155.zip FreeBSD-src-3605ec17e550b7ced754ff7fbf923e90829dc155.tar.gz |
Add a basic manpage for geom_uzip(4).
Reviewed by: trhodes
MFC after: 1 week
Diffstat (limited to 'share/man')
-rw-r--r-- | share/man/man4/Makefile | 1 | ||||
-rw-r--r-- | share/man/man4/geom_uzip.4 | 104 |
2 files changed, 105 insertions, 0 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 7855061..e400be5 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -90,6 +90,7 @@ MAN= aac.4 \ gem.4 \ geom.4 \ geom_fox.4 \ + geom_uzip.4 \ gif.4 \ gre.4 \ harp.4 \ diff --git a/share/man/man4/geom_uzip.4 b/share/man/man4/geom_uzip.4 new file mode 100644 index 0000000..83340b8 --- /dev/null +++ b/share/man/man4/geom_uzip.4 @@ -0,0 +1,104 @@ +.\" +.\" Copyright (c) 2006 Ceri Davies +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd October 8, 2006 +.Os +.Dt GEOM_UZIP 4 +.Sh NAME +.Nm geom_uzip +.Nd "GEOM based compressed disk images" +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following line in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "options GEOM_UZIP" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +geom_uzip_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +framework provides support for compressed read only +disk images. +This allows significant storage savings at the expense of +a little CPU time on each read. +Data written in the GEOM label area allows +.Nm +to detect compressed images which have been created with +.Xr mkuzip 8 +and presented to the kernel as a logical disk device via +.Xr md 4 . +.Nm +creates a unique +.Pa md#.uzip +device for each image. +.Pp +The +.Nm +device is subsequently used by the +.Fx +kernel to access the disk images. +The +.Nm +driver does not allow write operations to the underlying disk image. +To check which +.Xr md 4 +devices match a given +.Nm +device: +.Bd -literal -offset indent +# geom uzip list +Geom name: md1.uzip +Providers: +1. Name: md1.uzip + Mediasize: 22003712 (21M) + Sectorsize: 512 + Mode: r1w0e1 +Consumers: +1. Name: md1 + Mediasize: 9563648 (9.1M) + Sectorsize: 512 + Mode: r1w0e1 +.Ed +.Pp +.Sh SEE ALSO +.Xr GEOM 4 , +.Xr geom 8 +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An "Max Khon" Aq fjoe@FreeBSD.org . +This manual page was written by +.An "Ceri Davies" Aq ceri@FreeBSD.org . |