mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2026-05-30 02:34:14 +03:00
Lint most manpages
Reviewed-by: Richard Laager <rlaager@wiktel.com> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Reviewed-by: Tony Nguyen <tony.nguyen@delphix.com> Reviewed-by: Ryan Moeller <ryan@iXsystems.com> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12129
This commit is contained in:
+40
-46
@@ -18,7 +18,6 @@
|
||||
.\"
|
||||
.\" CDDL HEADER END
|
||||
.\"
|
||||
.\"
|
||||
.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
|
||||
.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
|
||||
.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
|
||||
@@ -30,37 +29,39 @@
|
||||
.\" Copyright 2018 Nexenta Systems, Inc.
|
||||
.\" Copyright 2019 Joyent, Inc.
|
||||
.\"
|
||||
.Dd June 30, 2019
|
||||
.Dd June 2, 2021
|
||||
.Dt ZFS-SET 8
|
||||
.Os
|
||||
.
|
||||
.Sh NAME
|
||||
.Nm zfs-set
|
||||
.Nd Sets the property or list of properties to the given value(s) for each dataset.
|
||||
.Nd set properties on ZFS datasets
|
||||
.Sh SYNOPSIS
|
||||
.Nm zfs
|
||||
.Cm set
|
||||
.Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
|
||||
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
|
||||
.Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns …
|
||||
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns …
|
||||
.Nm zfs
|
||||
.Cm get
|
||||
.Op Fl r Ns | Ns Fl d Ar depth
|
||||
.Op Fl Hp
|
||||
.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
|
||||
.Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns ... Oc
|
||||
.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
|
||||
.Cm all | Ar property Ns Oo , Ns Ar property Oc Ns ...
|
||||
.Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns ...
|
||||
.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc
|
||||
.Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns … Oc
|
||||
.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc
|
||||
.Cm all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns …
|
||||
.Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns …
|
||||
.Nm zfs
|
||||
.Cm inherit
|
||||
.Op Fl rS
|
||||
.Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
|
||||
.Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns …
|
||||
.
|
||||
.Sh DESCRIPTION
|
||||
.Bl -tag -width ""
|
||||
.It Xo
|
||||
.Nm zfs
|
||||
.Cm set
|
||||
.Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
|
||||
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
|
||||
.Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns …
|
||||
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns …
|
||||
.Xc
|
||||
Only some properties can be edited.
|
||||
See
|
||||
@@ -83,39 +84,43 @@ section of
|
||||
.Cm get
|
||||
.Op Fl r Ns | Ns Fl d Ar depth
|
||||
.Op Fl Hp
|
||||
.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
|
||||
.Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns ... Oc
|
||||
.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
|
||||
.Cm all | Ar property Ns Oo , Ns Ar property Oc Ns ...
|
||||
.Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns ...
|
||||
.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc
|
||||
.Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns … Oc
|
||||
.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc
|
||||
.Cm all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns …
|
||||
.Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns …
|
||||
.Xc
|
||||
Displays properties for the given datasets.
|
||||
If no datasets are specified, then the command displays properties for all
|
||||
datasets on the system.
|
||||
For each property, the following columns are displayed:
|
||||
.Bd -literal
|
||||
name Dataset name
|
||||
property Property name
|
||||
value Property value
|
||||
source Property source \fBlocal\fP, \fBdefault\fP, \fBinherited\fP,
|
||||
\fBtemporary\fP, \fBreceived\fP or none (\fB-\fP).
|
||||
.Ed
|
||||
.Bl -tag -compact -offset 4n -width "property"
|
||||
.It Sy name
|
||||
Dataset name
|
||||
.It Sy property
|
||||
Property name
|
||||
.It Sy value
|
||||
Property value
|
||||
.It Sy source
|
||||
Property source
|
||||
.Sy local , default , inherited , temporary , received , No or Sy - Pq none .
|
||||
.El
|
||||
.Pp
|
||||
All columns are displayed by default, though this can be controlled by using the
|
||||
.Fl o
|
||||
option.
|
||||
This command takes a comma-separated list of properties as described in the
|
||||
.Em Native Properties
|
||||
.Sx Native Properties
|
||||
and
|
||||
.Em User Properties
|
||||
.Sx User Properties
|
||||
sections of
|
||||
.Xr zfsprops 8 .
|
||||
.Pp
|
||||
The value
|
||||
.Sy all
|
||||
can be used to display all properties that apply to the given dataset's type
|
||||
.Pq filesystem, volume, snapshot, or bookmark .
|
||||
.Bl -tag -width "-H"
|
||||
.Pq Sy filesystem , volume , snapshot , No or Sy bookmark .
|
||||
.Bl -tag -width "-s source"
|
||||
.It Fl H
|
||||
Display output in a form more easily parsed by scripts.
|
||||
Any headers are omitted, and fields are explicitly separated by a single tab
|
||||
@@ -127,9 +132,8 @@ A depth of
|
||||
.Sy 1
|
||||
will display only the dataset and its direct children.
|
||||
.It Fl o Ar field
|
||||
A comma-separated list of columns to display.
|
||||
.Sy name Ns \&, Ns Sy property Ns \&, Ns Sy value Ns \&, Ns Sy source
|
||||
is the default value.
|
||||
A comma-separated list of columns to display, defaults to
|
||||
.Sy name , Ns Sy property , Ns Sy value , Ns Sy source .
|
||||
.It Fl p
|
||||
Display numbers in parsable
|
||||
.Pq exact
|
||||
@@ -140,30 +144,19 @@ Recursively display properties for any children.
|
||||
A comma-separated list of sources to display.
|
||||
Those properties coming from a source other than those in this list are ignored.
|
||||
Each source must be one of the following:
|
||||
.Sy local ,
|
||||
.Sy default ,
|
||||
.Sy inherited ,
|
||||
.Sy temporary ,
|
||||
.Sy received ,
|
||||
and
|
||||
.Sy none .
|
||||
.Sy local , default , inherited , temporary , received , No or Sy none .
|
||||
The default value is all sources.
|
||||
.It Fl t Ar type
|
||||
A comma-separated list of types to display, where
|
||||
.Ar type
|
||||
is one of
|
||||
.Sy filesystem ,
|
||||
.Sy snapshot ,
|
||||
.Sy volume ,
|
||||
.Sy bookmark ,
|
||||
or
|
||||
.Sy all .
|
||||
.Sy filesystem , snapshot , volume , bookmark , No or Sy all .
|
||||
.El
|
||||
.It Xo
|
||||
.Nm zfs
|
||||
.Cm inherit
|
||||
.Op Fl rS
|
||||
.Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
|
||||
.Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns …
|
||||
.Xc
|
||||
Clears the specified property, causing it to be inherited from an ancestor,
|
||||
restored to default if no ancestor has the property set, or with the
|
||||
@@ -183,6 +176,7 @@ if the
|
||||
option was not specified.
|
||||
.El
|
||||
.El
|
||||
.
|
||||
.Sh SEE ALSO
|
||||
.Xr zfs-list 8 ,
|
||||
.Xr zfsprops 8
|
||||
|
||||
Reference in New Issue
Block a user