]> granicus.if.org Git - zfs/blobdiff - man/man8/zfs.8
Fix for ARC sysctls ignored at runtime
[zfs] / man / man8 / zfs.8
index 0a23466b7f99e97eeb889dc1feff553645287a7e..e391b981062976d6fbcf7eaaf77e4bcf5715cf1a 100644 (file)
@@ -28,9 +28,9 @@
 .\" Copyright (c) 2014 Integros [integros.com]
 .\" Copyright 2019 Richard Laager. All rights reserved.
 .\" Copyright 2018 Nexenta Systems, Inc.
-.\" Copyright 2018 Joyent, Inc.
+.\" Copyright 2019 Joyent, Inc.
 .\"
-.Dd April 30, 2019
+.Dd June 30, 2019
 .Dt ZFS 8 SMM
 .Os Linux
 .Sh NAME
 .Fl ?V
 .Nm
 .Cm create
-.Op Fl p
+.Op Fl Pnpv
 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
 .Ar filesystem
 .Nm
 .Cm create
-.Op Fl ps
+.Op Fl Pnpsv
 .Op Fl b Ar blocksize
 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
 .Fl V Ar size Ar volume
 .Fl a | Ar filesystem
 .Nm
 .Cm unmount
-.Op Fl f
+.Op Fl fu
 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
 .Nm
 .Cm share
 .Nm
 .Cm redact
 .Ar snapshot redaction_bookmark
-.Op Ar redaction_snapshot Ns ...
+.Ar redaction_snapshot Ns ...
 .Nm
 .Cm allow
 .Ar filesystem Ns | Ns Ar volume
 .Op Fl t Ar instruction-limit
 .Op Fl m Ar memory-limit
 .Ar pool script
-.Op Ar arg1 No ...
+.Op --
+.Ar arg1 No ...
 .Nm
 .Cm load-key
 .Op Fl nr
@@ -737,7 +738,7 @@ of a dataset is not transferred to other pools when the snapshot is copied
 with a send/receive operation.
 The
 .Sy objsetid
-can be reused (for a new datatset) after the dataset is deleted.
+can be reused (for a new dataset) after the dataset is deleted.
 .It Sy origin
 For cloned file systems or volumes, the snapshot from which the clone was
 created.
@@ -1396,7 +1397,7 @@ has the same effect as the setting
 .Pp
 If set to
 .Sy verify ,
-ZFS will do a byte-to-byte comparsion in case of two blocks having the same
+ZFS will do a byte-to-byte comparison in case of two blocks having the same
 signature to make sure the block contents are identical. Specifying
 .Sy verify
 is mandatory for the
@@ -1992,7 +1993,7 @@ If the property is set to
 .Sy on ,
 the dataset is shared using the default options:
 .Pp
-.Em sec=sys,rw,crossmnt,no_subtree_check,no_root_squash
+.Em sec=sys,rw,crossmnt,no_subtree_check
 .Pp
 See
 .Xr exports 5
@@ -2145,7 +2146,7 @@ Setting it to
 hides its partitions.
 Volumes with property set to
 .Sy none
-are not exposed outside ZFS, but can be snapshoted, cloned, replicated, etc,
+are not exposed outside ZFS, but can be snapshotted, cloned, replicated, etc,
 that can be suitable for backup purposes.
 Value
 .Sy default
@@ -2556,7 +2557,7 @@ subcommand.
 .It Xo
 .Nm
 .Cm create
-.Op Fl p
+.Op Fl Pnpv
 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
 .Ar filesystem
 .Xc
@@ -2585,6 +2586,48 @@ Any property specified on the command line using the
 .Fl o
 option is ignored.
 If the target filesystem already exists, the operation completes successfully.
+.It Fl n
+Do a dry-run
+.Pq Qq No-op
+creation.
+No datasets will be created.
+This is useful in conjunction with the
+.Fl v
+or
+.Fl P
+flags to validate properties that are passed via
+.Fl o
+options and those implied by other options.
+The actual dataset creation can still fail due to insufficient privileges or
+available capacity.
+.It Fl P
+Print machine-parsable verbose information about the created dataset.
+Each line of output contains a key and one or two values, all separated by tabs.
+The
+.Sy create_ancestors
+and 
+.Sy create
+keys have
+.Em filesystem
+as their only value.
+The
+.Sy create_ancestors
+key only appears if the
+.Fl p
+option is used.
+The
+.Sy property
+key has two values, a property name that property's value.
+The
+.Sy property
+key may appear zero or more times, once for each property that will be set local
+to
+.Em filesystem
+due to the use of the
+.Fl o
+option.
+.It Fl v
+Print verbose information about the created dataset.
 .El
 .It Xo
 .Nm
@@ -2641,6 +2684,52 @@ See
 in the
 .Sx Native Properties
 section for more information about sparse volumes.
+.It Fl n
+Do a dry-run
+.Pq Qq No-op
+creation.
+No datasets will be created.
+This is useful in conjunction with the
+.Fl v
+or
+.Fl P
+flags to validate properties that are passed via
+.Fl o
+options and those implied by other options.
+The actual dataset creation can still fail due to insufficient privileges or
+available capacity.
+.It Fl P
+Print machine-parsable verbose information about the created dataset.
+Each line of output contains a key and one or two values, all separated by tabs.
+The
+.Sy create_ancestors
+and 
+.Sy create
+keys have
+.Em volume
+as their only value.
+The
+.Sy create_ancestors
+key only appears if the
+.Fl p
+option is used.
+The
+.Sy property
+key has two values, a property name that property's value.
+The
+.Sy property
+key may appear zero or more times, once for each property that will be set local
+to
+.Em volume
+due to the use of the
+.Fl b
+or
+.Fl o
+options, as well as
+.Sy refreservation
+if the volume is not sparse.
+.It Fl v
+Print verbose information about the created dataset.
 .El
 .It Xo
 .Nm
@@ -3328,7 +3417,7 @@ for types.
 List project identifier (ID) and inherit flag of file(s) or directories.
 .Bl -tag -width "-d"
 .It Fl d
-Show the directory project ID and inherit flag, not its childrens. It will
+Show the directory project ID and inherit flag, not its children. It will
 overwrite the former specified
 .Fl r
 option.
@@ -3371,7 +3460,7 @@ option) value or the target directory's project ID.
 Print file name with a trailing NUL instead of newline (by default), like
 "find -print0".
 .It Fl d
-Check the directory project ID and inherit flag, not its childrens. It will
+Check the directory project ID and inherit flag, not its children. It will
 overwrite the former specified
 .Fl r
 option.
@@ -3462,7 +3551,7 @@ Attempt to force mounting of all filesystems, even those that couldn't normally
 .It Xo
 .Nm
 .Cm unmount
-.Op Fl f
+.Op Fl fu
 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
 .Xc
 Unmounts currently mounted ZFS file systems.
@@ -3470,13 +3559,15 @@ Unmounts currently mounted ZFS file systems.
 .It Fl a
 Unmount all available ZFS file systems.
 Invoked automatically as part of the shutdown process.
+.It Fl f
+Forcefully unmount the file system, even if it is currently in use.
+.It Fl u
+Unload keys for any encryption roots unmounted by this command.
+.El
 .It Ar filesystem Ns | Ns Ar mountpoint
 Unmount the specified filesystem.
 The command can also be given a path to a ZFS file system mount point on the
 system.
-.It Fl f
-Forcefully unmount the file system, even if it is currently in use.
-.El
 .It Xo
 .Nm
 .Cm share
@@ -3932,7 +4023,7 @@ This will either produce a normal snapshot or a redacted one, depending on
 whether the new send stream is redacted.
 .sp
 4. To receive an incremental send from a redacted version of the initial
-snapshot that is redacted with respect to a subect of the set of snapshots the
+snapshot that is redacted with respect to a subject of the set of snapshots the
 initial snapshot was created with respect to.
 A send stream from a compatible redacted dataset will contain all of the blocks
 necessary to fill in any redacted data.
@@ -3947,7 +4038,7 @@ on whether the full send stream was redacted.
 .sp
 These restrictions are detected and enforced by \fBzfs receive\fR; a
 redacted send stream will contain the list of snapshots that the stream is
-redacted with respsect to.
+redacted with respect to.
 These are stored with the redacted snapshot, and are used to detect and
 correctly handle the cases above.  Note that for technical reasons, raw sends
 and redacted sends cannot be combined at this time.
@@ -4272,7 +4363,7 @@ deleting its saved partially received state.
 .Nm
 .Cm redact
 .Ar snapshot redaction_bookmark
-.Op Ar redaction_snapshot Ns ...
+.Ar redaction_snapshot Ns ...
 .Xc
 Generate a new redaction bookmark.
 In addition to the typical bookmark information, a redaction bookmark contains
@@ -4666,7 +4757,8 @@ Display the path's inode change time as the first column of output.
 .Op Fl t Ar instruction-limit
 .Op Fl m Ar memory-limit
 .Ar pool script
-.Op Ar arg1 No ...
+.Op --
+.Ar arg1 No ...
 .Xc
 Executes
 .Ar script