Print this page
%B


   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 .\" CDDL HEADER END
  21 .\"
  22 .\"
  23 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
  24 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
  25 .\" Copyright (c) 2012 by Delphix. All rights reserved.
  26 .\" Copyright (c) 2012, Joyent, Inc. All rights reserved.
  27 .\" Copyright 2012 Nexenta Systems, Inc. All Rights Reserved.

  28 .\"
  29 .TH ZFS 1M "Sep 16, 2012"
  30 .SH NAME
  31 zfs \- configures ZFS file systems
  32 .SH SYNOPSIS
  33 .LP
  34 .nf
  35 \fBzfs\fR [\fB-?\fR]
  36 .fi
  37 
  38 .LP
  39 .nf
  40 \fBzfs\fR \fBcreate\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR
  41 .fi
  42 
  43 .LP
  44 .nf
  45 \fBzfs\fR \fBcreate\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fB-V\fR \fIsize\fR \fIvolume\fR
  46 .fi
  47 


 895 .ne 2
 896 .na
 897 \fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2\fR | \fBfletcher4\fR |
 898 \fBsha256\fR\fR
 899 .ad
 900 .sp .6
 901 .RS 4n
 902 Controls the checksum used to verify data integrity. The default value is
 903 \fBon\fR, which automatically selects an appropriate algorithm (currently,
 904 \fBfletcher4\fR, but this may change in future releases). The value \fBoff\fR
 905 disables integrity checking on user data. Disabling checksums is \fBNOT\fR a
 906 recommended practice.
 907 .sp
 908 Changing this property affects only newly-written data.
 909 .RE
 910 
 911 .sp
 912 .ne 2
 913 .na
 914 \fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR |
 915 \fBgzip-\fR\fIN\fR | \fBzle\fR\fR
 916 .ad
 917 .sp .6
 918 .RS 4n
 919 Controls the compression algorithm used for this dataset. The \fBlzjb\fR
 920 compression algorithm is optimized for performance while providing decent data
 921 compression. Setting compression to \fBon\fR uses the \fBlzjb\fR compression
 922 algorithm. The \fBgzip\fR compression algorithm uses the same compression as
 923 the \fBgzip\fR(1) command. You can specify the \fBgzip\fR level by using the
 924 value \fBgzip-\fR\fIN\fR where \fIN\fR is an integer from 1 (fastest) to 9
 925 (best compression ratio). Currently, \fBgzip\fR is equivalent to \fBgzip-6\fR
 926 (which is also the default for \fBgzip\fR(1)). The \fBzle\fR compression
 927 algorithm compresses runs of zeros.
 928 .sp











 929 This property can also be referred to by its shortened column name
 930 \fBcompress\fR. Changing this property affects only newly-written data.
 931 .RE
 932 
 933 .sp
 934 .ne 2
 935 .na
 936 \fB\fBcopies\fR=\fB1\fR | \fB2\fR | \fB3\fR\fR
 937 .ad
 938 .sp .6
 939 .RS 4n
 940 Controls the number of copies of data stored for this dataset. These copies are
 941 in addition to any redundancy provided by the pool, for example, mirroring or
 942 RAID-Z. The copies are stored on different disks, if possible. The space used
 943 by multiple copies is charged to the associated file and dataset, changing the
 944 \fBused\fR property and counting against quotas and reservations.
 945 .sp
 946 Changing this property only affects newly-written data. Therefore, set this
 947 property at file system creation time by using the \fB-o\fR
 948 \fBcopies=\fR\fIN\fR option.




   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 .\" CDDL HEADER END
  21 .\"
  22 .\"
  23 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
  24 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
  25 .\" Copyright (c) 2012 by Delphix. All rights reserved.
  26 .\" Copyright (c) 2012, Joyent, Inc. All rights reserved.
  27 .\" Copyright 2012 Nexenta Systems, Inc. All Rights Reserved.
  28 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  29 .\"
  30 .TH ZFS 1M "Sep 16, 2012"
  31 .SH NAME
  32 zfs \- configures ZFS file systems
  33 .SH SYNOPSIS
  34 .LP
  35 .nf
  36 \fBzfs\fR [\fB-?\fR]
  37 .fi
  38 
  39 .LP
  40 .nf
  41 \fBzfs\fR \fBcreate\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR
  42 .fi
  43 
  44 .LP
  45 .nf
  46 \fBzfs\fR \fBcreate\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fB-V\fR \fIsize\fR \fIvolume\fR
  47 .fi
  48 


 896 .ne 2
 897 .na
 898 \fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2\fR | \fBfletcher4\fR |
 899 \fBsha256\fR\fR
 900 .ad
 901 .sp .6
 902 .RS 4n
 903 Controls the checksum used to verify data integrity. The default value is
 904 \fBon\fR, which automatically selects an appropriate algorithm (currently,
 905 \fBfletcher4\fR, but this may change in future releases). The value \fBoff\fR
 906 disables integrity checking on user data. Disabling checksums is \fBNOT\fR a
 907 recommended practice.
 908 .sp
 909 Changing this property affects only newly-written data.
 910 .RE
 911 
 912 .sp
 913 .ne 2
 914 .na
 915 \fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR |
 916 \fBgzip-\fR\fIN\fR | \fBzle\fR\fR | \fBlz4\fR | \fBlz4hc\fR
 917 .ad
 918 .sp .6
 919 .RS 4n
 920 Controls the compression algorithm used for this dataset. The \fBlzjb\fR
 921 compression algorithm is optimized for performance while providing decent data
 922 compression. Setting compression to \fBon\fR uses the \fBlzjb\fR compression
 923 algorithm. The \fBgzip\fR compression algorithm uses the same compression as
 924 the \fBgzip\fR(1) command. You can specify the \fBgzip\fR level by using the
 925 value \fBgzip-\fR\fIN\fR where \fIN\fR is an integer from 1 (fastest) to 9
 926 (best compression ratio). Currently, \fBgzip\fR is equivalent to \fBgzip-6\fR
 927 (which is also the default for \fBgzip\fR(1)). The \fBzle\fR compression
 928 algorithm compresses runs of zeros.
 929 .sp
 930 The \fBlz4\fR compression algorithm is a high-performance replacement
 931 for the \fBlzjb\fR algorithm. It features significantly faster
 932 compression and decompression, as well as a moderately higher
 933 compression ratio than \fBlzjb\fR, but can only be used on pools with
 934 the \fBlz4_compress\fR feature set to \fIenabled\fR. See
 935 \fBzpool-features\fR(5) for details on ZFS feature flags and the
 936 \fBlz4_compress\fR feature. The \fBlz4hc\fR algorithm is a
 937 high-compression variant of \fBlz4\fR. It provides compression ratios
 938 and compression speeds comparable to gzip, but much faster decompression
 939 (same as \fBlz4\fR).
 940 .sp
 941 This property can also be referred to by its shortened column name
 942 \fBcompress\fR. Changing this property affects only newly-written data.
 943 .RE
 944 
 945 .sp
 946 .ne 2
 947 .na
 948 \fB\fBcopies\fR=\fB1\fR | \fB2\fR | \fB3\fR\fR
 949 .ad
 950 .sp .6
 951 .RS 4n
 952 Controls the number of copies of data stored for this dataset. These copies are
 953 in addition to any redundancy provided by the pool, for example, mirroring or
 954 RAID-Z. The copies are stored on different disks, if possible. The space used
 955 by multiple copies is charged to the associated file and dataset, changing the
 956 \fBused\fR property and counting against quotas and reservations.
 957 .sp
 958 Changing this property only affects newly-written data. Therefore, set this
 959 property at file system creation time by using the \fB-o\fR
 960 \fBcopies=\fR\fIN\fR option.