]> git.proxmox.com Git - mirror_zfs.git/blobdiff - man/man8/zfs-program.8
zfs.8 has wrong description of "zfs program -t"
[mirror_zfs.git] / man / man8 / zfs-program.8
index b1d937b6e600426b3f2034667a685313558e8b7f..bc2c10fdc131e9481e4286b7c03693c9985efd5f 100644 (file)
@@ -8,7 +8,7 @@
 .\" http://www.illumos.org/license/CDDL.
 .\"
 .\"
-.\" Copyright (c) 2016, 2017 by Delphix. All Rights Reserved.
+.\" Copyright (c) 2016, 2019 by Delphix. All Rights Reserved.
 .\"
 .Dd January 21, 2016
 .Dt ZFS-PROGRAM 8
@@ -17,7 +17,8 @@
 .Nm zfs program
 .Nd executes ZFS channel programs
 .Sh SYNOPSIS
-.Cm zfs program
+.Cm "zfs program"
+.Op Fl jn
 .Op Fl t Ar instruction-limit
 .Op Fl m Ar memory-limit
 .Ar pool
@@ -45,8 +46,20 @@ will be run on
 and any attempts to access or modify other pools will cause an error.
 .Sh OPTIONS
 .Bl -tag -width "-t"
+.It Fl j
+Display channel program output in JSON format. When this flag is specified and
+standard output is empty - channel program encountered an error. The details of
+such an error will be printed to standard error in plain text.
+.It Fl n
+Executes a read-only channel program, which runs faster.
+The program cannot change on-disk state by calling functions from the
+zfs.sync submodule.
+The program can be used to gather information such as properties and
+determining if changes would succeed (zfs.check.*).
+Without this flag, all pending changes must be synced to disk before a
+channel program can complete.
 .It Fl t Ar instruction-limit
-Execution time limit, in number of Lua instructions to execute.
+Limit the number of Lua instructions to execute.
 If a channel program executes more than the specified number of instructions,
 it will be stopped and an error will be returned.
 The default limit is 10 million instructions, and it can be set to a maximum of