aboutsummaryrefslogtreecommitdiff
path: root/sys/contrib/openzfs/man/man8
diff options
context:
space:
mode:
Diffstat (limited to 'sys/contrib/openzfs/man/man8')
-rw-r--r--sys/contrib/openzfs/man/man8/zdb.813
-rw-r--r--sys/contrib/openzfs/man/man8/zfs-rewrite.828
-rw-r--r--sys/contrib/openzfs/man/man8/zpool-events.84
-rw-r--r--sys/contrib/openzfs/man/man8/zpool-initialize.87
-rw-r--r--sys/contrib/openzfs/man/man8/zpool-scrub.851
-rw-r--r--sys/contrib/openzfs/man/man8/zpool-trim.87
6 files changed, 93 insertions, 17 deletions
diff --git a/sys/contrib/openzfs/man/man8/zdb.8 b/sys/contrib/openzfs/man/man8/zdb.8
index 8bfd0dcdc381..3984aaac5866 100644
--- a/sys/contrib/openzfs/man/man8/zdb.8
+++ b/sys/contrib/openzfs/man/man8/zdb.8
@@ -474,10 +474,15 @@ as it runs.
Exercise extreme caution when using this option in shared or uncontrolled
environments.
.It Fl o , -option Ns = Ns Ar var Ns = Ns Ar value Ns …
-Set the given global libzpool variable to the provided value.
-The value must be an unsigned 32-bit integer.
-Currently only little-endian systems are supported to avoid accidentally setting
-the high 32 bits of 64-bit variables.
+Set the given tunable to the provided value.
+.It Fl o , -option Ns = Ns Ar var Ns …
+Show the value of the given tunable.
+.It Fl o , -option Ns = Ns show
+Show all tunables and their values.
+.It Fl o , -option Ns = Ns info Ns = Ns Ar value Ns …
+Show info about a tunable, including their name, type and description.
+.It Fl o , -option Ns = Ns info
+Show info about all tunables.
.It Fl P , -parseable
Print numbers in an unscaled form more amenable to parsing, e.g.\&
.Sy 1000000
diff --git a/sys/contrib/openzfs/man/man8/zfs-rewrite.8 b/sys/contrib/openzfs/man/man8/zfs-rewrite.8
index 423d6d439e28..a3a037f3794a 100644
--- a/sys/contrib/openzfs/man/man8/zfs-rewrite.8
+++ b/sys/contrib/openzfs/man/man8/zfs-rewrite.8
@@ -31,7 +31,7 @@
.Sh SYNOPSIS
.Nm zfs
.Cm rewrite
-.Oo Fl rvx Ns Oc
+.Oo Fl Prvx Ns Oc
.Op Fl l Ar length
.Op Fl o Ar offset
.Ar file Ns | Ns Ar directory Ns …
@@ -43,6 +43,15 @@ as is without modification at a new location and possibly with new
properties, such as checksum, compression, dedup, copies, etc,
as if they were atomically read and written back.
.Bl -tag -width "-r"
+.It Fl P
+Perform physical rewrite, preserving logical birth time of blocks.
+By default, rewrite updates logical birth times, making blocks appear
+as modified in snapshots and incremental send streams.
+Physical rewrite preserves logical birth times, avoiding unnecessary
+inclusion in incremental streams.
+Physical rewrite requires the
+.Sy physical_rewrite
+feature to be enabled on the pool.
.It Fl l Ar length
Rewrite at most this number of bytes.
.It Fl o Ar offset
@@ -60,17 +69,22 @@ same as some property changes may increase pool space usage.
Holes that were never written or were previously zero-compressed are
not rewritten and will remain holes even if compression is disabled.
.Pp
-Rewritten blocks will be seen as modified in next snapshot and as such
-included into the incremental
-.Nm zfs Cm send
-stream.
-.Pp
If a
.Fl l
or
.Fl o
value request a rewrite to regions past the end of the file, then those
regions are silently ignored, and no error is reported.
+.Pp
+By default, rewritten blocks update their logical birth time,
+meaning they will be included in incremental
+.Nm zfs Cm send
+streams as modified data.
+When the
+.Fl P
+flag is used, rewritten blocks preserve their logical birth time, since
+there are no user data changes.
.
.Sh SEE ALSO
-.Xr zfsprops 7
+.Xr zfsprops 7 ,
+.Xr zpool-features 7
diff --git a/sys/contrib/openzfs/man/man8/zpool-events.8 b/sys/contrib/openzfs/man/man8/zpool-events.8
index 7af1917da6d9..2d32dce2bb65 100644
--- a/sys/contrib/openzfs/man/man8/zpool-events.8
+++ b/sys/contrib/openzfs/man/man8/zpool-events.8
@@ -28,7 +28,7 @@
.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
.\" Copyright (c) 2024, 2025, Klara, Inc.
.\"
-.Dd May 27, 2025
+.Dd July 3, 2025
.Dt ZPOOL-EVENTS 8
.Os
.
@@ -465,7 +465,7 @@ ZIO_FLAG_DONT_RETRY:0x00000400
ZIO_FLAG_NODATA:0x00001000
ZIO_FLAG_INDUCE_DAMAGE:0x00002000
-ZIO_FLAG_IO_ALLOCATING:0x00004000
+ZIO_FLAG_ALLOC_THROTTLED:0x00004000
ZIO_FLAG_IO_RETRY:0x00008000
ZIO_FLAG_PROBE:0x00010000
ZIO_FLAG_TRYHARD:0x00020000
diff --git a/sys/contrib/openzfs/man/man8/zpool-initialize.8 b/sys/contrib/openzfs/man/man8/zpool-initialize.8
index d7c9d22aba97..39579a58010e 100644
--- a/sys/contrib/openzfs/man/man8/zpool-initialize.8
+++ b/sys/contrib/openzfs/man/man8/zpool-initialize.8
@@ -26,6 +26,7 @@
.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
.\" Copyright 2017 Nexenta Systems, Inc.
.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
+.\" Copyright (c) 2025 Hewlett Packard Enterprise Development LP.
.\"
.Dd May 27, 2021
.Dt ZPOOL-INITIALIZE 8
@@ -39,7 +40,7 @@
.Cm initialize
.Op Fl c Ns | Ns Fl s | Ns Fl u
.Op Fl w
-.Ar pool
+.Fl a Ns | Ns Ar pool
.Oo Ar device Oc Ns …
.
.Sh DESCRIPTION
@@ -48,6 +49,10 @@ devices, or all eligible devices in the pool if no individual devices are
specified.
Only leaf data or log devices may be initialized.
.Bl -tag -width Ds
+.It Fl a , -all
+Begin, cancel, suspend initializing on
+all
+pools.
.It Fl c , -cancel
Cancel initializing on the specified devices, or all eligible devices if none
are specified.
diff --git a/sys/contrib/openzfs/man/man8/zpool-scrub.8 b/sys/contrib/openzfs/man/man8/zpool-scrub.8
index 21bd6735ede4..0ecf8bd3851f 100644
--- a/sys/contrib/openzfs/man/man8/zpool-scrub.8
+++ b/sys/contrib/openzfs/man/man8/zpool-scrub.8
@@ -26,8 +26,9 @@
.\" Copyright (c) 2018, 2021 George Melikov. All Rights Reserved.
.\" Copyright 2017 Nexenta Systems, Inc.
.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
+.\" Copyright (c) 2025 Hewlett Packard Enterprise Development LP.
.\"
-.Dd November 18, 2024
+.Dd December 11, 2024
.Dt ZPOOL-SCRUB 8
.Os
.
@@ -39,7 +40,9 @@
.Cm scrub
.Op Ns Fl e | Ns Fl p | Fl s Ns | Fl C Ns
.Op Fl w
-.Ar pool Ns …
+.Op Fl S Ar date
+.Op Fl E Ar date
+.Fl a Ns | Ns Ar pool Ns …
.
.Sh DESCRIPTION
Begins a scrub or resumes a paused scrub.
@@ -89,6 +92,12 @@ During this period, no completion time estimate will be provided.
.
.Sh OPTIONS
.Bl -tag -width "-s"
+.It Fl a , -all
+Begin, pause, stop scrub on
+all
+pools.
+Initiating scrubs on multiple pools can put considerable load and memory
+pressure on the system, so this operation should be performed with caution.
.It Fl s
Stop scrubbing.
.It Fl p
@@ -118,6 +127,44 @@ resilvering, nor can it be run when a regular scrub is paused.
Continue scrub from last saved txg (see zpool
.Sy last_scrubbed_txg
property).
+.It Fl S Ar date , Fl E Ar date
+Allows specifying the date range for blocks created between these dates.
+.Bl -bullet -compact -offset indent
+.It
+.Fl S
+Defines a start date.
+If not specified, scrubbing begins from the start of the pool's
+existence.
+.It
+.Fl E
+Defines an end date.
+If not specified, scrubbing continues up to the most recent data.
+.El
+The provided date should be in the format:
+.Dq YYYY-MM-DD HH:MM .
+Where:
+.Bl -bullet -compact -offset indent
+.It
+.Dq YYYY
+is the year.
+.It
+.Dq MM
+is the numeric representation of the month.
+.It
+.Dq DD
+is the day of the month.
+.It
+.Dq HH
+is the hour.
+.It
+.Dq MM
+is the minutes.
+.El
+The hour and minutes parameters can be omitted.
+The time should be provided in machine local time zone.
+Specifying dates prior to enabling this feature will result in scrubbing
+starting from the date the pool was created.
+If the time was moved backward manually the data range may become inaccurate.
.El
.Sh EXAMPLES
.Ss Example 1
diff --git a/sys/contrib/openzfs/man/man8/zpool-trim.8 b/sys/contrib/openzfs/man/man8/zpool-trim.8
index 06cbd5abf7eb..18723e1be0d2 100644
--- a/sys/contrib/openzfs/man/man8/zpool-trim.8
+++ b/sys/contrib/openzfs/man/man8/zpool-trim.8
@@ -26,6 +26,7 @@
.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
.\" Copyright 2017 Nexenta Systems, Inc.
.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
+.\" Copyright (c) 2025 Hewlett Packard Enterprise Development LP.
.\"
.Dd May 27, 2021
.Dt ZPOOL-TRIM 8
@@ -40,7 +41,7 @@
.Op Fl dw
.Op Fl r Ar rate
.Op Fl c Ns | Ns Fl s
-.Ar pool
+.Fl a Ns | Ns Ar pool
.Oo Ar device Ns Oc Ns …
.
.Sh DESCRIPTION
@@ -57,6 +58,10 @@ See the documentation for the
.Sy autotrim
property above for the types of vdev devices which can be trimmed.
.Bl -tag -width Ds
+.It Fl a , -all
+Perform TRIM operation on
+all
+pools.
.It Fl d , -secure
Causes a secure TRIM to be initiated.
When performing a secure TRIM, the