1'\" te
2.\" Copyright (c) 2011, Martin Matuska <mm@FreeBSD.org>.
3.\" All Rights Reserved.
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.\"
--- 8 unchanged lines hidden (view full) ---
17.\" fields enclosed by brackets "[]" replaced with your own identifying
18.\" information: Portions Copyright [yyyy] [name of copyright owner]
19.\"
20.\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved.
21.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved.
22.\" Copyright (c) 2011 by Delphix. All rights reserved.
23.\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
24.\"
25.\" $FreeBSD: head/cddl/contrib/opensolaris/cmd/zfs/zfs.8 228055 2011-11-28 09:33:13Z mm $
26.\"
27.Dd November 26, 2011
28.Dt ZFS 8
29.Os
30.Sh NAME
31.Nm zfs
32.Nd configures ZFS file systems
33.Sh SYNOPSIS
--- 9 unchanged lines hidden (view full) ---
43.Op Fl ps
44.Op Fl b Ar blocksize
45.Op Fl o Ar property Ns = Ns Ar value
46.Ar ...
47.Fl V
48.Ar size volume
49.Nm
50.Cm destroy
51.Op Fl rRf
52.Ar filesystem Ns | Ns Ar volume
53.Nm
54.Cm destroy
55.Op Fl rRd
56.Ar snapshot
57.Nm
58.Cm snapshot
59.Op Fl r
60.Op Fl o Ar property Ns = Ns Ar value
61.Ar ... filesystem@snapname Ns | Ns Ar volume@snapname
62.Nm
63.Cm rollback
64.Op Fl rRf
--- 90 unchanged lines hidden (view full) ---
155.Nm
156.Cm share
157.Fl a | Ar filesystem
158.Nm
159.Cm unshare
160.Fl a | Ar filesystem Ns | Ns Ar mountpoint
161.Nm
162.Cm send
163.Op Fl DvRp
164.Op Fl i Ar snapshot | Fl I Ar snapshot
165.Ar snapshot
166.Nm
167.Cm receive
168.Op Fl vnFu
169.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
170.Nm
171.Cm receive
--- 310 unchanged lines hidden (view full) ---
482is the same as the
483.Sy refcompressratio
484property. Compression can be turned on by running:
485.Qq Nm Cm set compression=on Ar dataset
486The default value is
487.Cm off .
488.It Sy creation
489The time this dataset was created.
490.It Sy defer_destroy
491This property is
492.Cm on
493if the snapshot has been marked for deferred destroy by using the
494.Qq Nm Cm destroy -d
495command. Otherwise, the property is
496.Cm off .
497.It Sy mounted
--- 141 unchanged lines hidden (view full) ---
639cannot be changed once the volume has been written, so it should be set at
640volume creation time. The default
641.Ar blocksize
642for volumes is 8 Kbytes. Any
643power of 2 from 512 bytes to 128 Kbytes is valid.
644.Pp
645This property can also be referred to by its shortened column name,
646.Sy volblock .
647.El
648.Pp
649The following native properties can be used to change the behavior of a
650.Tn ZFS
651dataset.
652.Bl -tag -width 2n
653.It Xo
654.Sy aclinherit Ns = Ns Cm discard |
--- 743 unchanged lines hidden (view full) ---
1398options can be specified. An error results if the same property is specified in
1399multiple
1400.Fl o
1401options.
1402.El
1403.It Xo
1404.Nm
1405.Cm destroy
1406.Op Fl rRf
1407.Ar filesystem Ns | Ns Ar volume
1408.Xc
1409.Pp
1410Destroys the given dataset. By default, the command unshares any file systems
1411that are currently shared, unmounts any file systems that are currently
1412mounted, and refuses to destroy a dataset that has active dependents (children
1413or clones).
1414.Bl -tag -width indent
1415.It Fl r
1416Recursively destroy all children.
1417.It Fl R
1418Recursively destroy all dependents, including cloned file systems outside the
1419target hierarchy.
1420.It Fl f
1421Force an unmount of any file systems using the
1422.Qq Nm Cm unmount Fl f
1423command. This option has no effect on non-file systems or unmounted file
1424systems.
1425.El
1426.Pp
1427Extreme care should be taken when applying either the
1428.Fl r
1429or the
1430.Fl R
1431options, as they can destroy large portions of a pool and cause unexpected
1432behavior for mounted file systems in use.
1433.It Xo
1434.Nm
1435.Cm destroy
1436.Op Fl rRd
1437.Ar snapshot
1438.Xc
1439.Pp
1440The given snapshot is destroyed immediately if and only if the
1441.Qq Nm Cm destroy
1442command without the
1443.Fl d
1444option would have destroyed it. Such immediate destruction would occur, for
1445example, if the snapshot had no clones and the user-initiated reference count
1446were zero.
1447.Pp
1448If the snapshot does not qualify for immediate destruction, it is marked for
1449deferred deletion. In this state, it exists as a usable, visible snapshot until
1450both of the preconditions listed above are met, at which point it is destroyed.
1451.Bl -tag -width indent
1452.It Fl r
1453Destroy (or mark for deferred deletion) all snapshots with this name in
1454descendent file systems.
1455.It Fl R
1456Recursively destroy all dependents.
1457.It Fl d
1458Defer snapshot deletion.
1459.El
1460.Pp
1461Extreme care should be taken when applying either the
1462.Fl r
1463or the
1464.Fl R
--- 610 unchanged lines hidden (view full) ---
2075.It Ar filesystem | mountpoint
2076Unshare the specified filesystem. The command can also be given a path to a
2077.Tn ZFS
2078file system shared on the system.
2079.El
2080.It Xo
2081.Nm
2082.Cm send
2083.Op Fl DvRp
2084.Op Fl i Ar snapshot | Fl I Ar snapshot
2085.Ar snapshot
2086.Xc
2087.Pp
2088Creates a stream representation of the last
2089.Ar snapshot
2090argument (not part of
2091.Fl i
--- 54 unchanged lines hidden (view full) ---
2146Generate a deduplicated stream. Blocks which would have been sent multiple
2147times in the send stream will only be sent once. The receiving system must
2148also support this feature to recieve a deduplicated stream. This flag can
2149be used regardless of the dataset's
2150.Sy dedup
2151property, but performance will be much better if the filesystem uses a
2152dedup-capable checksum (eg.
2153.Sy sha256 Ns ).
2154.It Fl p
2155Include the dataset's properties in the stream. This flag is implicit when
2156.Fl R
2157is specified. The receiving system must also support this feature.
2158.It Fl v
2159Print verbose information about the stream package generated.
2160.El
2161.Pp
2162The format of the stream is committed. You will be able to receive your streams
2163on future versions of
2164.Tn ZFS .
2165.It Xo
--- 921 unchanged lines hidden ---
2.\" Copyright (c) 2011, Martin Matuska <mm@FreeBSD.org>.
3.\" All Rights Reserved.
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.\"
--- 8 unchanged lines hidden (view full) ---
17.\" fields enclosed by brackets "[]" replaced with your own identifying
18.\" information: Portions Copyright [yyyy] [name of copyright owner]
19.\"
20.\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved.
21.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved.
22.\" Copyright (c) 2011 by Delphix. All rights reserved.
23.\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
24.\"
25.\" $FreeBSD: head/cddl/contrib/opensolaris/cmd/zfs/zfs.8 228055 2011-11-28 09:33:13Z mm $
26.\"
27.Dd November 26, 2011
28.Dt ZFS 8
29.Os
30.Sh NAME
31.Nm zfs
32.Nd configures ZFS file systems
33.Sh SYNOPSIS
--- 9 unchanged lines hidden (view full) ---
43.Op Fl ps
44.Op Fl b Ar blocksize
45.Op Fl o Ar property Ns = Ns Ar value
46.Ar ...
47.Fl V
48.Ar size volume
49.Nm
50.Cm destroy
51.Op Fl rRf
52.Ar filesystem Ns | Ns Ar volume
53.Nm
54.Cm destroy
55.Op Fl rRd
56.Ar snapshot
57.Nm
58.Cm snapshot
59.Op Fl r
60.Op Fl o Ar property Ns = Ns Ar value
61.Ar ... filesystem@snapname Ns | Ns Ar volume@snapname
62.Nm
63.Cm rollback
64.Op Fl rRf
--- 90 unchanged lines hidden (view full) ---
155.Nm
156.Cm share
157.Fl a | Ar filesystem
158.Nm
159.Cm unshare
160.Fl a | Ar filesystem Ns | Ns Ar mountpoint
161.Nm
162.Cm send
163.Op Fl DvRp
164.Op Fl i Ar snapshot | Fl I Ar snapshot
165.Ar snapshot
166.Nm
167.Cm receive
168.Op Fl vnFu
169.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
170.Nm
171.Cm receive
--- 310 unchanged lines hidden (view full) ---
482is the same as the
483.Sy refcompressratio
484property. Compression can be turned on by running:
485.Qq Nm Cm set compression=on Ar dataset
486The default value is
487.Cm off .
488.It Sy creation
489The time this dataset was created.
490.It Sy defer_destroy
491This property is
492.Cm on
493if the snapshot has been marked for deferred destroy by using the
494.Qq Nm Cm destroy -d
495command. Otherwise, the property is
496.Cm off .
497.It Sy mounted
--- 141 unchanged lines hidden (view full) ---
639cannot be changed once the volume has been written, so it should be set at
640volume creation time. The default
641.Ar blocksize
642for volumes is 8 Kbytes. Any
643power of 2 from 512 bytes to 128 Kbytes is valid.
644.Pp
645This property can also be referred to by its shortened column name,
646.Sy volblock .
647.El
648.Pp
649The following native properties can be used to change the behavior of a
650.Tn ZFS
651dataset.
652.Bl -tag -width 2n
653.It Xo
654.Sy aclinherit Ns = Ns Cm discard |
--- 743 unchanged lines hidden (view full) ---
1398options can be specified. An error results if the same property is specified in
1399multiple
1400.Fl o
1401options.
1402.El
1403.It Xo
1404.Nm
1405.Cm destroy
1406.Op Fl rRf
1407.Ar filesystem Ns | Ns Ar volume
1408.Xc
1409.Pp
1410Destroys the given dataset. By default, the command unshares any file systems
1411that are currently shared, unmounts any file systems that are currently
1412mounted, and refuses to destroy a dataset that has active dependents (children
1413or clones).
1414.Bl -tag -width indent
1415.It Fl r
1416Recursively destroy all children.
1417.It Fl R
1418Recursively destroy all dependents, including cloned file systems outside the
1419target hierarchy.
1420.It Fl f
1421Force an unmount of any file systems using the
1422.Qq Nm Cm unmount Fl f
1423command. This option has no effect on non-file systems or unmounted file
1424systems.
1425.El
1426.Pp
1427Extreme care should be taken when applying either the
1428.Fl r
1429or the
1430.Fl R
1431options, as they can destroy large portions of a pool and cause unexpected
1432behavior for mounted file systems in use.
1433.It Xo
1434.Nm
1435.Cm destroy
1436.Op Fl rRd
1437.Ar snapshot
1438.Xc
1439.Pp
1440The given snapshot is destroyed immediately if and only if the
1441.Qq Nm Cm destroy
1442command without the
1443.Fl d
1444option would have destroyed it. Such immediate destruction would occur, for
1445example, if the snapshot had no clones and the user-initiated reference count
1446were zero.
1447.Pp
1448If the snapshot does not qualify for immediate destruction, it is marked for
1449deferred deletion. In this state, it exists as a usable, visible snapshot until
1450both of the preconditions listed above are met, at which point it is destroyed.
1451.Bl -tag -width indent
1452.It Fl r
1453Destroy (or mark for deferred deletion) all snapshots with this name in
1454descendent file systems.
1455.It Fl R
1456Recursively destroy all dependents.
1457.It Fl d
1458Defer snapshot deletion.
1459.El
1460.Pp
1461Extreme care should be taken when applying either the
1462.Fl r
1463or the
1464.Fl R
--- 610 unchanged lines hidden (view full) ---
2075.It Ar filesystem | mountpoint
2076Unshare the specified filesystem. The command can also be given a path to a
2077.Tn ZFS
2078file system shared on the system.
2079.El
2080.It Xo
2081.Nm
2082.Cm send
2083.Op Fl DvRp
2084.Op Fl i Ar snapshot | Fl I Ar snapshot
2085.Ar snapshot
2086.Xc
2087.Pp
2088Creates a stream representation of the last
2089.Ar snapshot
2090argument (not part of
2091.Fl i
--- 54 unchanged lines hidden (view full) ---
2146Generate a deduplicated stream. Blocks which would have been sent multiple
2147times in the send stream will only be sent once. The receiving system must
2148also support this feature to recieve a deduplicated stream. This flag can
2149be used regardless of the dataset's
2150.Sy dedup
2151property, but performance will be much better if the filesystem uses a
2152dedup-capable checksum (eg.
2153.Sy sha256 Ns ).
2154.It Fl p
2155Include the dataset's properties in the stream. This flag is implicit when
2156.Fl R
2157is specified. The receiving system must also support this feature.
2158.It Fl v
2159Print verbose information about the stream package generated.
2160.El
2161.Pp
2162The format of the stream is committed. You will be able to receive your streams
2163on future versions of
2164.Tn ZFS .
2165.It Xo
--- 921 unchanged lines hidden ---