xref: /illumos-gate/usr/src/man/man8/fiocompress.8 (revision 1e56f352c1c208679012bca47d552e127f5b1072)
te
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
FIOCOMPRESS 8 "Dec 10, 2008"
NAME
fiocompress - file compression utility
SYNOPSIS

/sbin/fiocompress -c [-m] [-b block_size] input_file output_file

/sbin/fiocompress -d input_file output_file
DESCRIPTION

The fiocompress utility is a file compression tool that works together with the dcfs(4FS) file system to perform per-file compression. You can use fiocompress to decompress a compressed file or mark a compressed file as compressed, causing automatic decompression on read. The primary use of fiocompress is to compress files in the boot archive.

Note that this utility is not a Committed interface. See attributes(7).

OPTIONS

The following options are supported: -b block_size

Specify a block size for compression. The default block size is 8192.

-c

Compress the specified file.

-d

Decompress the specified file.

-m

Mark the compressed file for automatic decompression on read. Can be used only in conjunction with -c.

EXIT STATUS
0

The command completed successfully.

-1

The command exited due to an error.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Private
SEE ALSO

dcfs (4FS), ufs (4FS), attributes (7), boot (8), bootadm (8)

NOTES

This compression/decompression utility works only with files stored in a UFS file system.

There is no obvious way to determine whether a given file is compressed, other than copying the file and comparing the number of disk blocks of the copy against the original.