usr/src/man/man1m/fiocompress.1m

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH FIOCOMPRESS 1M "Dec 10, 2008"
   7 .SH NAME
   8 fiocompress \- file compression utility
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/sbin/fiocompress\fR \fB-c\fR [\fB-m\fR] [\fB-b\fR \fIblock_size\fR] \fIinput_file\fR \fIoutput_file\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/sbin/fiocompress\fR \fB-d\fR \fIinput_file\fR \fIoutput_file\fR
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBfiocompress\fR utility is a file compression tool that works together
  24 with the \fBdcfs\fR(7FS) file system to perform per-file compression. You can
  25 use \fBfiocompress\fR to decompress a compressed file or mark a compressed file
  26 as compressed, causing automatic decompression on read. The primary use of
  27 \fBfiocompress\fR is to compress files in the boot archive.
  28 .sp
  29 .LP
  30 Note that this utility is not a Committed interface. See \fBattributes\fR(5).
  31 .SH OPTIONS
  32 .sp
  33 .LP
  34 The following options are supported:
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fB-b\fR \fIblock_size\fR\fR
  39 .ad
  40 .sp .6
  41 .RS 4n
  42 Specify a block size for compression. The default block size is 8192.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fB-c\fR\fR
  49 .ad
  50 .sp .6
  51 .RS 4n
  52 Compress the specified file.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fB-d\fR\fR
  59 .ad
  60 .sp .6
  61 .RS 4n
  62 Decompress the specified file.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fB-m\fR\fR
  69 .ad
  70 .sp .6
  71 .RS 4n
  72 Mark the compressed file for automatic decompression on read. Can be used only
  73 in conjunction with \fB-c\fR.
  74 .RE
  75
  76 .SH EXIT STATUS
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fB0\fR\fR
  81 .ad
  82 .sp .6
  83 .RS 4n
  84 The command completed successfully.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB-1\fR\fR
  91 .ad
  92 .sp .6
  93 .RS 4n
  94 The command exited due to an error.
  95 .RE
  96
  97 .SH ATTRIBUTES
  98 .sp
  99 .LP
 100 See \fBattributes\fR(5) for descriptions of the following attributes:
 101 .sp
 102
 103 .sp
 104 .TS
 105 box;
 106 c | c
 107 l | l .
 108 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 109 _
 110 Interface Stability     Private
 111 .TE
 112
 113 .SH SEE ALSO
 114 .sp
 115 .LP
 116 \fBboot\fR(1M), \fBbootadm\fR(1M), \fBdcfs\fR(7FS), \fBufs\fR(7FS),
 117 \fBattributes\fR(5)
 118 .SH NOTES
 119 .sp
 120 .LP
 121 This compression/decompression utility works only with files stored in a UFS
 122 file system.
 123 .sp
 124 .LP
 125 There is no obvious way to determine whether a given file is compressed, other
 126 than copying the file and comparing the number of disk blocks of the copy
 127 against the original.