1.\" 2.\" CDDL HEADER START 3.\" 4.\" The contents of this file are subject to the terms of the 5.\" Common Development and Distribution License (the "License"). 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, 2019 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 2019 Richard Laager. All rights reserved. 30.\" Copyright 2018 Nexenta Systems, Inc. 31.\" Copyright 2019 Joyent, Inc. 32.\" 33.Dd June 30, 2019 34.Dt ZFS-LIST 8 35.Os 36.Sh NAME 37.Nm zfs-list 38.Nd Lists the property information for the given datasets in tabular form. 39.Sh SYNOPSIS 40.Nm zfs 41.Cm list 42.Op Fl r Ns | Ns Fl d Ar depth 43.Op Fl Hp 44.Oo Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... Oc 45.Oo Fl s Ar property Oc Ns ... 46.Oo Fl S Ar property Oc Ns ... 47.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc 48.Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Oc Ns ... 49.Sh DESCRIPTION 50.Bl -tag -width "" 51.It Xo 52.Nm zfs 53.Cm list 54.Op Fl r Ns | Ns Fl d Ar depth 55.Op Fl Hp 56.Oo Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... Oc 57.Oo Fl s Ar property Oc Ns ... 58.Oo Fl S Ar property Oc Ns ... 59.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc 60.Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Oc Ns ... 61.Xc 62If specified, you can list property information by the absolute pathname or the 63relative pathname. 64By default, all file systems and volumes are displayed. 65Snapshots are displayed if the 66.Sy listsnapshots 67pool property is 68.Sy on 69.Po the default is 70.Sy off 71.Pc , 72or if the 73.Fl t Sy snapshot 74or 75.Fl t Sy all 76options are specified. 77The following fields are displayed: 78.Sy name Ns \&, Sy used Ns \&, Sy available Ns \&, Sy referenced Ns \&, Sy mountpoint Ns . 79.Bl -tag -width "-H" 80.It Fl H 81Used for scripting mode. 82Do not print headers and separate fields by a single tab instead of arbitrary 83white space. 84.It Fl S Ar property 85Same as the 86.Fl s 87option, but sorts by property in descending order. 88.It Fl d Ar depth 89Recursively display any children of the dataset, limiting the recursion to 90.Ar depth . 91A 92.Ar depth 93of 94.Sy 1 95will display only the dataset and its direct children. 96.It Fl o Ar property 97A comma-separated list of properties to display. 98The property must be: 99.Bl -bullet 100.It 101One of the properties described in the 102.Em Native Properties 103section of 104.Xr zfsprops 8 105.It 106A user property 107.It 108The value 109.Sy name 110to display the dataset name 111.It 112The value 113.Sy space 114to display space usage properties on file systems and volumes. 115This is a shortcut for specifying 116.Fl o Sy name Ns \&, Ns Sy avail Ns \&, Ns Sy used Ns \&, Ns Sy usedsnap Ns \&, Ns 117.Sy usedds Ns \&, Ns Sy usedrefreserv Ns \&, Ns Sy usedchild Fl t 118.Sy filesystem Ns \&, Ns Sy volume 119syntax. 120.El 121.It Fl p 122Display numbers in parsable 123.Pq exact 124values. 125.It Fl r 126Recursively display any children of the dataset on the command line. 127.It Fl s Ar property 128A property for sorting the output by column in ascending order based on the 129value of the property. 130The property must be one of the properties described in the 131.Em Properties 132section of 133.Xr zfsprops 8 134or the value 135.Sy name 136to sort by the dataset name. 137Multiple properties can be specified at one time using multiple 138.Fl s 139property options. 140Multiple 141.Fl s 142options are evaluated from left to right in decreasing order of importance. 143The following is a list of sorting criteria: 144.Bl -bullet 145.It 146Numeric types sort in numeric order. 147.It 148String types sort in alphabetical order. 149.It 150Types inappropriate for a row sort that row to the literal bottom, regardless of 151the specified ordering. 152.El 153.Pp 154If no sorting options are specified the existing behavior of 155.Nm zfs Cm list 156is preserved. 157.It Fl t Ar type 158A comma-separated list of types to display, where 159.Ar type 160is one of 161.Sy filesystem , 162.Sy snapshot , 163.Sy volume , 164.Sy bookmark , 165or 166.Sy all . 167For example, specifying 168.Fl t Sy snapshot 169displays only snapshots. 170.El 171.El 172.Sh SEE ALSO 173.Xr zfs-get 8 , 174.Xr zfsprops 8 175