xref: /illumos-gate/usr/src/man/man4fs/dcfs.4fs (revision ddb365bfc9e868ad24ccdcb0dc91af18b10df082)
1.\"
2.\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
3.\" Copyright 2021 Oxide Computer Company
4.\"
5.\" The contents of this file are subject to the terms of the
6.\" Common Development and Distribution License (the "License").
7.\" You may not use this file except in compliance with the License.
8.\"
9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10.\" or http://www.opensolaris.org/os/licensing.
11.\" See the License for the specific language governing permissions
12.\" and limitations under the License.
13.\"
14.\" When distributing Covered Code, include this CDDL HEADER in each
15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16.\" If applicable, add the following below this CDDL HEADER, with the
17.\" fields enclosed by brackets "[]" replaced with your own identifying
18.\" information: Portions Copyright [yyyy] [name of copyright owner]
19.\"
20.Dd November 28, 2007
21.Dt DCFS 4FS
22.Os
23.Sh NAME
24.Nm dcfs
25.Nd Compression file system
26.Sh SYNOPSIS
27.In sys/filio.h
28.In sys/fs/decomp.h
29.Sh DESCRIPTION
30The
31.Nm
32filesystem is a layered filesystem that you use to compress data when writing to
33a file and decompress upon read.
34The primary function of the
35.Nm
36filesystem is to compress individual files when constructing a boot archive and
37when reading or booting from the archive.
38.Sh INTERFACE STABILITY
39.Sy Uncommitted
40.Sh SEE ALSO
41.Xr ufs 4FS ,
42.Xr attributes 7 ,
43.Xr boot 8 ,
44.Xr bootadm 8 ,
45.Xr fiocompress 8
46.Sh NOTES
47The
48.Nm
49compression/decompression file system works only with UFS.
50