aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorAndriy Gapon <avg@FreeBSD.org>2017-09-01 17:56:34 +0000
committerAndriy Gapon <avg@FreeBSD.org>2017-09-01 17:56:34 +0000
commitb5742b1e923622999ba68d0fc31c7f8474d13344 (patch)
tree17f8f0313c783c349340489b09e4a7795c932177 /man
parentefd3d79ea33392718095ebe6efcd726bcc945760 (diff)
downloadsrc-b5742b1e923622999ba68d0fc31c7f8474d13344.tar.gz
src-b5742b1e923622999ba68d0fc31c7f8474d13344.zip
8435 zpool.1m and zfs.1m: minor cleanup
illumos/illumos-gate@a058d1cc571af5fbcfe7f1d719df1abbfdb722f3 https://github.com/illumos/illumos-gate/commit/a058d1cc571af5fbcfe7f1d719df1abbfdb722f3 https://www.illumos.org/issues/8435 This commit is a result of re-read while porting zpool.1m to ZFSonLinux. See https://github.com/zfsonlinux/zfs/commit/ cda0317e4d2a1277b328e4fc42ee3699bbe46c12 https://www.illumos.org/issues/3796 The listsnapshots property is not documented in the zpool man page. 3796 listsnapshots not documented in zpool man page Reviewed by: Matt Ahrens <mahrens@delphix.com> Reviewed by: Yuri Pankov <yuripv@gmx.com> Approved by: Dan McDonald <danmcd@joyent.com> Author: George Melikov <mail@gmelikov.ru>
Notes
Notes: svn path=/vendor/illumos/dist/; revision=323109
Diffstat (limited to 'man')
-rw-r--r--man/man1m/zfs.1m42
-rw-r--r--man/man1m/zpool.1m17
2 files changed, 34 insertions, 25 deletions
diff --git a/man/man1m/zfs.1m b/man/man1m/zfs.1m
index aacb0b8fe2ee..708b9a384df8 100644
--- a/man/man1m/zfs.1m
+++ b/man/man1m/zfs.1m
@@ -335,7 +335,7 @@ intervals.
The visibility of the
.Pa .zfs
directory can be controlled by the
-snapdir
+.Sy snapdir
property.
.Ss Clones
A clone is a writable volume or file system whose initial contents are the same
@@ -1352,7 +1352,7 @@ bytes in the dataset.
This property can also be referred to by its shortened column name,
.Sy refreserv .
.It Sy reservation Ns = Ns Em size Ns | Ns Sy none
-The minimum amount of space guaranteed to a dataset and its descendents.
+The minimum amount of space guaranteed to a dataset and its descendants.
When the amount of space used is below this value, the dataset is treated as if
it were taking up the amount of space specified by its reservation.
Reservations are accounted for in the parent datasets' space used, and count
@@ -1404,7 +1404,7 @@ command is invoked with options equivalent to the contents of this property.
Because SMB shares requires a resource name, a unique resource name is
constructed from the dataset name.
The constructed name is a copy of the dataset name except that the characters in
-the dataset name, which would be illegal in the resource name, are replaced with
+the dataset name, which would be invalid in the resource name, are replaced with
underscore
.Pq Sy _
characters.
@@ -2110,7 +2110,8 @@ subcommand can be used to rename any conflicting snapshots.
.Op Fl f
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
-.br
+.Xc
+.It Xo
.Nm
.Cm rename
.Op Fl fp
@@ -2903,7 +2904,8 @@ for more details.
.Op Fl Fnsuv
.Op Fl o Sy origin Ns = Ns Ar snapshot
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
-.br
+.Xc
+.It Xo
.Nm
.Cm receive
.Op Fl Fnsuv
@@ -3139,31 +3141,35 @@ property.
The following permissions are available:
.Bd -literal
NAME TYPE NOTES
-allow subcommand Must also have the permission that is being
- allowed
-clone subcommand Must also have the 'create' ability and 'mount'
- ability in the origin file system
+allow subcommand Must also have the permission that is
+ being allowed
+clone subcommand Must also have the 'create' ability and
+ 'mount' ability in the origin file system
create subcommand Must also have the 'mount' ability
destroy subcommand Must also have the 'mount' ability
diff subcommand Allows lookup of paths within a dataset
- given an object number, and the ability to
- create snapshots necessary to 'zfs diff'.
+ given an object number, and the ability
+ to create snapshots necessary to
+ 'zfs diff'.
mount subcommand Allows mount/umount of ZFS datasets
-promote subcommand Must also have the 'mount'
- and 'promote' ability in the origin file system
-receive subcommand Must also have the 'mount' and 'create' ability
+promote subcommand Must also have the 'mount' and 'promote'
+ ability in the origin file system
+receive subcommand Must also have the 'mount' and 'create'
+ ability
rename subcommand Must also have the 'mount' and 'create'
ability in the new parent
rollback subcommand Must also have the 'mount' ability
send subcommand
-share subcommand Allows sharing file systems over NFS or SMB
- protocols
+share subcommand Allows sharing file systems over NFS
+ or SMB protocols
snapshot subcommand Must also have the 'mount' ability
-groupquota other Allows accessing any groupquota@... property
+groupquota other Allows accessing any groupquota@...
+ property
groupused other Allows reading any groupused@... property
userprop other Allows changing any user property
-userquota other Allows accessing any userquota@... property
+userquota other Allows accessing any userquota@...
+ property
userused other Allows reading any userused@... property
aclinherit property
diff --git a/man/man1m/zpool.1m b/man/man1m/zpool.1m
index 1d7c3e295bbb..baa534a31e22 100644
--- a/man/man1m/zpool.1m
+++ b/man/man1m/zpool.1m
@@ -23,8 +23,9 @@
.\" Copyright (c) 2013 by Delphix. All rights reserved.
.\" Copyright 2017 Nexenta Systems, Inc.
.\" Copyright (c) 2017 Datto Inc.
+.\" Copyright (c) 2017 George Melikov. All Rights Reserved.
.\"
-.Dd June 21, 2017
+.Dd August 23, 2017
.Dt ZPOOL 1M
.Os
.Sh NAME
@@ -661,7 +662,7 @@ to the enabled state.
See
.Xr zpool-features 5
for details on feature states.
-.It Sy listsnaps Ns = Ns Sy on Ns | Ns Sy off
+.It Sy listsnapshots Ns = Ns Sy on Ns | Ns Sy off
Controls whether information about snapshots associated with this pool is
output when
.Nm zfs Cm list
@@ -670,6 +671,8 @@ is run without the
option.
The default value is
.Sy off .
+This property can also be referred to by its shortened name,
+.Sy listsnaps .
.It Sy version Ns = Ns Ar version
The current on-disk version of the pool.
This can be increased, but never decreased.
@@ -677,7 +680,7 @@ The preferred method of updating pools is with the
.Nm zpool Cm upgrade
command, though this property can be used when a specific version is needed for
backwards compatibility.
-Once feature flags is enabled on a pool this property will no longer have a
+Once feature flags are enabled on a pool this property will no longer have a
value.
.El
.Ss Subcommands
@@ -1541,7 +1544,7 @@ for
.Ar newpool
to
.Ar root
-and automaticaly import it.
+and automatically import it.
.El
.It Xo
.Nm
@@ -1606,7 +1609,7 @@ to enable all features on all pools.
.Fl v
.Xc
Displays legacy ZFS versions supported by the current software.
- See
+See
.Xr zpool-features 5
for a description of feature flags features supported by the current software.
.It Xo
@@ -1746,7 +1749,7 @@ The failed device can be replaced using the following command:
.Ed
.Pp
Once the data has been resilvered, the spare is automatically removed and is
-made available should another device fails.
+made available for use should another device fail.
The hot spare can be permanently removed from the pool using the following
command:
.Bd -literal
@@ -1806,7 +1809,7 @@ is:
# zpool remove tank mirror-2
.Ed
.It Sy Example 15 No Displaying expanded space on a device
-The following command dipslays the detailed information for the pool
+The following command displays the detailed information for the pool
.Em data .
This pool is comprised of a single raidz vdev where one of its devices
increased its capacity by 10GB.