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 listsnaps 67property is 68.Sy on 69.Po the default is 70.Sy off 71.Pc . 72The following fields are displayed: 73.Sy name Ns \&, Sy used Ns \&, Sy available Ns \&, Sy referenced Ns \&, Sy mountpoint Ns . 74.Bl -tag -width "-H" 75.It Fl H 76Used for scripting mode. 77Do not print headers and separate fields by a single tab instead of arbitrary 78white space. 79.It Fl S Ar property 80Same as the 81.Fl s 82option, but sorts by property in descending order. 83.It Fl d Ar depth 84Recursively display any children of the dataset, limiting the recursion to 85.Ar depth . 86A 87.Ar depth 88of 89.Sy 1 90will display only the dataset and its direct children. 91.It Fl o Ar property 92A comma-separated list of properties to display. 93The property must be: 94.Bl -bullet 95.It 96One of the properties described in the 97.Em Native Properties 98section of 99.Xr zfsprops 8 100.It 101A user property 102.It 103The value 104.Sy name 105to display the dataset name 106.It 107The value 108.Sy space 109to display space usage properties on file systems and volumes. 110This is a shortcut for specifying 111.Fl o Sy name Ns \&, Ns Sy avail Ns \&, Ns Sy used Ns \&, Ns Sy usedsnap Ns \&, Ns 112.Sy usedds Ns \&, Ns Sy usedrefreserv Ns \&, Ns Sy usedchild Fl t 113.Sy filesystem Ns \&, Ns Sy volume 114syntax. 115.El 116.It Fl p 117Display numbers in parsable 118.Pq exact 119values. 120.It Fl r 121Recursively display any children of the dataset on the command line. 122.It Fl s Ar property 123A property for sorting the output by column in ascending order based on the 124value of the property. 125The property must be one of the properties described in the 126.Em Properties 127section of 128.Xr zfsprops 8 129or the value 130.Sy name 131to sort by the dataset name. 132Multiple properties can be specified at one time using multiple 133.Fl s 134property options. 135Multiple 136.Fl s 137options are evaluated from left to right in decreasing order of importance. 138The following is a list of sorting criteria: 139.Bl -bullet 140.It 141Numeric types sort in numeric order. 142.It 143String types sort in alphabetical order. 144.It 145Types inappropriate for a row sort that row to the literal bottom, regardless of 146the specified ordering. 147.El 148.Pp 149If no sorting options are specified the existing behavior of 150.Nm zfs Cm list 151is preserved. 152.It Fl t Ar type 153A comma-separated list of types to display, where 154.Ar type 155is one of 156.Sy filesystem , 157.Sy snapshot , 158.Sy volume , 159.Sy bookmark , 160or 161.Sy all . 162For example, specifying 163.Fl t Sy snapshot 164displays only snapshots. 165.El 166.El 167.Sh SEE ALSO 168.Xr zfs-get 8 , 169.Xr zfsprops 8 170