1 '\" te
   2 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright (c) 2012 by Delphix. All rights reserved.
   4 .\" Copyright (c) 2012 Nexenta Systems, Inc. All Rights Reserved.
   5 .\" Copyright (c) 2012, Joyent, Inc. All rights reserved.
   6 .\" 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.
   7 .\"  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
   8 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   9 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
  10 .TH ZFS 1M "28 Jul 2011"
  11 .SH NAME
  12 zfs \- configures ZFS file systems
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBzfs\fR [\fB-?\fR]
  17 .fi
  18 
  19 .LP
  20 .nf
  21 \fBzfs\fR \fBcreate\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR
  22 .fi
  23 
  24 .LP

 127 \fBzfs\fR \fBmount\fR [\fB-vO\fR] [\fB-o \fIoptions\fR\fR] \fB-a\fR | \fIfilesystem\fR
 128 .fi
 129 
 130 .LP
 131 .nf
 132 \fBzfs\fR \fBunmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR
 133 .fi
 134 
 135 .LP
 136 .nf
 137 \fBzfs\fR \fBshare\fR \fB-a\fR | \fIfilesystem\fR
 138 .fi
 139 
 140 .LP
 141 .nf
 142 \fBzfs\fR \fBunshare\fR \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
 143 .fi
 144 
 145 .LP
 146 .nf
 147 \fBzfs\fR \fBsend\fR [\fB-DnPpRrv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
 148 .fi
 149 
 150 .LP
 151 .nf
 152 \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
 153 .fi
 154 
 155 .LP
 156 .nf
 157 \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR
 158 .fi
 159 
 160 .LP
 161 .nf
 162 \fBzfs\fR \fBallow\fR \fIfilesystem\fR|\fIvolume\fR
 163 .fi
 164 
 165 .LP
 166 .nf
 167 \fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...]

2703 Unshare all available \fBZFS\fR file systems. Invoked automatically as part of
2704 the boot process.
2705 .RE
2706 
2707 .sp
2708 .ne 2
2709 .na
2710 \fB\fIfilesystem\fR|\fImountpoint\fR\fR
2711 .ad
2712 .sp .6
2713 .RS 4n
2714 Unshare the specified filesystem. The command can also be given a path to a
2715 \fBZFS\fR file system shared on the system.
2716 .RE
2717 
2718 .RE
2719 
2720 .sp
2721 .ne 2
2722 .na
2723 \fBzfs send\fR [\fB-DnPpRrv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
2724 .ad
2725 .sp .6
2726 .RS 4n
2727 Creates a stream representation of the second \fIsnapshot\fR, which is written
2728 to standard output. The output can be redirected to a file or to a different
2729 system (for example, using \fBssh\fR(1). By default, a full stream is
2730 generated.
2731 .sp
2732 .ne 2
2733 .na
2734 \fB\fB-i\fR \fIsnapshot\fR\fR
2735 .ad
2736 .sp .6
2737 .RS 4n
2738 Generate an incremental stream from the first \fIsnapshot\fR to the second
2739 \fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be
2740 specified as the last component of the snapshot name (for example, the part
2741 after the \fB@\fR), and it is assumed to be from the same file system as the
2742 second \fIsnapshot\fR.
2743 .sp

2811 \fB\fB-p\fR\fR
2812 .ad
2813 .sp .6
2814 .RS 4n
2815 Include the dataset's properties in the stream.  This flag is implicit when
2816 \fB-R\fR is specified.  The receiving system must also support this feature.
2817 .RE
2818 
2819 .sp
2820 .ne 2
2821 .na
2822 \fB\fB-n\fR\fR
2823 .ad
2824 .sp .6
2825 .RS 4n
2826 Do a dry-run ("No-op") send.  Do not generate any actual send data.  This is
2827 useful in conjunction with the \fB-v\fR or \fB-P\fR flags to determine what
2828 data will be sent.
2829 .RE
2830 













2831 .sp
2832 .ne 2
2833 .na
2834 \fB\fB-P\fR\fR
2835 .ad
2836 .sp .6
2837 .RS 4n
2838 Print machine-parsable verbose information about the stream package generated.
2839 .RE
2840 
2841 .sp
2842 .ne 2
2843 .na
2844 \fB\fB-v\fR\fR
2845 .ad
2846 .sp .6
2847 .RS 4n
2848 Print verbose information about the stream package generated.  This information
2849 includes a per-second report of how much data has been sent.
2850 .RE

   1 '\" te
   2 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright (c) 2012 by Delphix. All rights reserved.
   4 .\" Copyright 2012 Nexenta Systems, Inc. All Rights Reserved.
   5 .\" Copyright (c) 2012, Joyent, Inc. All rights reserved.
   6 .\" 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.
   7 .\"  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
   8 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   9 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
  10 .TH ZFS 1M "28 Jul 2011"
  11 .SH NAME
  12 zfs \- configures ZFS file systems
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBzfs\fR [\fB-?\fR]
  17 .fi
  18 
  19 .LP
  20 .nf
  21 \fBzfs\fR \fBcreate\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR
  22 .fi
  23 
  24 .LP

 127 \fBzfs\fR \fBmount\fR [\fB-vO\fR] [\fB-o \fIoptions\fR\fR] \fB-a\fR | \fIfilesystem\fR
 128 .fi
 129 
 130 .LP
 131 .nf
 132 \fBzfs\fR \fBunmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR
 133 .fi
 134 
 135 .LP
 136 .nf
 137 \fBzfs\fR \fBshare\fR \fB-a\fR | \fIfilesystem\fR
 138 .fi
 139 
 140 .LP
 141 .nf
 142 \fBzfs\fR \fBunshare\fR \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
 143 .fi
 144 
 145 .LP
 146 .nf
 147 \fBzfs\fR \fBsend\fR [\fB-DnPpRrvs\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
 148 .fi
 149 
 150 .LP
 151 .nf
 152 \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
 153 .fi
 154 
 155 .LP
 156 .nf
 157 \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR
 158 .fi
 159 
 160 .LP
 161 .nf
 162 \fBzfs\fR \fBallow\fR \fIfilesystem\fR|\fIvolume\fR
 163 .fi
 164 
 165 .LP
 166 .nf
 167 \fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...]

2703 Unshare all available \fBZFS\fR file systems. Invoked automatically as part of
2704 the boot process.
2705 .RE
2706 
2707 .sp
2708 .ne 2
2709 .na
2710 \fB\fIfilesystem\fR|\fImountpoint\fR\fR
2711 .ad
2712 .sp .6
2713 .RS 4n
2714 Unshare the specified filesystem. The command can also be given a path to a
2715 \fBZFS\fR file system shared on the system.
2716 .RE
2717 
2718 .RE
2719 
2720 .sp
2721 .ne 2
2722 .na
2723 \fBzfs send\fR [\fB-DnPpRrvs\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
2724 .ad
2725 .sp .6
2726 .RS 4n
2727 Creates a stream representation of the second \fIsnapshot\fR, which is written
2728 to standard output. The output can be redirected to a file or to a different
2729 system (for example, using \fBssh\fR(1). By default, a full stream is
2730 generated.
2731 .sp
2732 .ne 2
2733 .na
2734 \fB\fB-i\fR \fIsnapshot\fR\fR
2735 .ad
2736 .sp .6
2737 .RS 4n
2738 Generate an incremental stream from the first \fIsnapshot\fR to the second
2739 \fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be
2740 specified as the last component of the snapshot name (for example, the part
2741 after the \fB@\fR), and it is assumed to be from the same file system as the
2742 second \fIsnapshot\fR.
2743 .sp

2811 \fB\fB-p\fR\fR
2812 .ad
2813 .sp .6
2814 .RS 4n
2815 Include the dataset's properties in the stream.  This flag is implicit when
2816 \fB-R\fR is specified.  The receiving system must also support this feature.
2817 .RE
2818 
2819 .sp
2820 .ne 2
2821 .na
2822 \fB\fB-n\fR\fR
2823 .ad
2824 .sp .6
2825 .RS 4n
2826 Do a dry-run ("No-op") send.  Do not generate any actual send data.  This is
2827 useful in conjunction with the \fB-v\fR or \fB-P\fR flags to determine what
2828 data will be sent.
2829 .RE
2830 
2831 .sp
2832 .ne 2
2833 .na
2834 \fB\fB-s\fR\fR
2835 .ad
2836 .sp .6
2837 .RS 4n
2838 Calculate send stream size.  Do not generate any actual send data.  This is
2839 useful when one needs to know stream size in order to store the stream externally. 
2840 With \fB-v\fR specified, provides info on stream header and stream data portion 
2841 sizes, in addition to the total stream size.
2842 .RE
2843 
2844 .sp
2845 .ne 2
2846 .na
2847 \fB\fB-P\fR\fR
2848 .ad
2849 .sp .6
2850 .RS 4n
2851 Print machine-parsable verbose information about the stream package generated.
2852 .RE
2853 
2854 .sp
2855 .ne 2
2856 .na
2857 \fB\fB-v\fR\fR
2858 .ad
2859 .sp .6
2860 .RS 4n
2861 Print verbose information about the stream package generated.  This information
2862 includes a per-second report of how much data has been sent.
2863 .RE