6 .\" You may not use this file except in compliance with the License.
7 .\"
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 .\" or http://www.opensolaris.org/os/licensing.
10 .\" See the License for the specific language governing permissions
11 .\" and limitations under the License.
12 .\"
13 .\" When distributing Covered Code, include this CDDL HEADER in each
14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 .\" If applicable, add the following below this CDDL HEADER, with the
16 .\" fields enclosed by brackets "[]" replaced with your own identifying
17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
18 .\"
19 .\" CDDL HEADER END
20 .\"
21 .\"
22 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24 .\" Copyright (c) 2011, 2016 by Delphix. All rights reserved.
25 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
28 .\" Copyright (c) 2014 Integros [integros.com]
29 .\" Copyright 2018 Nexenta Systems, Inc.
30 .\" Copyright 2018 Joyent, Inc.
31 .\" Copyright (c) 2018 Datto Inc.
32 .\"
33 .Dd Jan 05, 2019
34 .Dt ZFS 1M
35 .Os
36 .Sh NAME
37 .Nm zfs
38 .Nd configures ZFS file systems
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl \?
42 .Nm
43 .Cm create
44 .Op Fl p
45 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
46 .Ar filesystem
47 .Nm
48 .Cm create
49 .Op Fl ps
50 .Op Fl b Ar blocksize
51 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
52 .Fl V Ar size Ar volume
53 .Nm
3479 .Op Fl jn
3480 .Op Fl t Ar timeout
3481 .Op Fl m Ar memory_limit
3482 .Ar pool script
3483 .Op Ar arg1 No ...
3484 .Xc
3485 Executes
3486 .Ar script
3487 as a ZFS channel program on
3488 .Ar pool .
3489 The ZFS channel
3490 program interface allows ZFS administrative operations to be run
3491 programmatically via a Lua script.
3492 The entire script is executed atomically, with no other administrative
3493 operations taking effect concurrently.
3494 A library of ZFS calls is made available to channel program scripts.
3495 Channel programs may only be run with root privileges.
3496 .sp
3497 For full documentation of the ZFS channel program interface, see the manual
3498 page for
3499 .Bl -tag -width ""
3500 .It Fl j
3501 Display channel program output in JSON format.
3502 When this flag is specified and standard output is empty -
3503 channel program encountered an error.
3504 The details of such an error will be printed to standard error in plain text.
3505 .It Fl n
3506 Executes a read-only channel program, which runs faster.
3507 The program cannot change on-disk state by calling functions from
3508 the zfs.sync submodule.
3509 The program can be used to gather information such as properties and
3510 determining if changes would succeed (zfs.check.*).
3511 Without this flag, all pending changes must be synced to disk before
3512 a channel program can complete.
3513 .It Fl t Ar timeout
3514 Execution time limit, in milliseconds.
3515 If a channel program executes for longer than the provided timeout, it will
3516 be stopped and an error will be returned.
3517 The default timeout is 1000 ms, and can be set to a maximum of 10000 ms.
3518 .It Fl m Ar memory-limit
3904 option is used to indicate type information for the files affected.
3905 .Bd -literal
3906 # zfs diff -F tank/test@before tank/test
3907 M / /tank/test/
3908 M F /tank/test/linked (+1)
3909 R F /tank/test/oldname -> /tank/test/newname
3910 - F /tank/test/deleted
3911 + F /tank/test/created
3912 M F /tank/test/modified
3913 .Ed
3914 .El
3915 .Sh INTERFACE STABILITY
3916 .Sy Committed .
3917 .Sh SEE ALSO
3918 .Xr gzip 1 ,
3919 .Xr ssh 1 ,
3920 .Xr mount 1M ,
3921 .Xr share 1M ,
3922 .Xr sharemgr 1M ,
3923 .Xr unshare 1M ,
3924 .Xr zonecfg 1M ,
3925 .Xr zpool 1M ,
3926 .Xr chmod 2 ,
3927 .Xr stat 2 ,
3928 .Xr write 2 ,
3929 .Xr fsync 3C ,
3930 .Xr dfstab 4 ,
3931 .Xr acl 5 ,
3932 .Xr attributes 5
|
6 .\" You may not use this file except in compliance with the License.
7 .\"
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 .\" or http://www.opensolaris.org/os/licensing.
10 .\" See the License for the specific language governing permissions
11 .\" and limitations under the License.
12 .\"
13 .\" When distributing Covered Code, include this CDDL HEADER in each
14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 .\" If applicable, add the following below this CDDL HEADER, with the
16 .\" fields enclosed by brackets "[]" replaced with your own identifying
17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
18 .\"
19 .\" CDDL HEADER END
20 .\"
21 .\"
22 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24 .\" Copyright (c) 2011, 2016 by Delphix. All rights reserved.
25 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
27 .\" Copyright (c) 2014 Integros [integros.com]
28 .\" Copyright 2018 Nexenta Systems, Inc.
29 .\" Copyright 2019 Joyent, Inc.
30 .\" Copyright (c) 2018 Datto Inc.
31 .\"
32 .Dd February 26, 2019
33 .Dt ZFS 1M
34 .Os
35 .Sh NAME
36 .Nm zfs
37 .Nd configures ZFS file systems
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl \?
41 .Nm
42 .Cm create
43 .Op Fl p
44 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
45 .Ar filesystem
46 .Nm
47 .Cm create
48 .Op Fl ps
49 .Op Fl b Ar blocksize
50 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
51 .Fl V Ar size Ar volume
52 .Nm
3478 .Op Fl jn
3479 .Op Fl t Ar timeout
3480 .Op Fl m Ar memory_limit
3481 .Ar pool script
3482 .Op Ar arg1 No ...
3483 .Xc
3484 Executes
3485 .Ar script
3486 as a ZFS channel program on
3487 .Ar pool .
3488 The ZFS channel
3489 program interface allows ZFS administrative operations to be run
3490 programmatically via a Lua script.
3491 The entire script is executed atomically, with no other administrative
3492 operations taking effect concurrently.
3493 A library of ZFS calls is made available to channel program scripts.
3494 Channel programs may only be run with root privileges.
3495 .sp
3496 For full documentation of the ZFS channel program interface, see the manual
3497 page for
3498 .Xr zfs-program 1M .
3499 .Bl -tag -width ""
3500 .It Fl j
3501 Display channel program output in JSON format.
3502 When this flag is specified and standard output is empty -
3503 channel program encountered an error.
3504 The details of such an error will be printed to standard error in plain text.
3505 .It Fl n
3506 Executes a read-only channel program, which runs faster.
3507 The program cannot change on-disk state by calling functions from
3508 the zfs.sync submodule.
3509 The program can be used to gather information such as properties and
3510 determining if changes would succeed (zfs.check.*).
3511 Without this flag, all pending changes must be synced to disk before
3512 a channel program can complete.
3513 .It Fl t Ar timeout
3514 Execution time limit, in milliseconds.
3515 If a channel program executes for longer than the provided timeout, it will
3516 be stopped and an error will be returned.
3517 The default timeout is 1000 ms, and can be set to a maximum of 10000 ms.
3518 .It Fl m Ar memory-limit
3904 option is used to indicate type information for the files affected.
3905 .Bd -literal
3906 # zfs diff -F tank/test@before tank/test
3907 M / /tank/test/
3908 M F /tank/test/linked (+1)
3909 R F /tank/test/oldname -> /tank/test/newname
3910 - F /tank/test/deleted
3911 + F /tank/test/created
3912 M F /tank/test/modified
3913 .Ed
3914 .El
3915 .Sh INTERFACE STABILITY
3916 .Sy Committed .
3917 .Sh SEE ALSO
3918 .Xr gzip 1 ,
3919 .Xr ssh 1 ,
3920 .Xr mount 1M ,
3921 .Xr share 1M ,
3922 .Xr sharemgr 1M ,
3923 .Xr unshare 1M ,
3924 .Xr zfs-program 1M ,
3925 .Xr zonecfg 1M ,
3926 .Xr zpool 1M ,
3927 .Xr chmod 2 ,
3928 .Xr stat 2 ,
3929 .Xr write 2 ,
3930 .Xr fsync 3C ,
3931 .Xr dfstab 4 ,
3932 .Xr acl 5 ,
3933 .Xr attributes 5
|