diff options
Diffstat (limited to 'usr/src/man')
-rw-r--r-- | usr/src/man/man1m/zfs.1m | 116 | ||||
-rw-r--r-- | usr/src/man/man5/zpool-features.5 | 31 |
2 files changed, 123 insertions, 24 deletions
diff --git a/usr/src/man/man1m/zfs.1m b/usr/src/man/man1m/zfs.1m index e468053a7a..ff3f53ef01 100644 --- a/usr/src/man/man1m/zfs.1m +++ b/usr/src/man/man1m/zfs.1m @@ -22,7 +22,7 @@ .\" .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved. .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org> -.\" Copyright (c) 2012 by Delphix. All rights reserved. +.\" Copyright (c) 2013 by Delphix. All rights reserved. .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved. .\" Copyright 2013 Nexenta Systems, Inc. All Rights Reserved. .\" Copyright (c) 2013, Joyent, Inc. All rights reserved. @@ -58,6 +58,11 @@ zfs \- configures ZFS file systems .LP .nf +\fBzfs\fR \fBdestroy\fR \fIfilesystem\fR|\fIvolume\fR#\fIbookmark\fR +.fi + +.LP +.nf \fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fIfilesystem@snapname\fR|\fIvolume@snapname\fR... .fi @@ -165,11 +170,21 @@ zfs \- configures ZFS file systems .LP .nf +\fBzfs\fR \fBbookmark\fR \fIsnapshot\fR \fIbookmark\fR +.fi + +.LP +.nf \fBzfs\fR \fBsend\fR [\fB-DnPpRrv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR .fi .LP .nf +\fBzfs\fR \fBsend\fR [\fB-i \fIsnapshot\fR|\fIbookmark\fR]\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR +.fi + +.LP +.nf \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR .fi @@ -1906,6 +1921,17 @@ behavior for mounted file systems in use. .sp .ne 2 .na +\fBzfs destroy\fR \fIfilesystem\fR|\fIvolume\fR#\fIbookmark\fR +.ad +.sp .6 +.RS 4n +The given bookmark is destroyed. + +.RE + +.sp +.ne 2 +.na \fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR... .ad @@ -1948,13 +1974,13 @@ Roll back the given dataset to a previous snapshot. When a dataset is rolled back, all data that has changed since the snapshot is discarded, and the dataset reverts to the state at the time of the snapshot. By default, the command refuses to roll back to a snapshot other than the most recent one. In -order to do so, all intermediate snapshots must be destroyed by specifying the -\fB-r\fR option. +order to do so, all intermediate snapshots and bookmarks must be destroyed +by specifying the \fB-r\fR option. .sp The \fB-rR\fR options do not recursively destroy the child snapshots of a -recursive snapshot. Only the top-level recursive snapshot is destroyed by -either of these options. To completely roll back a recursive snapshot, you must -rollback the individual child snapshots. +recursive snapshot. Only direct snapshots of the specified filesystem +are destroyed by either of these options. To completely roll back a +recursive snapshot, you must rollback the individual child snapshots. .sp .ne 2 .na @@ -1962,7 +1988,7 @@ rollback the individual child snapshots. .ad .sp .6 .RS 4n -Recursively destroy any snapshots more recent than the one specified. +Destroy any snapshots and bookmarks more recent than the one specified. .RE .sp @@ -1972,7 +1998,7 @@ Recursively destroy any snapshots more recent than the one specified. .ad .sp .6 .RS 4n -Recursively destroy any more recent snapshots, as well as any clones of those +Destroy any more recent snapshots and bookmarks, as well as any clones of those snapshots. .RE @@ -2260,8 +2286,8 @@ Same as the \fB-s\fR option, but sorts by property in descending order. .sp .6 .RS 4n A comma-separated list of types to display, where \fItype\fR is one of -\fBfilesystem\fR, \fBsnapshot\fR , \fBvolume\fR, or \fBall\fR. For example, -specifying \fB-t snapshot\fR displays only snapshots. +\fBfilesystem\fR, \fBsnapshot\fR , \fBvolume\fR, \fBbookmark\fR, or \fBall\fR. +For example, specifying \fB-t snapshot\fR displays only snapshots. .RE .sp @@ -2324,7 +2350,7 @@ the \fB-o\fR option. This command takes a comma-separated list of properties as described in the "Native Properties" and "User Properties" sections. .sp The special value \fBall\fR can be used to display all properties that apply to -the given dataset's type (filesystem, volume, or snapshot). +the given dataset's type (filesystem, volume, snapshot, or bookmark). .sp .ne 2 .na @@ -2816,6 +2842,24 @@ Unshare the specified filesystem. The command can also be given a path to a .sp .ne 2 .na +\fB\fBzfs bookmark\fR \fIsnapshot\fR \fIbookmark\fR\fR +.ad +.sp .6 +.RS 4n +Creates a bookmark of the given snapshot. Bookmarks mark the point in time +when the snapshot was created, and can be used as the incremental source for +a \fBzfs send\fR command. +.sp +This feature must be enabled to be used. +See \fBzpool-features\fR(5) for details on ZFS feature flags and the +\fBbookmarks\fR feature. +.RE + + +.RE +.sp +.ne 2 +.na \fBzfs send\fR [\fB-DnPpRrv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR .ad .sp .6 @@ -2831,11 +2875,11 @@ generated. .ad .sp .6 .RS 4n -Generate an incremental stream from the first \fIsnapshot\fR to the second -\fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be -specified as the last component of the snapshot name (for example, the part -after the \fB@\fR), and it is assumed to be from the same file system as the -second \fIsnapshot\fR. +Generate an incremental stream from the first \fIsnapshot\fR +(the incremental source) to the second \fIsnapshot\fR (the incremental target). +The incremental source can be specified as the last component of the +snapshot name (the \fB@\fR character and following) and +it is assumed to be from the same file system as the incremental target. .sp If the destination is a clone, the source may be the origin snapshot, which must be fully specified (for example, \fBpool/fs@origin\fR, not just @@ -2850,9 +2894,9 @@ must be fully specified (for example, \fBpool/fs@origin\fR, not just .sp .6 .RS 4n Generate a stream package that sends all intermediary snapshots from the first -snapshot to the second snapshot. For example, \fB-I @a fs@d\fR is similar to -\fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR. The incremental source snapshot may -be specified as with the \fB-i\fR option. +snapshot to the second snapshot. For example, \fB-I @a fs@d\fR is +similar to \fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR. The incremental +source may be specified as with the \fB-i\fR option. .RE .sp @@ -2949,6 +2993,40 @@ The format of the stream is committed. You will be able to receive your streams on future versions of \fBZFS\fR. .RE +.RE +.sp +.ne 2 +.na +\fBzfs send\fR [\fB-i\fR \fIsnapshot\fR|\fIbookmark\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR +.ad +.sp .6 +.RS 4n +Generate a send stream, which may be of a filesystem, and may be +incremental from a bookmark. If the destination is a filesystem or volume, +the pool must be read-only, or the filesystem must not be mounted. When the +stream generated from a filesystem or volume is received, the default snapshot +name will be "--head--". + +.sp +.ne 2 +.na +\fB-i\fR \fIsnapshot\fR|\fIbookmark\fR +.ad +.sp .6 +.RS 4n +Generate an incremental send stream. The incremental source must be an earlier +snapshot in the destination's history. It will commonly be an earlier +snapshot in the destination's filesystem, in which case it can be +specified as the last component of the name (the \fB#\fR or \fB@\fR character +and following). +.sp +If the incremental target is a clone, the incremental source can +be the origin snapshot, or an earlier snapshot in the origin's filesystem, +or the origin's origin, etc. +.RE + +.RE + .sp .ne 2 .na diff --git a/usr/src/man/man5/zpool-features.5 b/usr/src/man/man5/zpool-features.5 index 4df496d0ad..58ec7ab7dc 100644 --- a/usr/src/man/man5/zpool-features.5 +++ b/usr/src/man/man5/zpool-features.5 @@ -224,11 +224,11 @@ When the \fBlz4_compress\fR feature is set to \fBenabled\fR, the administrator can turn on \fBlz4\fR compression on any dataset on the pool using the \fBzfs\fR(1M) command. Please note that doing so will immediately activate the \fBlz4_compress\fR feature on the underlying -pool (even before any data is written). Since this feature is not -read-only compatible, this operation will render the pool unimportable -on systems without support for the \fBlz4_compress\fR feature. At the -moment, this operation cannot be reversed. Booting off of -\fBlz4\fR-compressed root pools is supported. +pool (even before any data is written), and the feature will not be +deactivated. Since this feature is not read-only compatible, this +operation will render the pool unimportable on systems without support +for the \fBlz4_compress\fR feature. Booting off of \fBlz4\fR-compressed +root pools is supported. .RE .sp @@ -298,6 +298,27 @@ this feature are destroyed. .sp .ne 2 .na +\fB\fBbookmarks\fR\fR +.ad +.RS 4n +.TS +l l . +GUID com.delphix:bookmarks +READ\-ONLY COMPATIBLE yes +DEPENDENCIES extensible_dataset +.TE + +This feature enables use of the \fBzfs bookmark\fR subcommand. + +This feature is \fBactive\fR while any bookmarks exist in the pool. +All bookmarks in the pool can be listed by running +\fBzfs list -t bookmark -r \fIpoolname\fR\fR. + +.RE + +.sp +.ne 2 +.na \fB\fBenabled_txg\fR\fR .ad .RS 4n |