diff options
author | Martin Matuska <mm@FreeBSD.org> | 2012-07-18 09:53:20 +0000 |
---|---|---|
committer | Martin Matuska <mm@FreeBSD.org> | 2012-07-18 09:53:20 +0000 |
commit | 95fb2d6060707209df9ac0ef54c175e0332fd5dc (patch) | |
tree | bea0c00805a55e4f6f572223661f93ec39a1a377 | |
parent | dc2ef09e2d17a1d92ac91900bc68120103f913dc (diff) |
Notes
-rw-r--r-- | man/man1m/dtrace.1m | 393 | ||||
-rw-r--r-- | man/man1m/lockstat.1m | 50 | ||||
-rw-r--r-- | man/man1m/plockstat.1m | 51 | ||||
-rw-r--r-- | man/man1m/zdb.1m | 509 | ||||
-rw-r--r-- | man/man1m/zfs.1m | 627 | ||||
-rw-r--r-- | man/man1m/zpool.1m | 349 | ||||
-rw-r--r-- | man/man1m/zstreamdump.1m | 15 |
7 files changed, 876 insertions, 1118 deletions
diff --git a/man/man1m/dtrace.1m b/man/man1m/dtrace.1m index e20ed9fe6ba8b..1381044fe45a8 100644 --- a/man/man1m/dtrace.1m +++ b/man/man1m/dtrace.1m @@ -1,51 +1,42 @@ '\" te -.\" CDDL HEADER START -.\" -.\" The contents of this file are subject to the terms of the -.\" Common Development and Distribution License (the "License"). -.\" You may not use this file except in compliance with the License. -.\" -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE -.\" or http://www.opensolaris.org/os/licensing. -.\" See the License for the specific language governing permissions -.\" and limitations under the License. -.\" -.\" When distributing Covered Code, include this CDDL HEADER in each -.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. -.\" If applicable, add the following below this CDDL HEADER, with the -.\" fields enclosed by brackets "[]" replaced with your own identifying -.\" information: Portions Copyright [yyyy] [name of copyright owner] -.\" -.\" CDDL HEADER END -.\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved. -.TH dtrace 1M "5 Sep 2006" "SunOS 5.11" "System Administration Commands" +.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. +.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the +.\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH dtrace 1M "4 Aug 2009" "SunOS 5.11" "System Administration Commands" .SH NAME dtrace \- DTrace dynamic tracing compiler and tracing utility .SH SYNOPSIS .LP .nf \fBdtrace\fR [\fB-32\fR | \fB-64\fR] [\fB-aACeFGHhlqSvVwZ\fR] [\fB-b\fR \fIbufsz\fR] [\fB-c\fR \fIcmd\fR] - [\fB-D\fR \fIname\fR [\fI=value\fR]] [\fB-I\fR \fIpath\fR] [\fB-L\fR \fIpath\fR] [\fB-o\fR \fIoutput\fR] - [\fB-s\fR \fIscript\fR] [\fB-U\fR \fIname\fR] [\fB-x\fR \fIarg\fR [\fI=val\fR]] - [\fB-X\fR a | c | s | t] [\fB-p\fR \fIpid\fR] - [\fB-P\fR \fIprovider\fR [[\fIpredicate\fR] \fIaction\fR]] - [\fB-m\fR [\fIprovider:\fR] \fImodule\fR [[\fIpredicate\fR] \fIaction\fR]] - [\fB-f\fR [[\fIprovider:\fR] \fImodule:\fR] \fIfunction\fR [[\fIpredicate\fR] \fIaction\fR]] - [\fB-n\fR [[[\fIprovider:\fR] \fImodule:\fR] \fIfunction:\fR] \fIname\fR [[\fIpredicate\fR] \fIaction\fR]] - [\fB-i\fR \fIprobe-id\fR [[\fIpredicate\fR] \fIaction\fR]] + [\fB-D\fR \fIname\fR [\fI=value\fR]] [\fB-I\fR \fIpath\fR] [\fB-L\fR \fIpath\fR] [\fB-o\fR \fIoutput\fR] + [\fB-s\fR \fIscript\fR] [\fB-U\fR \fIname\fR] [\fB-x\fR \fIarg\fR [\fI=val\fR]] + [\fB-X\fR a | c | s | t] [\fB-p\fR \fIpid\fR] + [\fB-P\fR \fIprovider\fR [[\fIpredicate\fR] \fIaction\fR]] + [\fB-m\fR [\fIprovider:\fR] \fImodule\fR [[\fIpredicate\fR] \fIaction\fR]] + [\fB-f\fR [[\fIprovider:\fR] \fImodule:\fR] \fIfunction\fR [[\fIpredicate\fR] \fIaction\fR]] + [\fB-n\fR [[[\fIprovider:\fR] \fImodule:\fR] \fIfunction:\fR] \fIname\fR [[\fIpredicate\fR] \fIaction\fR]] + [\fB-i\fR \fIprobe-id\fR [[\fIpredicate\fR] \fIaction\fR]] .fi .SH DESCRIPTION .sp .LP -DTrace is a comprehensive dynamic tracing framework for the Solaris Operating System. DTrace provides a powerful infrastructure that permits administrators, developers, and service personnel to concisely answer arbitrary questions about the behavior of the operating system and user programs. +DTrace is a comprehensive dynamic tracing framework for the Solaris Operating +System. DTrace provides a powerful infrastructure that permits administrators, +developers, and service personnel to concisely answer arbitrary questions about +the behavior of the operating system and user programs. .sp .LP -The \fISolaris Dynamic Tracing Guide\fR describes how to use DTrace to observe, debug, and tune system behavior. Refer to this book for a detailed description of DTrace features, including the bundled DTrace observability -tools, instrumentation providers, and the D programming language. +The \fISolaris Dynamic Tracing Guide\fR describes how to use DTrace to observe, +debug, and tune system behavior. Refer to this book for a detailed description +of DTrace features, including the bundled DTrace observability tools, +instrumentation providers, and the D programming language. .sp .LP -The \fBdtrace\fR command provides a generic interface to the essential services provided by the DTrace facility, including: +The \fBdtrace\fR command provides a generic interface to the essential services +provided by the DTrace facility, including: .RS +4 .TP .ie t \(bu @@ -56,13 +47,15 @@ Options that list the set of probes and providers currently published by DTrace .TP .ie t \(bu .el o -Options that enable probes directly using any of the probe description specifiers (provider, module, function, name) +Options that enable probes directly using any of the probe description +specifiers (provider, module, function, name) .RE .RS +4 .TP .ie t \(bu .el o -Options that run the D compiler and compile one or more D program files or programs written directly on the command line +Options that run the D compiler and compile one or more D program files or +programs written directly on the command line .RE .RS +4 .TP @@ -80,15 +73,25 @@ Options that generate program stability reports .TP .ie t \(bu .el o -Options that modify DTrace tracing and buffering behavior and enable additional D compiler features +Options that modify DTrace tracing and buffering behavior and enable additional +D compiler features .RE .sp .LP -You can use \fBdtrace\fR to create D scripts by using it in a \fB#!\fR declaration to create an interpreter file. You can also use \fBdtrace\fR to attempt to compile D programs and determine their properties without actually enabling tracing using the \fB-e\fR option. See \fBOPTIONS\fR. See the \fISolaris Dynamic Tracing Guide\fR for detailed examples of how to use the \fBdtrace\fR utility to perform these tasks. +You can use \fBdtrace\fR to create D scripts by using it in a \fB#!\fR +declaration to create an interpreter file. You can also use \fBdtrace\fR to +attempt to compile D programs and determine their properties without actually +enabling tracing using the \fB-e\fR option. See \fBOPTIONS\fR. See the +\fISolaris Dynamic Tracing Guide\fR for detailed examples of how to use the +\fBdtrace\fR utility to perform these tasks. .SH OPTIONS .sp .LP -The arguments accepted by the \fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, and \fB-i\fR options can include an optional D language \fIpredicate\fR enclosed in slashes \fB//\fR and optional D language \fIaction\fR statement list enclosed in braces \fB{}\fR. D program code specified on the command line must be appropriately quoted to avoid intepretation of meta-characters by the shell. +The arguments accepted by the \fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, and +\fB-i\fR options can include an optional D language \fIpredicate\fR enclosed in +slashes \fB//\fR and optional D language \fIaction\fR statement list enclosed +in braces \fB{}\fR. D program code specified on the command line must be +appropriately quoted to avoid interpretation of meta-characters by the shell. .sp .LP The following options are supported: @@ -100,10 +103,17 @@ The following options are supported: .ad .sp .6 .RS 4n -The D compiler produces programs using the native data model of the operating system kernel. You can use the \fBisainfo\fR \fB-b\fR command to determine the current operating system data model. If the \fB-32\fR option is specified, \fBdtrace\fR forces -the D compiler to compile a D program using the 32-bit data model. If the \fB-64\fR option is specified, \fBdtrace\fR forces the D compiler to compile a D program using the 64-bit data model. These options are typically not required as \fBdtrace\fR selects the -native data model as the default. The data model affects the sizes of integer types and other language properties. D programs compiled for either data model can be executed on both 32-bit and 64-bit kernels. The \fB-32\fR and \fB-64\fR options also determine the ELF file format -(ELF32 or ELF64) produced by the \fB-G\fR option. +The D compiler produces programs using the native data model of the operating +system kernel. You can use the \fBisainfo\fR \fB-b\fR command to determine the +current operating system data model. If the \fB-32\fR option is specified, +\fBdtrace\fR forces the D compiler to compile a D program using the 32-bit data +model. If the \fB-64\fR option is specified, \fBdtrace\fR forces the D compiler +to compile a D program using the 64-bit data model. These options are typically +not required as \fBdtrace\fR selects the native data model as the default. The +data model affects the sizes of integer types and other language properties. D +programs compiled for either data model can be executed on both 32-bit and +64-bit kernels. The \fB-32\fR and \fB-64\fR options also determine the ELF file +format (ELF32 or ELF64) produced by the \fB-G\fR option. .RE .sp @@ -114,8 +124,11 @@ native data model as the default. The data model affects the sizes of integer ty .ad .sp .6 .RS 4n -Claim anonymous tracing state and display the traced data. You can combine the \fB-a\fR option with the \fB-e\fR option to force \fBdtrace\fR to exit immediately after consuming the anonymous tracing state rather than continuing to wait for new -data. See the \fISolaris Dynamic Tracing Guide\fR for more information about anonymous tracing. +Claim anonymous tracing state and display the traced data. You can combine the +\fB-a\fR option with the \fB-e\fR option to force \fBdtrace\fR to exit +immediately after consuming the anonymous tracing state rather than continuing +to wait for new data. See the \fISolaris Dynamic Tracing Guide\fR for more +information about anonymous tracing. .RE .sp @@ -126,7 +139,12 @@ data. See the \fISolaris Dynamic Tracing Guide\fR for more information about ano .ad .sp .6 .RS 4n -Generate \fBdriver.conf\fR(4) directives for anonymous tracing. This option constructs a set of \fBdtrace\fR(7D) configuration file directives to enable the specified probes for anonymous tracing and then exits. By default, \fBdtrace\fR attempts to store the directives to the file \fB/kernel/drv/dtrace.conf\fR. You can modify this behavior if you use the \fB-o\fR option to specify an alternate output file. +Generate \fBdriver.conf\fR(4) directives for anonymous tracing. This option +constructs a set of \fBdtrace\fR(7D) configuration file directives to enable +the specified probes for anonymous tracing and then exits. By default, +\fBdtrace\fR attempts to store the directives to the file +\fB/kernel/drv/dtrace.conf\fR. You can modify this behavior if you use the +\fB-o\fR option to specify an alternate output file. .RE .sp @@ -137,8 +155,10 @@ Generate \fBdriver.conf\fR(4) directives for anonymous tracing. This option cons .ad .sp .6 .RS 4n -Set principal trace buffer size (\fIbufsz\fR). The trace buffer size can include any of the size suffixes \fBk\fR, \fBm\fR, \fBg\fR, or \fBt\fR. If the buffer space cannot be allocated, \fBdtrace\fR attempts -to reduce the buffer size or exit depending on the setting of the \fBbufresize\fR property. +Set principal trace buffer size (\fIbufsz\fR). The trace buffer size can +include any of the size suffixes \fBk\fR, \fBm\fR, \fBg\fR, or \fBt\fR. If the +buffer space cannot be allocated, \fBdtrace\fR attempts to reduce the buffer +size or exit depending on the setting of the \fBbufresize\fR property. .RE .sp @@ -149,9 +169,13 @@ to reduce the buffer size or exit depending on the setting of the \fBbufresize\f .ad .sp .6 .RS 4n -Run the specified command \fIcmd\fR and exit upon its completion. If more than one \fB-c\fR option is present on the command line, \fBdtrace\fR exits when all commands have exited, reporting the exit status for each child process as it -terminates. The process-ID of the first command is made available to any D programs specified on the command line or using the \fB-s\fR option through the \fB$target\fR macro variable. Refer to the \fISolaris Dynamic Tracing Guide\fR for more information -on macro variables. +Run the specified command \fIcmd\fR and exit upon its completion. If more than +one \fB-c\fR option is present on the command line, \fBdtrace\fR exits when all +commands have exited, reporting the exit status for each child process as it +terminates. The process-ID of the first command is made available to any D +programs specified on the command line or using the \fB-s\fR option through the +\fB$target\fR macro variable. Refer to the \fISolaris Dynamic Tracing Guide\fR +for more information on macro variables. .RE .sp @@ -162,7 +186,11 @@ on macro variables. .ad .sp .6 .RS 4n -Run the C preprocessor \fBcpp\fR(1) over D programs before compiling them. You can pass options to the C preprocessor using the \fB-D\fR, \fB-U\fR, \fB-I\fR, and \fB-H\fR options. You can select the degree of C standard conformance if you use the \fB-X\fR option. For a description of the set of tokens defined by the D compiler when invoking the C preprocessor, see \fB-X\fR. +Run the C preprocessor \fBcpp\fR(1) over D programs before compiling them. You +can pass options to the C preprocessor using the \fB-D\fR, \fB-U\fR, \fB-I\fR, +and \fB-H\fR options. You can select the degree of C standard conformance if +you use the \fB-X\fR option. For a description of the set of tokens defined by +the D compiler when invoking the C preprocessor, see \fB-X\fR. .RE .sp @@ -173,8 +201,10 @@ Run the C preprocessor \fBcpp\fR(1) over D programs before compiling them. You c .ad .sp .6 .RS 4n -Define \fIname\fR when invoking \fBcpp\fR(1) (enabled using the \fB-C\fR option). If you specify the equals sign (\fB=\fR) -and additional \fIvalue\fR, the name is assigned the corresponding value. This option passes the \fB-D\fR option to each \fBcpp\fR invocation. +Define \fIname\fR when invoking \fBcpp\fR(1) (enabled using the \fB-C\fR +option). If you specify the equals sign (\fB=\fR) and additional \fIvalue\fR, +the name is assigned the corresponding value. This option passes the \fB-D\fR +option to each \fBcpp\fR invocation. .RE .sp @@ -185,21 +215,32 @@ and additional \fIvalue\fR, the name is assigned the corresponding value. This o .ad .sp .6 .RS 4n -Exit after compiling any requests and consuming anonymous tracing state (\fB-a\fR option) but prior to enabling any probes. You can combine this option with the \fB-a\fR option to print anonymous tracing data and exit. You can also combine this option with D -compiler options. This combination verifies that the programs compile without actually executing them and enabling the corresponding instrumentation. +Exit after compiling any requests and consuming anonymous tracing state +(\fB-a\fR option) but prior to enabling any probes. You can combine this option +with the \fB-a\fR option to print anonymous tracing data and exit. You can also +combine this option with D compiler options. This combination verifies that the +programs compile without actually executing them and enabling the corresponding +instrumentation. .RE .sp .ne 2 .mk .na -\fB\fB-f\fR\fB[[\fR\fIprovider\fR\fB:]\fR\fImodule\fR\fB:]\fR\fIfunction\fR\fB[[\fR\fIpredicate\fR\fB]\fR\fIaction\fR\fB]]\fR\fR +\fB\fB-f\fR\fB[[\fR\fIprovider\fR\fB:]\fR\fImodule\fR\fB:]\fR\fIfunction\fR\fB[ +[\fR\fIpredicate\fR\fB]\fR\fIaction\fR\fB]]\fR\fR .ad .sp .6 .RS 4n -Specify function name to trace or list (\fB-l\fR option). The corresponding argument can include any of the probe description forms \fIprovider:module:function\fR, \fImodule:function\fR, or \fIfunction\fR. -Unspecified probe description fields are left blank and match any probes regardless of the values in those fields. If no qualifiers other than \fIfunction\fR are specified in the description, all probes with the corresponding \fIfunction\fR are matched. -The \fB-f\fR argument can be suffixed with an optional D probe clause. You can specify more than one \fB-f\fR option on the command line at a time. +Specify function name to trace or list (\fB-l\fR option). The corresponding +argument can include any of the probe description forms +\fIprovider:module:function\fR, \fImodule:function\fR, or \fIfunction\fR. +Unspecified probe description fields are left blank and match any probes +regardless of the values in those fields. If no qualifiers other than +\fIfunction\fR are specified in the description, all probes with the +corresponding \fIfunction\fR are matched. The \fB-f\fR argument can be suffixed +with an optional D probe clause. You can specify more than one \fB-f\fR option +on the command line at a time. .RE .sp @@ -210,8 +251,12 @@ The \fB-f\fR argument can be suffixed with an optional D probe clause. You can s .ad .sp .6 .RS 4n -Coalesce trace output by identifying function entry and return. Function entry probe reports are indented and their output is prefixed with \fB->\fR. Function return probe reports are unindented and their output is prefixed with \fB<-\fR\&. System call -entry probe reports are indented and their output is prefixed with \fB=>\fR. System call return probe reports are unindented and their output is prefixed with \fB<=\fR\&. +Coalesce trace output by identifying function entry and return. Function entry +probe reports are indented and their output is prefixed with \fB->\fR. Function +return probe reports are unindented and their output is prefixed with +\fB<-\fR\&. System call entry probe reports are indented and their output is +prefixed with \fB=>\fR. System call return probe reports are unindented and +their output is prefixed with \fB<=\fR\&. .RE .sp @@ -222,9 +267,14 @@ entry probe reports are indented and their output is prefixed with \fB=>\fR. Sys .ad .sp .6 .RS 4n -Generate an ELF file containing an embedded DTrace program. The DTrace probes specified in the program are saved inside of a relocatable ELF object which can be linked into another program. If the \fB-o\fR option is present, the ELF file is saved using the pathname specified -as the argument for this operand. If the \fB-o\fR option is not present and the DTrace program is contained with a file whose name is \fB\fIfilename\fR.d\fR, then the ELF file is saved using the name \fB\fIfilename\fR.o\fR. -Otherwise the ELF file is saved using the name \fBd.out\fR. +Generate an ELF file containing an embedded DTrace program. The DTrace probes +specified in the program are saved inside of a relocatable ELF object which can +be linked into another program. If the \fB-o\fR option is present, the ELF file +is saved using the pathname specified as the argument for this operand. If the +\fB-o\fR option is not present and the DTrace program is contained with a file +whose name is \fB\fIfilename\fR.d\fR, then the ELF file is saved using the name +\fB\fIfilename\fR.o\fR. Otherwise the ELF file is saved using the name +\fBd.out\fR. .RE .sp @@ -235,8 +285,10 @@ Otherwise the ELF file is saved using the name \fBd.out\fR. .ad .sp .6 .RS 4n -Print the pathnames of included files when invoking \fBcpp\fR(1) (enabled using the \fB-C\fR option). This option passes the \fB-H\fR option -to each \fBcpp\fR invocation, causing it to display the list of pathnames, one for each line, to \fBstderr\fR. +Print the pathnames of included files when invoking \fBcpp\fR(1) (enabled using +the \fB-C\fR option). This option passes the \fB-H\fR option to each \fBcpp\fR +invocation, causing it to display the list of pathnames, one for each line, to +\fBstderr\fR. .RE .sp @@ -247,9 +299,14 @@ to each \fBcpp\fR invocation, causing it to display the list of pathnames, one f .ad .sp .6 .RS 4n -Generate a header file containing macros that correspond to probes in the specified provider definitions. This option should be used to generate a header file that is included by other source files for later use with the \fB-G\fR option. If the \fB-o\fR option -is present, the header file is saved using the pathname specified as the argument for that option. If the \fB-o\fR option is not present and the DTrace program is contained with a file whose name is \fIfilename\fR\fB\&.d\fR, then the header file is saved -using the name \fIfilename\fR\fB\&.h\fR. +Generate a header file containing macros that correspond to probes in the +specified provider definitions. This option should be used to generate a header +file that is included by other source files for later use with the \fB-G\fR +option. If the \fB-o\fR option is present, the header file is saved using the +pathname specified as the argument for that option. If the \fB-o\fR option is +not present and the DTrace program is contained with a file whose name is +\fIfilename\fR\fB\&.d\fR, then the header file is saved using the name +\fIfilename\fR\fB\&.h\fR. .RE .sp @@ -260,8 +317,10 @@ using the name \fIfilename\fR\fB\&.h\fR. .ad .sp .6 .RS 4n -Specify probe identifier (\fIprobe-id\fR) to trace or list (\fB-l\fR option). You can specify probe IDs using decimal integers as shown by \fBdtrace\fR \fB-l\fR. The \fB-i\fR argument can be suffixed with an optional -D probe clause. You can specify more than one \fB-i\fR option at a time. +Specify probe identifier (\fIprobe-id\fR) to trace or list (\fB-l\fR option). +You can specify probe IDs using decimal integers as shown by \fBdtrace\fR +\fB-l\fR. The \fB-i\fR argument can be suffixed with an optional D probe +clause. You can specify more than one \fB-i\fR option at a time. .RE .sp @@ -272,8 +331,11 @@ D probe clause. You can specify more than one \fB-i\fR option at a time. .ad .sp .6 .RS 4n -Add the specified directory \fIpath\fR to the search path for \fB#include\fR files when invoking \fBcpp\fR(1) (enabled -using the \fB-C\fR option). This option passes the \fB-I\fR option to each \fBcpp\fR invocation. The specified \fIpath\fR is inserted into the search path ahead of the default directory list. +Add the specified directory \fIpath\fR to the search path for \fB#include\fR +files when invoking \fBcpp\fR(1) (enabled using the \fB-C\fR option). This +option passes the \fB-I\fR option to each \fBcpp\fR invocation. The specified +\fIpath\fR is inserted into the search path ahead of the default directory +list. .RE .sp @@ -284,7 +346,9 @@ using the \fB-C\fR option). This option passes the \fB-I\fR option to each \fBcp .ad .sp .6 .RS 4n -Add the specified directory \fIpath\fR to the search path for DTrace libraries. DTrace libraries are used to contain common definitions that can be used when writing D programs. The specified \fIpath\fR is added after the default library +Add the specified directory \fIpath\fR to the search path for DTrace libraries. +DTrace libraries are used to contain common definitions that can be used when +writing D programs. The specified \fIpath\fR is added after the default library search path. .RE @@ -296,34 +360,49 @@ search path. .ad .sp .6 .RS 4n -List probes instead of enabling them. If the \fB-l\fR option is specified, \fBdtrace\fR produces a report of the probes matching the descriptions given using the \fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, \fB-i\fR, -and \fB-s\fR options. If none of these options are specified, this option lists all probes. +List probes instead of enabling them. If the \fB-l\fR option is specified, +\fBdtrace\fR produces a report of the probes matching the descriptions given +using the \fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, \fB-i\fR, and \fB-s\fR +options. If none of these options are specified, this option lists all probes. .RE .sp .ne 2 .mk .na -\fB\fB-m\fR [[\fIprovider:\fR] \fImodule:\fR [[\fIpredicate\fR] \fIaction\fR]]\fR +\fB\fB-m\fR [[\fIprovider:\fR] \fImodule:\fR [[\fIpredicate\fR] +\fIaction\fR]]\fR .ad .sp .6 .RS 4n -Specify module name to trace or list (\fB-l\fR option). The corresponding argument can include any of the probe description forms \fIprovider:module\fR or \fImodule\fR. Unspecified probe description fields are left blank and match -any probes regardless of the values in those fields. If no qualifiers other than \fImodule\fR are specified in the description, all probes with a corresponding \fImodule\fR are matched. The \fB-m\fR argument can be suffixed with an optional D -probe clause. More than one \fB-m\fR option can be specified on the command line at a time. +Specify module name to trace or list (\fB-l\fR option). The corresponding +argument can include any of the probe description forms \fIprovider:module\fR +or \fImodule\fR. Unspecified probe description fields are left blank and match +any probes regardless of the values in those fields. If no qualifiers other +than \fImodule\fR are specified in the description, all probes with a +corresponding \fImodule\fR are matched. The \fB-m\fR argument can be suffixed +with an optional D probe clause. More than one \fB-m\fR option can be specified +on the command line at a time. .RE .sp .ne 2 .mk .na -\fB\fB-n\fR [[[\fIprovider:\fR] \fImodule:\fR] \fIfunction:\fR] \fIname\fR [[\fIpredicate\fR] \fIaction\fR]\fR +\fB\fB-n\fR [[[\fIprovider:\fR] \fImodule:\fR] \fIfunction:\fR] \fIname\fR +[[\fIpredicate\fR] \fIaction\fR]\fR .ad .sp .6 .RS 4n -Specify probe name to trace or list (\fB-l\fR option). The corresponding argument can include any of the probe description forms \fIprovider:module:function:name\fR, \fImodule:function:name\fR, \fIfunction:name\fR, -or \fIname\fR. Unspecified probe description fields are left blank and match any probes regardless of the values in those fields. If no qualifiers other than \fIname\fR are specified in the description, all probes with a corresponding \fIname\fR are -matched. The \fB-n\fR argument can be suffixed with an optional D probe clause. More than one \fB-n\fR option can be specified on the command line at a time. +Specify probe name to trace or list (\fB-l\fR option). The corresponding +argument can include any of the probe description forms +\fIprovider:module:function:name\fR, \fImodule:function:name\fR, +\fIfunction:name\fR, or \fIname\fR. Unspecified probe description fields are +left blank and match any probes regardless of the values in those fields. If no +qualifiers other than \fIname\fR are specified in the description, all probes +with a corresponding \fIname\fR are matched. The \fB-n\fR argument can be +suffixed with an optional D probe clause. More than one \fB-n\fR option can be +specified on the command line at a time. .RE .sp @@ -334,8 +413,13 @@ matched. The \fB-n\fR argument can be suffixed with an optional D probe clause. .ad .sp .6 .RS 4n -Specify the \fIoutput\fR file for the \fB-A\fR , \fB-G\fR, and \fB-l\fR options, or for the traced data itself. If the \fB-A\fR option is present and \fB-o\fR is not present, the default output file is \fB/kernel/drv/dtrace.conf\fR. If the \fB-G\fR option is present and the \fB-s\fR option's argument is of the form \fB\fIfilename\fR.d\fR and \fB-o\fR is not present, the default output file is \fB\fIfilename\fR.o\fR. -Otherwise the default output file is \fBd.out\fR. +Specify the \fIoutput\fR file for the \fB-A\fR , \fB-G\fR, \fB-h\fR, and +\fB-l\fR options, or for the traced data itself. If the \fB-A\fR option is +present and \fB-o\fR is not present, the default output file is +\fB/kernel/drv/dtrace.conf\fR. If the \fB-G\fR option is present and the +\fB-s\fR option's argument is of the form \fB\fIfilename\fR.d\fR and \fB-o\fR +is not present, the default output file is \fB\fIfilename\fR.o\fR. Otherwise +the default output file is \fBd.out\fR. .RE .sp @@ -346,9 +430,13 @@ Otherwise the default output file is \fBd.out\fR. .ad .sp .6 .RS 4n -Grab the specified process-ID \fIpid\fR, cache its symbol tables, and exit upon its completion. If more than one \fB-p\fR option is present on the command line, \fBdtrace\fR exits when all commands have exited, reporting the exit status -for each process as it terminates. The first process-ID is made available to any D programs specified on the command line or using the \fB-s\fR option through the \fB$target\fR macro variable. Refer to the \fISolaris Dynamic Tracing Guide\fR for -more information on macro variables. +Grab the specified process-ID \fIpid\fR, cache its symbol tables, and exit upon +its completion. If more than one \fB-p\fR option is present on the command +line, \fBdtrace\fR exits when all commands have exited, reporting the exit +status for each process as it terminates. The first process-ID is made +available to any D programs specified on the command line or using the \fB-s\fR +option through the \fB$target\fR macro variable. Refer to the \fISolaris +Dynamic Tracing Guide\fR for more information on macro variables. .RE .sp @@ -359,8 +447,11 @@ more information on macro variables. .ad .sp .6 .RS 4n -Specify provider name to trace or list (\fB-l\fR option). The remaining probe description fields module, function, and name are left blank and match any probes regardless of the values in those fields. The \fB-P\fR argument can be suffixed with an optional D -probe clause. You can specify more than one \fB-P\fR option on the command line at a time. +Specify provider name to trace or list (\fB-l\fR option). The remaining probe +description fields module, function, and name are left blank and match any +probes regardless of the values in those fields. The \fB-P\fR argument can be +suffixed with an optional D probe clause. You can specify more than one +\fB-P\fR option on the command line at a time. .RE .sp @@ -371,8 +462,11 @@ probe clause. You can specify more than one \fB-P\fR option on the command line .ad .sp .6 .RS 4n -Set quiet mode. \fBdtrace\fR suppresses messages such as the number of probes matched by the specified options and D programs and does not print column headers, the CPU ID, the probe ID, or insert newlines into the output. Only data traced and formatted by D program -statements such as \fBtrace()\fR and \fBprintf()\fR is displayed to \fBstdout\fR. +Set quiet mode. \fBdtrace\fR suppresses messages such as the number of probes +matched by the specified options and D programs and does not print column +headers, the CPU ID, the probe ID, or insert newlines into the output. Only +data traced and formatted by D program statements such as \fBtrace()\fR and +\fBprintf()\fR is displayed to \fBstdout\fR. .RE .sp @@ -383,8 +477,12 @@ statements such as \fBtrace()\fR and \fBprintf()\fR is displayed to \fBstdout\fR .ad .sp .6 .RS 4n -Compile the specified D program source file. If the \fB-e\fR option is present, the program is compiled but instrumentation is not enabled. If the \fB-l\fR option is present, the program is compiled and the set of probes matched by it is listed, but instrumentation -is not enabled. If none of \fB-e\fR, \fB-l\fR, \fB-G\fR, or \fB-A\fR are present, the instrumentation specified by the D program is enabled and tracing begins. +Compile the specified D program source file. If the \fB-e\fR option is present, +the program is compiled but instrumentation is not enabled. If the \fB-l\fR +option is present, the program is compiled and the set of probes matched by it +is listed, but instrumentation is not enabled. If none of \fB-e\fR, \fB-l\fR, +\fB-G\fR, or \fB-A\fR are present, the instrumentation specified by the D +program is enabled and tracing begins. .RE .sp @@ -395,7 +493,8 @@ is not enabled. If none of \fB-e\fR, \fB-l\fR, \fB-G\fR, or \fB-A\fR are present .ad .sp .6 .RS 4n -Show D compiler intermediate code. The D compiler produces a report of the intermediate code generated for each D program to \fBstderr\fR. +Show D compiler intermediate code. The D compiler produces a report of the +intermediate code generated for each D program to \fBstderr\fR. .RE .sp @@ -406,7 +505,9 @@ Show D compiler intermediate code. The D compiler produces a report of the inter .ad .sp .6 .RS 4n -Undefine the specified \fIname\fR when invoking \fBcpp\fR(1) (enabled using the \fB-C\fR option). This option passes the \fB-U\fR option to each \fBcpp\fR invocation. +Undefine the specified \fIname\fR when invoking \fBcpp\fR(1) (enabled using the +\fB-C\fR option). This option passes the \fB-U\fR option to each \fBcpp\fR +invocation. .RE .sp @@ -417,7 +518,10 @@ Undefine the specified \fIname\fR when invoking \fBcpp\fR(1) (enabled using the .ad .sp .6 .RS 4n -Set verbose mode. If the \fB-v\fR option is specified, \fBdtrace\fR produces a program stability report showing the minimum interface stability and dependency level for the specified D programs. DTrace stability levels are explained in further detail in the \fISolaris Dynamic Tracing Guide\fR. +Set verbose mode. If the \fB-v\fR option is specified, \fBdtrace\fR produces a +program stability report showing the minimum interface stability and dependency +level for the specified D programs. DTrace stability levels are explained in +further detail in the \fISolaris Dynamic Tracing Guide\fR. .RE .sp @@ -428,8 +532,10 @@ Set verbose mode. If the \fB-v\fR option is specified, \fBdtrace\fR produces a p .ad .sp .6 .RS 4n -Report the highest D programming interface version supported by \fBdtrace\fR. The version information is printed to \fBstdout\fR and the \fBdtrace\fR command exits. Refer to the \fISolaris Dynamic Tracing Guide\fR for -more information about DTrace versioning features. +Report the highest D programming interface version supported by \fBdtrace\fR. +The version information is printed to \fBstdout\fR and the \fBdtrace\fR command +exits. Refer to the \fISolaris Dynamic Tracing Guide\fR for more information +about DTrace versioning features. .RE .sp @@ -440,8 +546,10 @@ more information about DTrace versioning features. .ad .sp .6 .RS 4n -Permit destructive actions in D programs specified using the \fB-s\fR, \fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, or \fB-i\fR options. If the \fB-w\fR option is not specified, \fBdtrace\fR does not -permit the compilation or enabling of a D program that contains destructive actions. +Permit destructive actions in D programs specified using the \fB-s\fR, +\fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, or \fB-i\fR options. If the \fB-w\fR +option is not specified, \fBdtrace\fR does not permit the compilation or +enabling of a D program that contains destructive actions. .RE .sp @@ -452,8 +560,10 @@ permit the compilation or enabling of a D program that contains destructive acti .ad .sp .6 .RS 4n -Enable or modify a DTrace runtime option or D compiler option. The list of options is found in the \fISolaris Dynamic Tracing Guide\fR. Boolean options are enabled by specifying their name. Options with values are set by separating the option name and -value with an equals sign (\fB=\fR). +Enable or modify a DTrace runtime option or D compiler option. The list of +options is found in the \fISolaris Dynamic Tracing Guide\fR. Boolean options +are enabled by specifying their name. Options with values are set by separating +the option name and value with an equals sign (\fB=\fR). .RE .sp @@ -464,8 +574,10 @@ value with an equals sign (\fB=\fR). .ad .sp .6 .RS 4n -Specify the degree of conformance to the ISO C standard that should be selected when invoking \fBcpp\fR(1) (enabled using the \fB-C\fR option). -The \fB-X\fR option argument affects the value and presence of the \fB__STDC__\fR macro depending upon the value of the argument letter. +Specify the degree of conformance to the ISO C standard that should be selected +when invoking \fBcpp\fR(1) (enabled using the \fB-C\fR option). The \fB-X\fR +option argument affects the value and presence of the \fB__STDC__\fR macro +depending upon the value of the argument letter. .sp The \fB-X\fR option supports the following arguments: .sp @@ -476,8 +588,10 @@ The \fB-X\fR option supports the following arguments: .ad .RS 5n .rt -Default. ISO C plus K&R compatibility extensions, with semantic changes required by ISO C. This is the default mode if \fB-X\fR is not specified. The predefined macro \fB__STDC__\fR has a value of 0 when \fBcpp\fR is invoked in conjunction -with the \fB-Xa\fR option. +Default. ISO C plus K&R compatibility extensions, with semantic changes +required by ISO C. This is the default mode if \fB-X\fR is not specified. The +predefined macro \fB__STDC__\fR has a value of 0 when \fBcpp\fR is invoked in +conjunction with the \fB-Xa\fR option. .RE .sp @@ -488,7 +602,9 @@ with the \fB-Xa\fR option. .ad .RS 5n .rt -Conformance. Strictly conformant ISO C, without K&R C compatibility extensions. The predefined macro \fB__STDC__\fR has a value of 1 when \fBcpp\fR is invoked in conjunction with the \fB-Xc\fR option. +Conformance. Strictly conformant ISO C, without K&R C compatibility extensions. +The predefined macro \fB__STDC__\fR has a value of 1 when \fBcpp\fR is invoked +in conjunction with the \fB-Xc\fR option. .RE .sp @@ -499,7 +615,8 @@ Conformance. Strictly conformant ISO C, without K&R C compatibility extensions. .ad .RS 5n .rt -K&R C only. The macro \fB__STDC__\fR is not defined when \fBcpp\fR is invoked in conjunction with the \fB-Xs\fR option. +K&R C only. The macro \fB__STDC__\fR is not defined when \fBcpp\fR is invoked +in conjunction with the \fB-Xs\fR option. .RE .sp @@ -510,12 +627,18 @@ K&R C only. The macro \fB__STDC__\fR is not defined when \fBcpp\fR is invoked in .ad .RS 5n .rt -Transition. ISO C plus K&R C compatibility extensions, without semantic changes required by ISO C. The predefined macro \fB__STDC__\fR has a value of 0 when \fBcpp\fR is invoked in conjunction with the \fB-Xt\fR option. +Transition. ISO C plus K&R C compatibility extensions, without semantic changes +required by ISO C. The predefined macro \fB__STDC__\fR has a value of 0 when +\fBcpp\fR is invoked in conjunction with the \fB-Xt\fR option. .RE -As the \fB-X\fR option only affects how the D compiler invokes the C preprocessor, the \fB-Xa\fR and \fB-Xt\fR options are equivalent from the perspective of D and both are provided only to ease re-use of settings from a C build environment. +As the \fB-X\fR option only affects how the D compiler invokes the C +preprocessor, the \fB-Xa\fR and \fB-Xt\fR options are equivalent from the +perspective of D and both are provided only to ease re-use of settings from a C +build environment. .sp -Regardless of the \fB-X\fR mode, the following additional C preprocessor definitions are always specified and valid in all modes: +Regardless of the \fB-X\fR mode, the following additional C preprocessor +definitions are always specified and valid in all modes: .RS +4 .TP .ie t \(bu @@ -576,8 +699,10 @@ Regardless of the \fB-X\fR mode, the following additional C preprocessor definit .el o \fB__SUNW_D_VERSION=0x\fIMMmmmuuu\fR\fR .sp -Where \fIMM\fR is the major release value in hexadecimal, \fImmm\fR is the minor release value in hexadecimal, and \fIuuu\fR is the -micro release value in hexadecimal. Refer to the \fISolaris Dynamic Tracing Guide\fR for more information about DTrace versioning. +Where \fIMM\fR is the major release value in hexadecimal, \fImmm\fR is the +minor release value in hexadecimal, and \fIuuu\fR is the micro release value in +hexadecimal. Refer to the \fISolaris Dynamic Tracing Guide\fR for more +information about DTrace versioning. .RE .RE @@ -589,14 +714,21 @@ micro release value in hexadecimal. Refer to the \fISolaris Dynamic Tracing Guid .ad .sp .6 .RS 4n -Permit probe descriptions that match zero probes. If the \fB-Z\fR option is not specified, \fBdtrace\fR reports an error and exits if any probe descriptions specified in D program files (\fB-s\fR option) or on the command line (\fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, or \fB-i\fR options) contain descriptions that do not match any known probes. +Permit probe descriptions that match zero probes. If the \fB-Z\fR option is not +specified, \fBdtrace\fR reports an error and exits if any probe descriptions +specified in D program files (\fB-s\fR option) or on the command line +(\fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, or \fB-i\fR options) contain +descriptions that do not match any known probes. .RE .SH OPERANDS .sp .LP -You can specify zero or more additional arguments on the \fBdtrace\fR command line to define a set of macro variables (\fB$1\fR, \fB$2\fR, and so forth). The additional arguments can be used in D programs specified using the \fB-s\fR option -or on the command line. The use of macro variables is described further in the \fISolaris Dynamic Tracing Guide\fR. +You can specify zero or more additional arguments on the \fBdtrace\fR command +line to define a set of macro variables (\fB$1\fR, \fB$2\fR, and so forth). The +additional arguments can be used in D programs specified using the \fB-s\fR +option or on the command line. The use of macro variables is described further +in the \fISolaris Dynamic Tracing Guide\fR. .SH EXIT STATUS .sp .LP @@ -609,10 +741,12 @@ The following exit values are returned: .ad .RS 5n .rt -Successful completion. +Successful completion. .sp -For D program requests, an exit status of \fB0\fR indicates that programs were successfully compiled, probes were successfully enabled, or anonymous state was successfully retrieved. \fBdtrace\fR returns \fB0\fR even if the specified tracing requests -encountered errors or drops. +For D program requests, an exit status of \fB0\fR indicates that programs were +successfully compiled, probes were successfully enabled, or anonymous state was +successfully retrieved. \fBdtrace\fR returns \fB0\fR even if the specified +tracing requests encountered errors or drops. .RE .sp @@ -625,7 +759,8 @@ encountered errors or drops. .rt An error occurred. .sp -For D program requests, an exit status of \fB1\fR indicates that program compilation failed or that the specified request could not be satisfied. +For D program requests, an exit status of \fB1\fR indicates that program +compilation failed or that the specified request could not be satisfied. .RE .sp @@ -653,8 +788,6 @@ lw(2.75i) |lw(2.75i) . ATTRIBUTE TYPEATTRIBUTE VALUE _ -AvailabilitySUNWdtrc -_ Interface StabilitySee below. .TE @@ -664,7 +797,19 @@ The command-line syntax is Committed. The human-readable output is Uncommitted. .SH SEE ALSO .sp .LP -\fBcpp\fR(1), \fBisainfo\fR(1), \fBlibdtrace\fR(3LIB), \fBdriver.conf\fR(4), \fBattributes\fR(5), \fBdtrace\fR(7D) +\fBcpp\fR(1), \fBisainfo\fR(1), \fBssh\fR(1), \fBlibdtrace\fR(3LIB), +\fBdriver.conf\fR(4), \fBattributes\fR(5), \fBdtrace\fR(7D) .sp .LP \fISolaris Dynamic Tracing Guide\fR +.SH USAGE +.sp +.LP +When using the \fB-p\fR flag, \fBdtrace\fR stops the target processes while it +is inspecting them and reporting results. A process can do nothing while it is +stopped. This means that, if , for example, the X server is inspected by +\fBdtrace\fR running in a window under the X server's control, the whole window +system can become deadlocked, because the \fBproc\fR tool would be attempting +to display its results to a window that cannot be refreshed. In such a case, +logging in from another system using \fBssh\fR(1) and killing the offending +\fBproc\fR tool clears the deadlock. diff --git a/man/man1m/lockstat.1m b/man/man1m/lockstat.1m index 8c7eb1749416d..495b294056150 100644 --- a/man/man1m/lockstat.1m +++ b/man/man1m/lockstat.1m @@ -3,16 +3,16 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH LOCKSTAT 1M "Feb 28, 2008" +.TH lockstat 1M "28 Feb 2008" "SunOS 5.11" "System Administration Commands" .SH NAME lockstat \- report kernel lock and profiling statistics .SH SYNOPSIS .LP .nf -\fBlockstat\fR [\fB-ACEHI\fR] [\fB-e\fR \fIevent_list\fR] [\fB-i\fR \fIrate\fR] - [\fB-b\fR | \fB-t\fR | \fB-h\fR | \fB-s\fR \fIdepth\fR] [\fB-n\fR \fInrecords\fR] - [\fB-l\fR \fIlock\fR [, \fIsize\fR]] [\fB-d\fR \fIduration\fR] - [\fB-f\fR \fIfunction\fR [, \fIsize\fR]] [\fB-T\fR] [\fB-ckgwWRpP\fR] [\fB-D\fR \fIcount\fR] +\fBlockstat\fR [\fB-ACEHI\fR] [\fB-e\fR \fIevent_list\fR] [\fB-i\fR \fIrate\fR] + [\fB-b\fR | \fB-t\fR | \fB-h\fR | \fB-s\fR \fIdepth\fR] [\fB-n\fR \fInrecords\fR] + [\fB-l\fR \fIlock\fR [, \fIsize\fR]] [\fB-d\fR \fIduration\fR] + [\fB-f\fR \fIfunction\fR [, \fIsize\fR]] [\fB-T\fR] [\fB-ckgwWRpP\fR] [\fB-D\fR \fIcount\fR] [\fB-o\fR \fIfilename\fR] [\fB-x\fR \fIopt\fR [=val]] \fIcommand\fR [\fIargs\fR] .fi @@ -61,6 +61,7 @@ The following options are supported: If no event selection options are specified, the default is \fB-C\fR. .sp .ne 2 +.mk .na \fB\fB-A\fR\fR .ad @@ -71,6 +72,7 @@ Watch all lock events. \fB-A\fR is equivalent to \fB-CH\fR. .sp .ne 2 +.mk .na \fB\fB-C\fR\fR .ad @@ -81,6 +83,7 @@ Watch contention events. .sp .ne 2 +.mk .na \fB\fB-E\fR\fR .ad @@ -91,6 +94,7 @@ Watch error events. .sp .ne 2 +.mk .na \fB\fB\fR\fB-e\fR \fIevent_list\fR\fR .ad @@ -103,6 +107,7 @@ arguments to get a brief description of all events. .sp .ne 2 +.mk .na \fB\fB-H\fR\fR .ad @@ -113,6 +118,7 @@ Watch hold events. .sp .ne 2 +.mk .na \fB\fB-I\fR\fR .ad @@ -123,6 +129,7 @@ Watch profiling interrupt events. .sp .ne 2 +.mk .na \fB\fB\fR\fB-i\fR \fIrate\fR\fR .ad @@ -136,6 +143,7 @@ Hz). .SS "Data Gathering" .sp .ne 2 +.mk .na \fB\fB-x\fR \fIarg\fR[=\fIval\fR]\fR .ad @@ -150,6 +158,7 @@ an equals sign (=). .SS "Data Gathering (Mutually Exclusive)" .sp .ne 2 +.mk .na \fB\fB-b\fR\fR .ad @@ -160,6 +169,7 @@ Basic statistics: lock, caller, number of events. .sp .ne 2 +.mk .na \fB\fB-h\fR\fR .ad @@ -170,6 +180,7 @@ Histogram: Timing plus time-distribution histograms. .sp .ne 2 +.mk .na \fB\fB\fR\fB-s\fR \fIdepth\fR\fR .ad @@ -180,6 +191,7 @@ Stack trace: Histogram plus stack traces up to \fIdepth\fR frames deep. .sp .ne 2 +.mk .na \fB\fB-t\fR\fR .ad @@ -191,6 +203,7 @@ Timing: Basic plus timing for all events [default]. .SS "Data Filtering" .sp .ne 2 +.mk .na \fB\fB\fR\fB-d\fR \fIduration\fR\fR .ad @@ -201,6 +214,7 @@ Only watch events longer than \fIduration\fR. .sp .ne 2 +.mk .na \fB\fB\fR\fB-f\fR \fIfunc[,size]\fR\fR .ad @@ -213,6 +227,7 @@ available, or \fB1\fR if not. .sp .ne 2 +.mk .na \fB\fB\fR\fB-l\fR \fIlock[,size]\fR\fR .ad @@ -225,6 +240,7 @@ symbol size is not available. .sp .ne 2 +.mk .na \fB\fB\fR\fB-n\fR \fInrecords\fR\fR .ad @@ -235,6 +251,7 @@ Maximum number of data records. .sp .ne 2 +.mk .na \fB\fB-T\fR\fR .ad @@ -246,6 +263,7 @@ Trace (rather than sample) events [off by default]. .SS "Data Reporting" .sp .ne 2 +.mk .na \fB\fB-c\fR\fR .ad @@ -256,6 +274,7 @@ Coalesce lock data for lock arrays (for example, \fBpse_mutex[]\fR). .sp .ne 2 +.mk .na \fB\fB\fR\fB-D\fR \fIcount\fR\fR .ad @@ -266,6 +285,7 @@ Only display the top \fIcount\fR events of each type. .sp .ne 2 +.mk .na \fB\fB-g\fR\fR .ad @@ -284,6 +304,7 @@ issue (1), the default data gathering mode when using \fB-g\fR is \fB-s\fR .sp .ne 2 +.mk .na \fB\fB-k\fR\fR .ad @@ -294,6 +315,7 @@ Coalesce PCs within functions. .sp .ne 2 +.mk .na \fB\fB\fR\fB-o\fR \fIfilename\fR\fR .ad @@ -304,6 +326,7 @@ Direct output to \fIfilename\fR. .sp .ne 2 +.mk .na \fB\fB-P\fR\fR .ad @@ -314,6 +337,7 @@ Sort data by (\fIcount * time\fR) product. .sp .ne 2 +.mk .na \fB\fB-p\fR\fR .ad @@ -324,6 +348,7 @@ Parsable output format. .sp .ne 2 +.mk .na \fB\fB-R\fR\fR .ad @@ -334,6 +359,7 @@ Display rates (events per second) rather than counts. .sp .ne 2 +.mk .na \fB\fB-W\fR\fR .ad @@ -344,6 +370,7 @@ Whichever: distinguish events only by caller, not by lock. .sp .ne 2 +.mk .na \fB\fB-w\fR\fR .ad @@ -358,6 +385,7 @@ Wherever: distinguish events only by lock, not by caller. The following headers appear over various columns of data. .sp .ne 2 +.mk .na \fB\fBCount\fR or \fBops/s\fR\fR .ad @@ -369,6 +397,7 @@ was specified. .sp .ne 2 +.mk .na \fB\fBindv\fR\fR .ad @@ -379,6 +408,7 @@ Percentage of all events represented by this individual event. .sp .ne 2 +.mk .na \fB\fBgenr\fR\fR .ad @@ -389,6 +419,7 @@ Percentage of all events generated by this function. .sp .ne 2 +.mk .na \fB\fBcuml\fR\fR .ad @@ -399,6 +430,7 @@ Cumulative percentage; a running total of the individuals. .sp .ne 2 +.mk .na \fB\fBrcnt\fR\fR .ad @@ -411,6 +443,7 @@ for shared locks (rwlocks held as reader). .sp .ne 2 +.mk .na \fB\fBnsec\fR\fR .ad @@ -422,6 +455,7 @@ For the profiling event, duration means interrupt latency. .sp .ne 2 +.mk .na \fB\fBLock\fR\fR .ad @@ -432,6 +466,7 @@ Address of the lock; displayed symbolically if possible. .sp .ne 2 +.mk .na \fB\fBCPU+PIL\fR\fR .ad @@ -443,6 +478,7 @@ Address of the lock; displayed symbolically if possible. .sp .ne 2 +.mk .na \fB\fBCaller\fR\fR .ad @@ -764,7 +800,7 @@ Count indv cuml rcnt nsec Lock Caller Profiling interrupt: 229 events in 10.042 seconds (23 events/sec) Count indv cuml rcnt nsec Hottest CPU+PIL Caller - + ------------------------------------------------------------------------- 89 39% 39% 1.00 426 cpu[0]+6 sync_stream_buf 64 28% 67% 1.00 398 cpu[0]+6 sbus_intr_wrapper @@ -819,7 +855,7 @@ Count indv cuml rcnt nsec CPU+PIL Caller 1929 40% 40% 0.00 3215 cpu[0] usec_delay+0x78 nsec ------ Time Distribution ------ count Stack 4096 |@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 1872 ata_wait+0x90 - 8192 | 27 acersb_get_intr_status+0x34 + 8192 | 27 acersb_get_intr_status+0x34 16384 | 29 ata_set_feature+0x124 32768 | 1 ata_disk_start+0x15c ata_hba_start+0xbc diff --git a/man/man1m/plockstat.1m b/man/man1m/plockstat.1m index b24f36d67d0b5..18a9d2ec6f280 100644 --- a/man/man1m/plockstat.1m +++ b/man/man1m/plockstat.1m @@ -3,19 +3,19 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH PLOCKSTAT 1M "Jan 26, 2009" +.TH plockstat 1M "26 Jan 2009" "SunOS 5.11" "System Administration Commands" .SH NAME plockstat \- report user-level lock statistics .SH SYNOPSIS .LP .nf -\fBplockstat\fR [\fB-vACHV\fR] [\fB-n\fR \fIcount\fR] [\fB-s\fR \fIdepth\fR] [\fB-e\fR \fIsecs\fR] +\fBplockstat\fR [\fB-vACHV\fR] [\fB-n\fR \fIcount\fR] [\fB-s\fR \fIdepth\fR] [\fB-e\fR \fIsecs\fR] [\fB-x\fR \fIarg\fR [=val]] \fIcommand\fR [\fIarg\fR]... .fi .LP .nf -\fBplockstat\fR [\fB-vACHV\fR] [\fB-n\fR \fIcount\fR] [\fB-s\fR \fIdepth\fR] [\fB-e\fR \fIsecs\fR] +\fBplockstat\fR [\fB-vACHV\fR] [\fB-n\fR \fIcount\fR] [\fB-s\fR \fIdepth\fR] [\fB-e\fR \fIsecs\fR] [\fB-x\fR \fIarg\fR [=val]] \fB-p\fR \fIpid\fR .fi @@ -44,82 +44,100 @@ security features. The following options are supported: .sp .ne 2 +.mk .na \fB\fB-A\fR\fR .ad .RS 16n +.rt Watch all lock events. This option is equivalent to \fB-CH\fR. .RE .sp .ne 2 +.mk .na \fB\fB-C\fR\fR .ad .RS 16n +.rt Watch contention events. .RE .sp .ne 2 +.mk .na \fB\fB-H\fR\fR .ad .RS 16n +.rt Watch hold events. .RE .sp .ne 2 +.mk .na \fB\fB-e\fR \fIsecs\fR\fR .ad .RS 16n +.rt Exit after the number of seconds specified have elapsed. .RE .sp .ne 2 +.mk .na \fB\fB-n\fR \fIcount\fR\fR .ad .RS 16n +.rt Display only the specified number of entries for each output category. .RE .sp .ne 2 +.mk .na \fB\fB-s\fR \fIdepth\fR\fR .ad .RS 16n +.rt Record a stack trace rather than just the calling function. .RE .sp .ne 2 +.mk .na \fB\fB-p\fR \fIpid\fR\fR .ad .RS 16n +.rt Specify a process ID from which \fBplockstat\fR is to gather data. .RE .sp .ne 2 +.mk .na \fB\fB-v\fR\fR .ad .RS 16n +.rt Print out a message to indicate that tracing has started. .RE .sp .ne 2 +.mk .na \fB\fB-x\fR \fIarg\fR[=\fIval\fR]\fR .ad .RS 16n +.rt Enable or modify a DTrace runtime option or D compiler option. The list of options is found in the \fISolaris Dynamic Tracing Guide\fR. Boolean options are enabled by specifying their name. Options with values are set by separating @@ -128,10 +146,12 @@ the option name and value with an equals sign (\fB=\fR). .sp .ne 2 +.mk .na \fB\fB-V\fR\fR .ad .RS 16n +.rt Print the Dtrace commands used to gather the data. The output can then be used directly with the \fBdtrace\fR(1M) command. .RE @@ -142,46 +162,56 @@ directly with the \fBdtrace\fR(1M) command. The following operands are supported: .sp .ne 2 +.mk .na \fB\fIarg\fR\fR .ad .RS 11n +.rt A string to be passed as an argument to \fIcommand\fR. .RE .sp .ne 2 +.mk .na \fB\fIcommand\fR\fR .ad .RS 11n +.rt The name of a utility to be invoked. .RE .sp .ne 2 +.mk .na \fB\fIcount\fR\fR .ad .RS 11n +.rt A positive integer value. .RE .sp .ne 2 +.mk .na \fB\fIpid\fR\fR .ad .RS 11n +.rt A process identifier for a process to be monitored. .RE .sp .ne 2 +.mk .na \fB\fIsecs\fR\fR .ad .RS 11n +.rt Duration specified as a positive integer number of seconds. .RE @@ -191,19 +221,23 @@ Duration specified as a positive integer number of seconds. The following exit values are returned: .sp .ne 2 +.mk .na \fB\fB0\fR\fR .ad .RS 6n +.rt Successful completion. .RE .sp .ne 2 +.mk .na \fB>\fB0\fR\fR .ad .RS 6n +.rt An error occurred. .RE @@ -215,12 +249,13 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE _ -Interface Stability See below. +Interface StabilitySee below. .TE .sp diff --git a/man/man1m/zdb.1m b/man/man1m/zdb.1m index 106dcfbb5918b..661165d5843a3 100644 --- a/man/man1m/zdb.1m +++ b/man/man1m/zdb.1m @@ -1,484 +1,87 @@ -'\" t -.\" -.\" This file and its contents are supplied under the terms of the -.\" Common Development and Distribution License ("CDDL"), version 1.0. -.\" You may only use this file in accordance with the terms of version -.\" 1.0 of the CDDL. -.\" -.\" A full copy of the text of the CDDL should have accompanied this -.\" source. A copy of the CDDL is also available via the Internet at -.\" http://www.illumos.org/license/CDDL. -.\" -.\" -.\" Copyright 2012, Richard Lowe. -.\" -.TH "ZDB" "1M" "February 15, 2012" "" "" - -.SH "NAME" -\fBzdb\fR - Display zpool debugging and consistency information - -.SH "SYNOPSIS" -\fBzdb\fR [-CumdibcsDvhLXFPA] [-e [-p \fIpath\fR...]] [-t \fItxg\fR] - \fIpoolname\fR [\fIobject\fR ...] - -.P -\fBzdb\fR [-divPA] [-e [-p \fIpath\fR...]] \fIdataset\fR [\fIobject\fR ...] - -.P -\fBzdb\fR -m [-LXFPA] [-t \fItxg\fR] [-e [-p \fIpath\fR...]] \fIpoolname\fR - [\fIvdev\fR [\fImetaslab\fR ...]] - -.P -\fBzdb\fR -R [-A] [-e [-p \fIpath\fR...]] \fIpoolname\fR - \fIvdev\fR:\fIoffset\fR:\fIsize\fR[:\fIflags\fR] - -.P -\fBzdb\fR -S [-AP] [-e [-p \fIpath\fR...]] \fIpoolname\fR - -.P -\fBzdb\fR -l [-uA] \fIdevice\fR - -.P -\fBzdb\fR -C [-A] [-U \fIcache\fR] - -.SH "DESCRIPTION" -The \fBzdb\fR utility displays information about a ZFS pool useful for -debugging and performs some amount of consistency checking. It is a not a -general purpose tool and options (and facilities) may change. This is neither -a fsck(1M) nor an fsdb(1M) utility. - -.P -The output of this command in general reflects the on-disk structure of a ZFS -pool, and is inherently unstable. The precise output of most invocations is -not documented, a knowledge of ZFS internals is assumed. - -.P -When operating on an imported and active pool it is possible, though unlikely, -that zdb may interpret inconsistent pool data and behave erratically. - -.SH "OPTIONS" -Display options: - -.sp -.ne 2 -.na -\fB-b\fR -.ad -.sp .6 -.RS 4n -Display statistics regarding the number, size (logical, physical and -allocated) and deduplication of blocks. -.RE - -.sp -.ne 2 -.na -\fB-c\fR -.ad -.sp .6 -.RS 4n -Verify the checksum of all metadata blocks while printing block statistics -(see \fB-b\fR). -.sp -If specified multiple times, verify the checksums of all blocks. -.RE - -.sp -.ne 2 -.na -\fB-C\fR -.ad -.sp .6 -.RS 4n -Display information about the configuration. If specified with no other -options, instead display information about the cache file -(\fB/etc/zfs/zpool.cache\fR). To specify the cache file to display, see -\fB-U\fR. -.P -If specified multiple times, and a pool name is also specified display both -the cached configuration and the on-disk configuration. If specified multiple -times with \fB-e\fR also display the configuration that would be used were the -pool to be imported. -.RE - -.sp -.ne 2 -.na -\fB-d\fR -.ad -.sp .6 -.RS 4n -Display information about datasets. Specified once, displays basic dataset -information: ID, create transaction, size, and object count. -.sp -If specified multiple times provides greater and greater verbosity. -.sp -If object IDs are specified, display information about those specific objects only. -.RE - -.sp -.ne 2 -.na -\fB-D\fR -.ad -.sp .6 -.RS 4n -Display deduplication statistics, including the deduplication ratio (dedup), -compression ratio (compress), inflation due to the zfs copies property -(copies), and an overall effective ratio (dedup * compress / copies). -.sp -If specified twice, display a histogram of deduplication statistics, showing -the allocated (physically present on disk) and referenced (logically -referenced in the pool) block counts and sizes by reference count. -.RE - -.sp -.ne 2 -.na -\fB-h\fR -.ad -.sp .6 -.RS 4n -Display pool history similar to \fBzpool history\fR, but include internal -changes, transaction, and dataset information. -.RE - -.sp -.ne 2 -.na -\fB-i\fR -.ad -.sp .6 -.RS 4n -Display information about intent log (ZIL) entries relating to each -dataset. If specified multiple times, display counts of each intent log -transaction type. -.RE - -.sp -.ne 2 -.na -\fB-l\fR \fIdevice\fR -.ad -.sp .6 -.RS 4n -Display the vdev labels from the specified device. If the \fB-u\fR option is -also specified, also display the uberblocks on this device. -.RE - -.sp -.ne 2 -.na -\fB-L\fR -.ad -.sp .6 -.RS 4n -Disable leak tracing and the loading of space maps. By default, \fBzdb\fR -verifies that all non-free blocks are referenced, which can be very expensive. -.RE - -.sp -.ne 2 -.na -\fB-m\fR -.ad -.sp .6 -.RS 4n -Display the offset, spacemap, and free space of each metaslab. -When specified twice, also display information about the maximum contiguous -free space and the percentage of free space in each space map. When specified -three times display every spacemap record. -.RE - -.sp -.ne 2 -.na -\fB-R\fR \fIpoolname\fR \fIvdev\fR:\fIoffset\fR:\fIsize\fR[:\fIflags\fR] -.ad -.sp .6 -.RS 4n -Read and display a block from the specified device. By default the block is -displayed as a hex dump, but see the description of the \'r\' flag, below. -.sp -The block is specified in terms of a colon-separated tuple \fIvdev\fR (an -integer vdev identifier) \fIoffset\fR (the offset within the vdev) \fIsize\fR -(the size of the block to read) and, optionally, \fIflags\fR (a set of flags, -described below). - -.sp -.ne 2 -.na -\fBb\fR \fIoffset\fR -.ad -.sp .6 -.RS 4n -Print block pointer -.RE - -.sp -.ne 2 -.na -\fBd\fR -.ad -.sp .6 -.RS 4n -Decompress the block -.RE - -.sp -.ne 2 -.na -\fBe\fR -.ad -.sp .6 -.RS 4n -Byte swap the block -.RE - -.sp -.ne 2 -.na -\fBg\fR -.ad -.sp .6 -.RS 4n -Dump gang block header -.RE - -.sp -.ne 2 -.na -\fBi\fR -.ad -.sp .6 -.RS 4n -Dump indirect block -.RE - -.sp -.ne 2 -.na -\fBr\fR -.ad -.sp .6 -.RS 4n -Dump raw uninterpreted block data -.RE -.RE - -.sp -.ne 2 -.na -\fB-s\fR -.ad -.sp .6 -.RS 4n -Report statistics on \fBzdb\fR\'s I/O. Display operation counts, bandwidth, -and error counts of I/O to the pool from \fBzdb\fR. -.RE - -.sp -.ne 2 -.na -\fB-S\fR -.ad -.sp .6 -.RS 4n -Simulate the effects of deduplication, constructing a DDT and then display -that DDT as with \fB-DD\fR. -.RE - -.sp -.ne 2 -.na -\fB-u\fR -.ad -.sp .6 -.RS 4n -Display the current uberblock. -.RE - -.P -Other options: - -.sp -.ne 2 -.na -\fB-A\fR -.ad -.sp .6 -.RS 4n -Do not abort should any assertion fail. -.RE - -.sp -.ne 2 -.na -\fB-AA\fR -.ad -.sp .6 -.RS 4n -Enable panic recovery, certain errors which would otherwise be fatal are -demoted to warnings. -.RE - -.sp -.ne 2 -.na -\fB-AAA\fR -.ad -.sp .6 -.RS 4n -Do not abort if asserts fail and also enable panic recovery. -.RE +'\" te +.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH zdb 1M "31 Oct 2005" "SunOS 5.11" "System Administration Commands" +.SH NAME +zdb \- ZFS debugger +.SH SYNOPSIS +.LP +.nf +\fBzdb\fR \fIpool\fR +.fi +.SH DESCRIPTION .sp -.ne 2 -.na -\fB-e\fR [-p \fIpath\fR]... -.ad -.sp .6 -.RS 4n -Operate on an exported pool, not present in \fB/etc/zfs/zpool.cache\fR. The -\fB-p\fR flag specifies the path under which devices are to be searched. -.RE - +.LP +The \fBzdb\fR command is used by support engineers to diagnose failures and +gather statistics. Since the \fBZFS\fR file system is always consistent on disk +and is self-repairing, \fBzdb\fR should only be run under the direction by a +support engineer. .sp -.ne 2 -.na -\fB-F\fR -.ad -.sp .6 -.RS 4n -Attempt to make an unreadable pool readable by trying progressively older -transactions. -.RE - +.LP +If no arguments are specified, \fBzdb\fR, performs basic consistency checks on +the pool and associated datasets, and report any problems detected. .sp -.ne 2 -.na -\fB-P\fR -.ad -.sp .6 -.RS 4n -Print numbers in an unscaled form more amenable to parsing, eg. 1000000 rather -than 1M. -.RE - +.LP +Any options supported by this command are internal to Sun and subject to change +at any time. +.SH EXIT STATUS .sp -.ne 2 -.na -\fB-t\fR \fItransaction\fR -.ad -.sp .6 -.RS 4n -Specify the highest transaction to use when searching for uberblocks. See also -the \fB-u\fR and \fB-l\fR options for a means to see the available uberblocks -and their associated transaction numbers. -.RE - +.LP +The following exit values are returned: .sp .ne 2 +.mk .na -\fB-U\fR \fIcachefile\fR +\fB\fB0\fR\fR .ad -.sp .6 -.RS 4n -Use a cache file other than \fB/etc/zfs/zpool.cache\fR. This option is only -valid with \fB-C\fR +.RS 5n +.rt +The pool is consistent. .RE .sp .ne 2 +.mk .na -\fB-v\fR +\fB\fB1\fR\fR .ad -.sp .6 -.RS 4n -Enable verbosity. Specify multiple times for increased verbosity. +.RS 5n +.rt +An error was detected. .RE .sp .ne 2 +.mk .na -\fB-X\fR +\fB\fB2\fR\fR .ad -.sp .6 -.RS 4n -Attempt \'extreme\' transaction rewind, that is attempt the same recovery as -\fB-F\fR but read transactions otherwise deemed too old. +.RS 5n +.rt +Invalid command line options were specified. .RE -.P -Specifying a display option more than once enables verbosity for only that -option, with more occurrences enabling more verbosity. -.P -If no options are specified, all information about the named pool will be -displayed at default verbosity. - -.SH "EXAMPLES" -.LP -\fBExample 1 \fRDisplay the configuration of imported pool 'rpool' +.SH ATTRIBUTES .sp -.in +2 -.nf -# zdb -C rpool - -MOS Configuration: - version: 28 - name: 'rpool' - ... -.fi -.in -2 -.sp - .LP -\fBExample 2 \fRDisplay basic dataset information about 'rpool' -.sp -.in +2 -.nf -# zdb -d rpool -Dataset mos [META], ID 0, cr_txg 4, 26.9M, 1051 objects -Dataset rpool/swap [ZVOL], ID 59, cr_txg 356, 486M, 2 objects - ... -.fi -.in -2 +See \fBattributes\fR(5) for descriptions of the following attributes: .sp -.LP -\fBExample 3 \fRDisplay basic information about object 0 in -'rpool/export/home' .sp -.in +2 -.nf -# zdb -d rpool/export/home 0 -Dataset rpool/export/home [ZPL], ID 137, cr_txg 1546, 32K, 8 objects +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityUnstable +.TE - Object lvl iblk dblk dsize lsize %full type - 0 7 16K 16K 15.0K 16K 25.00 DMU dnode -.fi -.in -2 +.SH SEE ALSO .sp - .LP -\fBExample 4 \fRDisplay the predicted effect of enabling deduplication on 'rpool' -.sp -.in +2 -.nf -# zdb -S rpool -Simulated DDT histogram: - -bucket allocated referenced -______ ______________________________ ______________________________ -refcnt blocks LSIZE PSIZE DSIZE blocks LSIZE PSIZE DSIZE ------- ------ ----- ----- ----- ------ ----- ----- ----- - 1 694K 27.1G 15.0G 15.0G 694K 27.1G 15.0G 15.0G - 2 35.0K 1.33G 699M 699M 74.7K 2.79G 1.45G 1.45G - ... -dedup = 1.11, compress = 1.80, copies = 1.00, dedup * compress / copies = 2.00 -.fi -.in -2 -.sp - -.SH "SEE ALSO" -zfs(1M), zpool(1M) +\fBzfs\fR(1M), \fBzpool\fR(1M), \fBattributes\fR(5) diff --git a/man/man1m/zfs.1m b/man/man1m/zfs.1m index 32b0cb282ef93..68244c710793d 100644 --- a/man/man1m/zfs.1m +++ b/man/man1m/zfs.1m @@ -1,13 +1,12 @@ '\" te .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright (c) 2012 by Delphix. All rights reserved. -.\" Copyright (c) 2012 Nexenta Systems, Inc. All Rights Reserved. -.\" Copyright (c) 2012, Joyent, Inc. All rights reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org> -.TH ZFS 1M "28 Jul 2011" +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. +.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with +.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH zfs 1M "24 Sep 2009" "SunOS 5.11" "System Administration Commands" .SH NAME zfs \- configures ZFS file systems .SH SYNOPSIS @@ -28,18 +27,18 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBdestroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR +\fBzfs\fR \fBdestroy\fR [\fB-rRf\fR] \fIfilesystem\fR|\fIvolume\fR .fi .LP .nf -\fBzfs\fR \fBdestroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,...] +\fBzfs\fR \fBdestroy\fR [\fB-rRd\fR] \fIsnapshot\fR .fi .LP .nf -\fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... - \fIfilesystem@snapname\fR|\fIvolume@snapname\fR... +\fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... + \fIfilesystem@snapname\fR|\fIvolume@snapname\fR .fi .LP @@ -59,13 +58,13 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBrename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR +\fBzfs\fR \fBrename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR .fi .LP .nf -\fBzfs\fR \fBrename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR +\fBzfs\fR \fBrename\fR [\fB-p\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR .fi .LP @@ -86,8 +85,8 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIfield\fR[,...]] [\fB-t\fR \fItype\fR[,...]] - [\fB-s\fR \fIsource\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ... +\fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \fIsource\fR[,...]] + "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ... .fi .LP @@ -108,18 +107,18 @@ zfs \- configures ZFS file systems .LP .nf \fBzfs\fR \fBuserspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR] ... - [\fB-t\fR \fItype\fR[,...]] \fIfilesystem\fR|\fIsnapshot\fR + [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR|\fIsnapshot\fR .fi .LP .nf \fBzfs\fR \fBgroupspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR] ... - [\fB-t\fR \fItype\fR[,...]] \fIfilesystem\fR|\fIsnapshot\fR + [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR|\fIsnapshot\fR .fi .LP .nf -\fBzfs\fR \fBmount\fR +\fBzfs\fR \fBmount\fR .fi .LP @@ -144,7 +143,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBsend\fR [\fB-DnPpRrv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR +\fBzfs\fR \fBsend\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR .fi .LP @@ -154,7 +153,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR +\fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fB-d\fR \fIfilesystem\fR .fi .LP @@ -164,7 +163,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...] +\fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...] \fIfilesystem\fR|\fIvolume\fR .fi @@ -185,7 +184,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBunallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[,... ]] +\fBzfs\fR \fBunallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[,... ]] \fIfilesystem\fR|\fIvolume\fR .fi @@ -241,6 +240,7 @@ where the maximum length of a dataset name is \fBMAXNAMELEN\fR (256 bytes). A dataset can be one of the following: .sp .ne 2 +.mk .na \fB\fIfile system\fR\fR .ad @@ -256,6 +256,7 @@ free space. .sp .ne 2 +.mk .na \fB\fIvolume\fR\fR .ad @@ -268,6 +269,7 @@ most environments. .sp .ne 2 +.mk .na \fB\fIsnapshot\fR\fR .ad @@ -439,6 +441,7 @@ dataset. These properties can be neither set, nor inherited. Native properties apply to all dataset types unless otherwise noted. .sp .ne 2 +.mk .na \fB\fBavailable\fR\fR .ad @@ -455,22 +458,20 @@ This property can also be referred to by its shortened column name, .sp .ne 2 +.mk .na \fB\fBcompressratio\fR\fR .ad .sp .6 .RS 4n -For non-snapshots, the compression ratio achieved for the \fBused\fR -space of this dataset, expressed as a multiplier. The \fBused\fR -property includes descendant datasets, and, for clones, does not include -the space shared with the origin snapshot. For snapshots, the -\fBcompressratio\fR is the same as the \fBrefcompressratio\fR property. +The compression ratio achieved for this dataset, expressed as a multiplier. Compression can be turned on by running: \fBzfs set compression=on \fIdataset\fR\fR. The default value is \fBoff\fR. .RE .sp .ne 2 +.mk .na \fB\fBcreation\fR\fR .ad @@ -481,19 +482,7 @@ The time this dataset was created. .sp .ne 2 -.na -\fB\fBclones\fR\fR -.ad -.sp .6 -.RS 4n -For snapshots, this property is a comma-separated list of filesystems or -volumes which are clones of this snapshot. The clones' \fBorigin\fR property -is this snapshot. If the \fBclones\fR property is not empty, then this -snapshot can not be destroyed (even with the \fB-r\fR or \fB-f\fR options). -.RE - -.sp -.ne 2 +.mk .na \fB\fBdefer_destroy\fR\fR .ad @@ -506,6 +495,7 @@ by using the \fBzfs destroy\fR \fB-d\fR command. Otherwise, the property is .sp .ne 2 +.mk .na \fB\fBmounted\fR\fR .ad @@ -517,17 +507,20 @@ property can be either \fByes\fR or \fBno\fR. .sp .ne 2 +.mk .na \fB\fBorigin\fR\fR .ad .sp .6 .RS 4n For cloned file systems or volumes, the snapshot from which the clone was -created. See also the \fBclones\fR property. +created. The origin cannot be destroyed (even with the \fB-r\fR or \fB-f\fR +options) so long as a clone exists. .RE .sp .ne 2 +.mk .na \fB\fBreferenced\fR\fR .ad @@ -544,18 +537,7 @@ This property can also be referred to by its shortened column name, .sp .ne 2 -.na -\fB\fBrefcompressratio\fR\fR -.ad -.sp .6 -.RS 4n -The compression ratio achieved for the \fBreferenced\fR space of this -dataset, expressed as a multiplier. See also the \fBcompressratio\fR -property. -.RE - -.sp -.ne 2 +.mk .na \fB\fBtype\fR\fR .ad @@ -566,6 +548,7 @@ The type of dataset: \fBfilesystem\fR, \fBvolume\fR, or \fBsnapshot\fR. .sp .ne 2 +.mk .na \fB\fBused\fR\fR .ad @@ -595,6 +578,7 @@ immediately. .sp .ne 2 +.mk .na \fB\fBusedby*\fR\fR .ad @@ -609,6 +593,7 @@ on \fBzpool\fR "version 13" pools. .sp .ne 2 +.mk .na \fB\fBusedbychildren\fR\fR .ad @@ -620,6 +605,7 @@ all the dataset's children were destroyed. .sp .ne 2 +.mk .na \fB\fBusedbydataset\fR\fR .ad @@ -632,6 +618,7 @@ destroying any necessary snapshots or descendents). .sp .ne 2 +.mk .na \fB\fBusedbyrefreservation\fR\fR .ad @@ -643,6 +630,7 @@ would be freed if the \fBrefreservation\fR was removed. .sp .ne 2 +.mk .na \fB\fBusedbysnapshots\fR\fR .ad @@ -656,6 +644,7 @@ properties because space can be shared by multiple snapshots. .sp .ne 2 +.mk .na \fB\fBuserused@\fR\fIuser\fR\fR .ad @@ -701,6 +690,7 @@ following forms: .sp .ne 2 +.mk .na \fB\fBuserrefs\fR\fR .ad @@ -712,6 +702,7 @@ are set by using the \fBzfs hold\fR command. .sp .ne 2 +.mk .na \fB\fBgroupused@\fR\fIgroup\fR\fR .ad @@ -728,6 +719,7 @@ allow\fR, can access all groups' usage. .sp .ne 2 +.mk .na \fB\fBvolblocksize\fR=\fIblocksize\fR\fR .ad @@ -743,41 +735,12 @@ This property can also be referred to by its shortened column name, .RE .sp -.ne 2 -.na -\fB\fBwritten\fR\fR -.ad -.sp .6 -.RS 4n -The amount of \fBreferenced\fR space written to this dataset since the -previous snapshot. -.RE - -.sp -.ne 2 -.na -\fB\fBwritten@\fR\fIsnapshot\fR\fR -.ad -.sp .6 -.RS 4n -The amount of \fBreferenced\fR space written to this dataset since the -specified snapshot. This is the space that is referenced by this dataset -but was not referenced by the specified snapshot. -.sp -The \fIsnapshot\fR may be specified as a short snapshot name (just the part -after the \fB@\fR), in which case it will be interpreted as a snapshot in -the same filesystem as this dataset. -The \fIsnapshot\fR be a full snapshot name (\fIfilesystem\fR@\fIsnapshot\fR), -which for clones may be a snapshot in the origin's filesystem (or the origin -of the origin's filesystem, etc). -.RE - -.sp .LP The following native properties can be used to change the behavior of a \fBZFS\fR dataset. .sp .ne 2 +.mk .na \fB\fBaclinherit\fR=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR | \fBpassthrough\fR | \fBpassthrough-x\fR\fR @@ -806,24 +769,28 @@ mode from the application. .sp .ne 2 +.mk .na \fB\fBaclmode\fR=\fBdiscard\fR | \fBgroupmask\fR | \fBpassthrough\fR\fR .ad .sp .6 .RS 4n Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with -an \fBaclmode\fR property of \fBdiscard\fR (the default) deletes all \fBACL\fR -entries that do not represent the mode of the file. An \fBaclmode\fR property -of \fBgroupmask\fR reduces permissions granted in all \fBALLOW\fR entries found -in the \fBACL\fR such that they are no greater than the group permissions -specified by \fBchmod\fR. A file system with an \fBaclmode\fR property of -\fBpassthrough\fR indicates that no changes are made to the \fBACL\fR other -than creating or updating the necessary \fBACL\fR entries to -represent the new mode of the file or directory. +an \fBaclmode\fR property of \fBdiscard\fR deletes all \fBACL\fR entries that +do not represent the mode of the file. An \fBaclmode\fR property of +\fBgroupmask\fR (the default) reduces user or group permissions. The +permissions are reduced, such that they are no greater than the group +permission bits, unless it is a user entry that has the same \fBUID\fR as the +owner of the file or directory. In this case, the \fBACL\fR permissions are +reduced so that they are no greater than owner permission bits. A file system +with an \fBaclmode\fR property of \fBpassthrough\fR indicates that no changes +are made to the \fBACL\fR other than generating the necessary \fBACL\fR entries +to represent the new mode of the file or directory. .RE .sp .ne 2 +.mk .na \fB\fBatime\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -837,6 +804,7 @@ and other similar utilities. The default value is \fBon\fR. .sp .ne 2 +.mk .na \fB\fBcanmount\fR=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR .ad @@ -862,6 +830,7 @@ This property is not inherited. .sp .ne 2 +.mk .na \fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2,\fR| \fBfletcher4\fR | \fBsha256\fR\fR @@ -879,9 +848,10 @@ Changing this property affects only newly-written data. .sp .ne 2 +.mk .na \fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR | -\fBgzip-\fR\fIN\fR | \fBzle\fR\fR +\fBgzip-\fR\fIN\fR\fR .ad .sp .6 .RS 4n @@ -892,8 +862,7 @@ algorithm. The \fBgzip\fR compression algorithm uses the same compression as the \fBgzip\fR(1) command. You can specify the \fBgzip\fR level by using the value \fBgzip-\fR\fIN\fR where \fIN\fR is an integer from 1 (fastest) to 9 (best compression ratio). Currently, \fBgzip\fR is equivalent to \fBgzip-6\fR -(which is also the default for \fBgzip\fR(1)). The \fBzle\fR compression -algorithm compresses runs of zeros. +(which is also the default for \fBgzip\fR(1)). .sp This property can also be referred to by its shortened column name \fBcompress\fR. Changing this property affects only newly-written data. @@ -901,6 +870,7 @@ This property can also be referred to by its shortened column name .sp .ne 2 +.mk .na \fB\fBcopies\fR=\fB1\fR | \fB2\fR | \fB3\fR\fR .ad @@ -919,6 +889,7 @@ property at file system creation time by using the \fB-o\fR .sp .ne 2 +.mk .na \fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -930,6 +901,7 @@ value is \fBon\fR. .sp .ne 2 +.mk .na \fB\fBexec\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -941,6 +913,7 @@ default value is \fBon\fR. .sp .ne 2 +.mk .na \fB\fBmountpoint\fR=\fIpath\fR | \fBnone\fR | \fBlegacy\fR\fR .ad @@ -960,6 +933,7 @@ new location. .sp .ne 2 +.mk .na \fB\fBnbmand\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -973,6 +947,7 @@ property only take effect when the file system is umounted and remounted. See .sp .ne 2 +.mk .na \fB\fBprimarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR .ad @@ -987,6 +962,7 @@ is set to \fBmetadata\fR, then only metadata is cached. The default value is .sp .ne 2 +.mk .na \fB\fBquota\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1004,6 +980,7 @@ implicit quota. .sp .ne 2 +.mk .na \fB\fBuserquota@\fR\fIuser\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1053,6 +1030,7 @@ displayed by \fBzfs get all\fR. The user's name must be appended after the .sp .ne 2 +.mk .na \fB\fBgroupquota@\fR\fIgroup\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1068,6 +1046,7 @@ allow\fR, can get and set all groups' quotas. .sp .ne 2 +.mk .na \fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1081,6 +1060,7 @@ This property can also be referred to by its shortened column name, .sp .ne 2 +.mk .na \fB\fBrecordsize\fR=\fIsize\fR\fR .ad @@ -1109,6 +1089,7 @@ This property can also be referred to by its shortened column name, .sp .ne 2 +.mk .na \fB\fBrefquota\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1121,6 +1102,7 @@ by descendents, including file systems and snapshots. .sp .ne 2 +.mk .na \fB\fBrefreservation\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1143,6 +1125,7 @@ This property can also be referred to by its shortened column name, .sp .ne 2 +.mk .na \fB\fBreservation\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1160,6 +1143,7 @@ This property can also be referred to by its shortened column name, .sp .ne 2 +.mk .na \fB\fBsecondarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR .ad @@ -1174,6 +1158,7 @@ value is \fBall\fR. .sp .ne 2 +.mk .na \fB\fBsetuid\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1185,6 +1170,7 @@ default value is \fBon\fR. .sp .ne 2 +.mk .na \fB\fBshareiscsi\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1203,6 +1189,7 @@ setting this property on a file system has no direct effect. .sp .ne 2 +.mk .na \fB\fBsharesmb\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR .ad @@ -1241,6 +1228,7 @@ are unshared. .sp .ne 2 +.mk .na \fB\fBsharenfs\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR .ad @@ -1264,6 +1252,7 @@ unshared. .sp .ne 2 +.mk .na \fB\fBlogbias\fR = \fBlatency\fR | \fBthroughput\fR\fR .ad @@ -1279,6 +1268,7 @@ efficient use of resources. .sp .ne 2 +.mk .na \fB\fBsnapdir\fR=\fBhidden\fR | \fBvisible\fR\fR .ad @@ -1291,26 +1281,7 @@ the file system as discussed in the "Snapshots" section. The default value is .sp .ne 2 -.na -\fB\fBsync\fR=\fBdefault\fR | \fBalways\fR | \fBdisabled\fR\fR -.ad -.sp .6 -.RS 4n -Controls the behavior of synchronous requests (e.g. fsync, O_DSYNC). -\fBdefault\fR is the POSIX specified behavior of ensuring all synchronous -requests are written to stable storage and all devices are flushed to ensure -data is not cached by device controllers (this is the default). \fBalways\fR -causes every file system transaction to be written and flushed before its -system call returns. This has a large performance penalty. \fBdisabled\fR -disables synchronous requests. File system transactions are only committed to -stable storage periodically. This option will give the highest performance. -However, it is very dangerous as ZFS would be ignoring the synchronous -transaction demands of applications such as databases or NFS. Administrators -should only use this option when the risks are understood. -.RE - -.sp -.ne 2 +.mk .na \fB\fBversion\fR=\fB1\fR | \fB2\fR | \fBcurrent\fR\fR .ad @@ -1323,6 +1294,7 @@ version. This property can only be set to later supported versions. See the .sp .ne 2 +.mk .na \fB\fBvolsize\fR=\fIsize\fR\fR .ad @@ -1353,6 +1325,7 @@ reflected in the reservation. .sp .ne 2 +.mk .na \fB\fBvscan\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1366,6 +1339,7 @@ service must also be enabled for virus scanning to occur. The default value is .sp .ne 2 +.mk .na \fB\fBxattr\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1377,6 +1351,7 @@ default value is \fBon\fR. .sp .ne 2 +.mk .na \fB\fBzoned\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1397,6 +1372,7 @@ features being supported, the new file system will have the default values for these properties. .sp .ne 2 +.mk .na \fB\fBcasesensitivity\fR=\fBsensitive\fR | \fBinsensitive\fR | \fBmixed\fR\fR .ad @@ -1418,6 +1394,7 @@ product. For more information about the \fBmixed\fR value behavior, see the .sp .ne 2 +.mk .na \fB\fBnormalization\fR = \fBnone\fR | \fBformC\fR | \fBformD\fR | \fBformKC\fR | \fBformKD\fR\fR @@ -1436,6 +1413,7 @@ cannot be changed after the file system is created. .sp .ne 2 +.mk .na \fB\fButf8only\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1539,6 +1517,7 @@ All subcommands that modify state are logged persistently to the pool in their original form. .sp .ne 2 +.mk .na \fB\fBzfs ?\fR\fR .ad @@ -1549,6 +1528,7 @@ Displays a help message. .sp .ne 2 +.mk .na \fB\fBzfs create\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR\fR @@ -1559,6 +1539,7 @@ Creates a new \fBZFS\fR file system. The file system is automatically mounted according to the \fBmountpoint\fR property inherited from the parent. .sp .ne 2 +.mk .na \fB\fB-p\fR\fR .ad @@ -1573,6 +1554,7 @@ operation completes successfully. .sp .ne 2 +.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1589,6 +1571,7 @@ property is specified in multiple \fB-o\fR options. .sp .ne 2 +.mk .na \fB\fBzfs create\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fB-V\fR \fIsize\fR \fIvolume\fR\fR @@ -1604,6 +1587,7 @@ exported by the device. By default, a reservation of equal size is created. the volume has an integral number of blocks regardless of \fIblocksize\fR. .sp .ne 2 +.mk .na \fB\fB-p\fR\fR .ad @@ -1618,6 +1602,7 @@ operation completes successfully. .sp .ne 2 +.mk .na \fB\fB-s\fR\fR .ad @@ -1629,6 +1614,7 @@ Properties section for more information about sparse volumes. .sp .ne 2 +.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1643,6 +1629,7 @@ multiple \fB-o\fR options. .sp .ne 2 +.mk .na \fB\fB-b\fR \fIblocksize\fR\fR .ad @@ -1657,8 +1644,9 @@ behavior is undefined. .sp .ne 2 +.mk .na -\fBzfs destroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR +\fB\fBzfs destroy\fR [\fB-rRf\fR] \fIfilesystem\fR|\fIvolume\fR\fR .ad .sp .6 .RS 4n @@ -1668,6 +1656,7 @@ mounted, and refuses to destroy a dataset that has active dependents (children or clones). .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -1678,6 +1667,7 @@ Recursively destroy all children. .sp .ne 2 +.mk .na \fB\fB-R\fR\fR .ad @@ -1689,6 +1679,7 @@ target hierarchy. .sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad @@ -1698,72 +1689,30 @@ Force an unmount of any file systems using the \fBunmount -f\fR command. This option has no effect on non-file systems or unmounted file systems. .RE -.sp -.ne 2 -.na -\fB\fB-n\fR\fR -.ad -.sp .6 -.RS 4n -Do a dry-run ("No-op") deletion. No data will be deleted. This is -useful in conjunction with the \fB-v\fR or \fB-p\fR flags to determine what -data would be deleted. -.RE - -.sp -.ne 2 -.na -\fB\fB-p\fR\fR -.ad -.sp .6 -.RS 4n -Print machine-parsable verbose information about the deleted data. -.RE - -.sp -.ne 2 -.na -\fB\fB-v\fR\fR -.ad -.sp .6 -.RS 4n -Print verbose information about the deleted data. -.RE -.sp -Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR +Extreme care should be taken when applying either the \fB-r\fR or the \fB-f\fR options, as they can destroy large portions of a pool and cause unexpected behavior for mounted file systems in use. .RE .sp .ne 2 +.mk .na -\fBzfs destroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,...] +\fB\fBzfs destroy\fR [\fB-rRd\fR] \fIsnapshot\fR\fR .ad .sp .6 .RS 4n -The given snapshots are destroyed immediately if and only if the \fBzfs +The given snapshot is destroyed immediately if and only if the \fBzfs destroy\fR command without the \fB-d\fR option would have destroyed it. Such immediate destruction would occur, for example, if the snapshot had no clones and the user-initiated reference count were zero. .sp -If a snapshot does not qualify for immediate destruction, it is marked for +If the snapshot does not qualify for immediate destruction, it is marked for deferred deletion. In this state, it exists as a usable, visible snapshot until both of the preconditions listed above are met, at which point it is destroyed. .sp -An inclusive range of snapshots may be specified by separating the -first and last snapshots with a percent sign. -The first and/or last snapshots may be left blank, in which case the -filesystem's oldest or newest snapshot will be implied. -.sp -Multiple snapshots -(or ranges of snapshots) of the same filesystem or volume may be specified -in a comma-separated list of snapshots. -Only the snapshot's short name (the -part after the \fB@\fR) should be specified when using a range or -comma-separated list to identify multiple snapshots. -.sp .ne 2 +.mk .na \fB\fB-d\fR\fR .ad @@ -1774,6 +1723,7 @@ Defer snapshot deletion. .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -1785,6 +1735,7 @@ descendent file systems. .sp .ne 2 +.mk .na \fB\fB-R\fR\fR .ad @@ -1793,70 +1744,36 @@ descendent file systems. Recursively destroy all dependents. .RE -.sp -.ne 2 -.na -\fB\fB-n\fR\fR -.ad -.sp .6 -.RS 4n -Do a dry-run ("No-op") deletion. No data will be deleted. This is -useful in conjunction with the \fB-v\fR or \fB-p\fR flags to determine what -data would be deleted. -.RE - -.sp -.ne 2 -.na -\fB\fB-p\fR\fR -.ad -.sp .6 -.RS 4n -Print machine-parsable verbose information about the deleted data. -.RE - -.sp -.ne 2 -.na -\fB\fB-v\fR\fR -.ad -.sp .6 -.RS 4n -Print verbose information about the deleted data. -.RE - -.sp -Extreme care should be taken when applying either the \fB-r\fR or the \fB-f\fR -options, as they can destroy large portions of a pool and cause unexpected -behavior for mounted file systems in use. -.RE - .RE .sp .ne 2 +.mk .na \fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... -\fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR... +\fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR .ad .sp .6 .RS 4n -Creates snapshots with the given names. All previous modifications by -successful system calls to the file system are part of the snapshots. -Snapshots are taken atomically, so that all snapshots correspond to the same -moment in time. See the "Snapshots" section for details. +Creates a snapshot with the given name. All previous modifications by +successful system calls to the file system are part of the snapshot. See the +"Snapshots" section for details. .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad .sp .6 .RS 4n -Recursively create snapshots of all descendent datasets +Recursively create snapshots of all descendent datasets. Snapshots are taken +atomically, so that all recursive snapshots correspond to the same moment in +time. .RE .sp .ne 2 +.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1869,6 +1786,7 @@ Sets the specified property; see \fBzfs create\fR for details. .sp .ne 2 +.mk .na \fB\fBzfs rollback\fR [\fB-rRf\fR] \fIsnapshot\fR\fR .ad @@ -1887,6 +1805,7 @@ either of these options. To completely roll back a recursive snapshot, you must rollback the individual child snapshots. .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -1897,6 +1816,7 @@ Recursively destroy any snapshots more recent than the one specified. .sp .ne 2 +.mk .na \fB\fB-R\fR\fR .ad @@ -1908,6 +1828,7 @@ snapshots. .sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad @@ -1921,6 +1842,7 @@ that are to be destroyed. .sp .ne 2 +.mk .na \fB\fBzfs clone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR @@ -1932,6 +1854,7 @@ The target dataset can be located anywhere in the \fBZFS\fR hierarchy, and is created as the same type as the original. .sp .ne 2 +.mk .na \fB\fB-p\fR\fR .ad @@ -1945,6 +1868,7 @@ operation completes successfully. .sp .ne 2 +.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1957,6 +1881,7 @@ Sets the specified property; see \fBzfs create\fR for details. .sp .ne 2 +.mk .na \fB\fBzfs promote\fR \fIclone-filesystem\fR\fR .ad @@ -1978,8 +1903,9 @@ any conflicting snapshots. .sp .ne 2 +.mk .na -\fB\fBzfs rename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR +\fB\fBzfs rename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR .ad .br .na @@ -1987,7 +1913,7 @@ any conflicting snapshots. .ad .br .na -\fB\fBzfs rename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR +\fB\fBzfs rename\fR [\fB-p\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR\fR .ad .sp .6 @@ -2000,6 +1926,7 @@ second argument. Renamed file systems can inherit new mount points, in which case they are unmounted and remounted at the new mount point. .sp .ne 2 +.mk .na \fB\fB-p\fR\fR .ad @@ -2010,20 +1937,11 @@ are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. .RE -.sp -.ne 2 -.na -\fB\fB-f\fR\fR -.ad -.sp .6 -.RS 4n -Force unmount any filesystems that need to be unmounted in the process. -.RE - .RE .sp .ne 2 +.mk .na \fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR .ad @@ -2035,6 +1953,7 @@ only dataset that can be renamed recursively. .sp .ne 2 +.mk .na \fB\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-H\fR] [\fB-o\fR \fIproperty\fR[,\fI\&...\fR]] [ \fB-t\fR \fItype\fR[,\fI\&...\fR]] [ \fB-s\fR @@ -2051,6 +1970,7 @@ default is \fBoff\fR) . The following fields are displayed, \fBname,used,available,referenced,mountpoint\fR. .sp .ne 2 +.mk .na \fB\fB-H\fR\fR .ad @@ -2062,6 +1982,7 @@ tab instead of arbitrary white space. .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -2072,6 +1993,7 @@ Recursively display any children of the dataset on the command line. .sp .ne 2 +.mk .na \fB\fB-d\fR \fIdepth\fR\fR .ad @@ -2084,6 +2006,7 @@ children. .sp .ne 2 +.mk .na \fB\fB-o\fR \fIproperty\fR\fR .ad @@ -2121,6 +2044,7 @@ filesystem,volume\fR syntax. .sp .ne 2 +.mk .na \fB\fB-s\fR \fIproperty\fR\fR .ad @@ -2164,6 +2088,7 @@ preserved. .sp .ne 2 +.mk .na \fB\fB-S\fR \fIproperty\fR\fR .ad @@ -2174,6 +2099,7 @@ Same as the \fB-s\fR option, but sorts by property in descending order. .sp .ne 2 +.mk .na \fB\fB-t\fR \fItype\fR\fR .ad @@ -2188,6 +2114,7 @@ specifying \fB-t snapshot\fR displays only snapshots. .sp .ne 2 +.mk .na \fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR @@ -2206,9 +2133,10 @@ Properties" section. .sp .ne 2 +.mk .na \fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR -\fIfield\fR[,...] [\fB-t\fR \fItype\fR[,...]] [\fB-s\fR \fIsource\fR[,...] "\fIall\fR" | +\fIfield\fR[,...] [\fB-s\fR \fIsource\fR[,...] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR .ad .sp .6 @@ -2236,6 +2164,7 @@ The special value \fBall\fR can be used to display all properties that apply to the given dataset's type (filesystem, volume, or snapshot). .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -2246,6 +2175,7 @@ Recursively display properties for any children. .sp .ne 2 +.mk .na \fB\fB-d\fR \fIdepth\fR\fR .ad @@ -2258,6 +2188,7 @@ children. .sp .ne 2 +.mk .na \fB\fB-H\fR\fR .ad @@ -2270,6 +2201,7 @@ arbitrary amount of space. .sp .ne 2 +.mk .na \fB\fB-o\fR \fIfield\fR\fR .ad @@ -2281,6 +2213,7 @@ is the default value. .sp .ne 2 +.mk .na \fB\fB-s\fR \fIsource\fR\fR .ad @@ -2294,6 +2227,7 @@ is all sources. .sp .ne 2 +.mk .na \fB\fB-p\fR\fR .ad @@ -2306,6 +2240,7 @@ Display numbers in parseable (exact) values. .sp .ne 2 +.mk .na \fB\fBzfs inherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR @@ -2318,6 +2253,7 @@ no ancestor has the property set, then the default value is used. See the properties can be inherited. .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -2330,6 +2266,7 @@ Recursively inherit the given property for all children. .sp .ne 2 +.mk .na \fB\fBzfs upgrade\fR [\fB-v\fR]\fR .ad @@ -2340,6 +2277,7 @@ Displays a list of file systems that are not the most recent version. .sp .ne 2 +.mk .na \fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR | \fIfilesystem\fR]\fR @@ -2359,6 +2297,7 @@ and the pool version must be upgraded before the file system version can be upgraded. .sp .ne 2 +.mk .na \fB\fB-a\fR\fR .ad @@ -2369,6 +2308,7 @@ Upgrade all file systems on all imported pools. .sp .ne 2 +.mk .na \fB\fIfilesystem\fR\fR .ad @@ -2379,6 +2319,7 @@ Upgrade the specified file system. .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -2389,6 +2330,7 @@ Upgrade the specified file system and all descendent file systems .sp .ne 2 +.mk .na \fB\fB-V\fR \fIversion\fR\fR .ad @@ -2404,6 +2346,7 @@ supported by this software. .sp .ne 2 +.mk .na \fB\fBzfs userspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR]... [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR | @@ -2416,6 +2359,7 @@ filesystem or snapshot. This corresponds to the \fBuserused@\fR\fIuser\fR and \fBuserquota@\fR\fIuser\fR properties. .sp .ne 2 +.mk .na \fB\fB-n\fR\fR .ad @@ -2426,6 +2370,7 @@ Print numeric ID instead of user/group name. .sp .ne 2 +.mk .na \fB\fB-H\fR\fR .ad @@ -2436,6 +2381,7 @@ Do not print headers, use tab-delimited output. .sp .ne 2 +.mk .na \fB\fB-p\fR\fR .ad @@ -2446,6 +2392,7 @@ Use exact (parseable) numeric output. .sp .ne 2 +.mk .na \fB\fB-o\fR \fIfield\fR[,...]\fR .ad @@ -2457,6 +2404,7 @@ Display only the specified fields from the following set, .sp .ne 2 +.mk .na \fB\fB-s\fR \fIfield\fR\fR .ad @@ -2469,6 +2417,7 @@ multiple times to sort first by one field, then by another. The default is .sp .ne 2 +.mk .na \fB\fB-S\fR \fIfield\fR\fR .ad @@ -2479,6 +2428,7 @@ Sort by this field in reverse order. See \fB-s\fR. .sp .ne 2 +.mk .na \fB\fB-t\fR \fItype\fR[,...]\fR .ad @@ -2494,6 +2444,7 @@ The default can be changed to include group types. .sp .ne 2 +.mk .na \fB\fB-i\fR\fR .ad @@ -2513,6 +2464,7 @@ will report that the POSIX entity has the total usage and quota for both. .sp .ne 2 +.mk .na \fB\fBzfs groupspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR]... [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR | @@ -2535,6 +2487,7 @@ except that the default types to display are \fB-t posixgroup,smbgroup\fR. .sp .ne 2 +.mk .na \fB\fBzfs mount\fR\fR .ad @@ -2545,6 +2498,7 @@ Displays all \fBZFS\fR file systems currently mounted. .sp .ne 2 +.mk .na \fB\fBzfs mount\fR [\fB-vO\fR] [\fB-o\fR \fIoptions\fR] \fB-a\fR | \fIfilesystem\fR\fR @@ -2555,6 +2509,7 @@ Mounts \fBZFS\fR file systems. Invoked automatically as part of the boot process. .sp .ne 2 +.mk .na \fB\fB-o\fR \fIoptions\fR\fR .ad @@ -2567,6 +2522,7 @@ details. .sp .ne 2 +.mk .na \fB\fB-O\fR\fR .ad @@ -2577,6 +2533,7 @@ Perform an overlay mount. See \fBmount\fR(1M) for more information. .sp .ne 2 +.mk .na \fB\fB-v\fR\fR .ad @@ -2587,6 +2544,7 @@ Report mount progress. .sp .ne 2 +.mk .na \fB\fB-a\fR\fR .ad @@ -2598,6 +2556,7 @@ the boot process. .sp .ne 2 +.mk .na \fB\fIfilesystem\fR\fR .ad @@ -2610,6 +2569,7 @@ Mount the specified filesystem. .sp .ne 2 +.mk .na \fB\fBzfs unmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR .ad @@ -2619,6 +2579,7 @@ Unmounts currently mounted \fBZFS\fR file systems. Invoked automatically as part of the shutdown process. .sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad @@ -2629,6 +2590,7 @@ Forcefully unmount the file system, even if it is currently in use. .sp .ne 2 +.mk .na \fB\fB-a\fR\fR .ad @@ -2640,6 +2602,7 @@ the boot process. .sp .ne 2 +.mk .na \fB\fIfilesystem\fR|\fImountpoint\fR\fR .ad @@ -2653,6 +2616,7 @@ Unmount the specified filesystem. The command can also be given a path to a .sp .ne 2 +.mk .na \fB\fBzfs share\fR \fB-a\fR | \fIfilesystem\fR\fR .ad @@ -2661,6 +2625,7 @@ Unmount the specified filesystem. The command can also be given a path to a Shares available \fBZFS\fR file systems. .sp .ne 2 +.mk .na \fB\fB-a\fR\fR .ad @@ -2672,6 +2637,7 @@ the boot process. .sp .ne 2 +.mk .na \fB\fIfilesystem\fR\fR .ad @@ -2686,6 +2652,7 @@ Share the specified filesystem according to the \fBsharenfs\fR and .sp .ne 2 +.mk .na \fB\fBzfs unshare\fR \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR .ad @@ -2695,6 +2662,7 @@ Unshares currently shared \fBZFS\fR file systems. This is invoked automatically as part of the shutdown process. .sp .ne 2 +.mk .na \fB\fB-a\fR\fR .ad @@ -2706,6 +2674,7 @@ the boot process. .sp .ne 2 +.mk .na \fB\fIfilesystem\fR|\fImountpoint\fR\fR .ad @@ -2719,8 +2688,10 @@ Unshare the specified filesystem. The command can also be given a path to a .sp .ne 2 +.mk .na -\fBzfs send\fR [\fB-DnPpRrv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR +\fB\fBzfs send\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] +\fIsnapshot\fR\fR .ad .sp .6 .RS 4n @@ -2730,6 +2701,7 @@ system (for example, using \fBssh\fR(1). By default, a full stream is generated. .sp .ne 2 +.mk .na \fB\fB-i\fR \fIsnapshot\fR\fR .ad @@ -2748,6 +2720,7 @@ must be fully specified (for example, \fBpool/fs@origin\fR, not just .sp .ne 2 +.mk .na \fB\fB-I\fR \fIsnapshot\fR\fR .ad @@ -2761,6 +2734,7 @@ be specified as with the \fB-i\fR option. .sp .ne 2 +.mk .na \fB\fB-R\fR\fR .ad @@ -2780,73 +2754,13 @@ snapshots and file systems that do not exist on the sending side are destroyed. .sp .ne 2 -.na -\fB\fB-D\fR\fR -.ad -.sp .6 -.RS 4n -Generate a deduplicated stream. Blocks which would have been sent multiple -times in the send stream will only be sent once. The receiving system must -also support this feature to recieve a deduplicated stream. This flag can -be used regardless of the dataset's \fBdedup\fR property, but performance -will be much better if the filesystem uses a dedup-capable checksum (eg. -\fBsha256\fR). -.RE - -.sp -.ne 2 -.na -\fB\fB-r\fR\fR -.ad -.sp .6 -.RS 4n -Recursively send all descendant snapshots. This is similar to the \fB-R\fR -flag, but information about deleted and renamed datasets is not included, and -property information is only included if the \fB-p\fR flag is specified. -.RE - -.sp -.ne 2 -.na -\fB\fB-p\fR\fR -.ad -.sp .6 -.RS 4n -Include the dataset's properties in the stream. This flag is implicit when -\fB-R\fR is specified. The receiving system must also support this feature. -.RE - -.sp -.ne 2 -.na -\fB\fB-n\fR\fR -.ad -.sp .6 -.RS 4n -Do a dry-run ("No-op") send. Do not generate any actual send data. This is -useful in conjunction with the \fB-v\fR or \fB-P\fR flags to determine what -data will be sent. -.RE - -.sp -.ne 2 -.na -\fB\fB-P\fR\fR -.ad -.sp .6 -.RS 4n -Print machine-parsable verbose information about the stream package generated. -.RE - -.sp -.ne 2 +.mk .na \fB\fB-v\fR\fR .ad .sp .6 .RS 4n -Print verbose information about the stream package generated. This information -includes a per-second report of how much data has been sent. +Print verbose information about the stream package generated. .RE The format of the stream is committed. You will be able to receive your streams @@ -2855,13 +2769,14 @@ on future versions of \fBZFS\fR. .sp .ne 2 +.mk .na \fB\fBzfs receive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR .ad .br .na -\fB\fBzfs receive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR\fR +\fB\fBzfs receive\fR [\fB-vnFu\fR] \fB-d\fR \fIfilesystem\fR\fR .ad .sp .6 .RS 4n @@ -2883,49 +2798,30 @@ on the sending location are destroyed by using the \fBzfs destroy\fR \fB-d\fR command. .sp The name of the snapshot (and file system, if a full stream is received) that -this subcommand creates depends on the argument type and the use of the -\fB-d\fR or \fB-e\fR options. +this subcommand creates depends on the argument type and the \fB-d\fR option. .sp If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If the argument is a file system or volume name, a snapshot with the same name as the sent snapshot is created within the specified \fIfilesystem\fR or -\fIvolume\fR. If neither of the \fB-d\fR or \fB-e\fR options are specified, -the provided target snapshot name is used exactly as provided. -.sp -The \fB-d\fR and \fB-e\fR options cause the file system name of the target -snapshot to be determined by appending a portion of the sent snapshot's name to -the specified target \fIfilesystem\fR. If the \fB-d\fR option is specified, all -but the first element of the sent snapshot's file system path (usually the -pool name) is used and any required intermediate file systems within the -specified one are created. If the \fB-e\fR option is specified, then only the -last element of the sent snapshot's file system name (i.e. the name of the -source file system itself) is used as the target file system name. +\fIvolume\fR. If the \fB-d\fR option is specified, the snapshot name is +determined by appending the sent snapshot's name to the specified +\fIfilesystem\fR. If the \fB-d\fR option is specified, any required file +systems within the specified one are created. .sp .ne 2 +.mk .na \fB\fB-d\fR\fR .ad .sp .6 .RS 4n -Discard the first element of the sent snapshot's file system name, using -the remaining elements to determine the name of the target file system for -the new snapshot as described in the paragraph above. -.RE - -.sp -.ne 2 -.na -\fB\fB-e\fR\fR -.ad -.sp .6 -.RS 4n -Discard all but the last element of the sent snapshot's file system name, -using that element to determine the name of the target file system for -the new snapshot as described in the paragraph above. +Use the name of the sent snapshot to determine the name of the new snapshot as +described in the paragraph above. .RE .sp .ne 2 +.mk .na \fB\fB-u\fR\fR .ad @@ -2936,6 +2832,7 @@ File system that is associated with the received stream is not mounted. .sp .ne 2 +.mk .na \fB\fB-v\fR\fR .ad @@ -2947,6 +2844,7 @@ receive operation. .sp .ne 2 +.mk .na \fB\fB-n\fR\fR .ad @@ -2958,6 +2856,7 @@ Do not actually receive the stream. This can be useful in conjunction with the .sp .ne 2 +.mk .na \fB\fB-F\fR\fR .ad @@ -2973,6 +2872,7 @@ snapshots and file systems that do not exist on the sending side. .sp .ne 2 +.mk .na \fB\fBzfs allow\fR \fIfilesystem\fR | \fIvolume\fR\fR .ad @@ -2984,6 +2884,7 @@ volume. See the other forms of \fBzfs allow\fR for more information. .sp .ne 2 +.mk .na \fB\fBzfs allow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR| \fIvolume\fR\fR @@ -2999,6 +2900,7 @@ Delegates \fBZFS\fR administration permission for the file systems to non-privileged users. .sp .ne 2 +.mk .na \fB[\fB-ug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...]\fR .ad @@ -3014,6 +2916,7 @@ group with the same name as a user, use the \fB-g\fR options. .sp .ne 2 +.mk .na \fB[\fB-e\fR] \fIperm\fR|@\fIsetname\fR[,...]\fR .ad @@ -3028,6 +2931,7 @@ set names, which begin with an at sign (\fB@\fR) , may be specified. See the .sp .ne 2 +.mk .na \fB[\fB-ld\fR] \fIfilesystem\fR|\fIvolume\fR\fR .ad @@ -3064,7 +2968,7 @@ 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 +send subcommand share subcommand Allows sharing file systems over NFS or SMB protocols snapshot subcommand Must also have the 'mount' ability @@ -3074,45 +2978,46 @@ userprop other Allows changing any user property userquota other Allows accessing any userquota@... property userused other Allows reading any userused@... property -aclinherit property -aclmode property -atime property -canmount property -casesensitivity property -checksum property -compression property -copies property -devices property -exec property -mountpoint property -nbmand property -normalization property -primarycache property -quota property -readonly property -recordsize property -refquota property -refreservation property -reservation property -secondarycache property -setuid property -shareiscsi property -sharenfs property -sharesmb property -snapdir property -utf8only property -version property -volblocksize property -volsize property -vscan property -xattr property -zoned property +aclinherit property +aclmode property +atime property +canmount property +casesensitivity property +checksum property +compression property +copies property +devices property +exec property +mountpoint property +nbmand property +normalization property +primarycache property +quota property +readonly property +recordsize property +refquota property +refreservation property +reservation property +secondarycache property +setuid property +shareiscsi property +sharenfs property +sharesmb property +snapdir property +utf8only property +version property +volblocksize property +volsize property +vscan property +xattr property +zoned property .fi .in -2 .sp .sp .ne 2 +.mk .na \fB\fBzfs allow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR @@ -3125,6 +3030,7 @@ creator of any newly-created descendent file system. .sp .ne 2 +.mk .na \fB\fBzfs allow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR @@ -3141,6 +3047,7 @@ characters long. .sp .ne 2 +.mk .na \fB\fBzfs unallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] @@ -3171,6 +3078,7 @@ not all permissions for every user and group. See the \fBzfs allow\fR command for a description of the \fB-ldugec\fR options. .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -3183,6 +3091,7 @@ Recursively remove the permissions from this file system and all descendents. .sp .ne 2 +.mk .na \fB\fBzfs unallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR @@ -3199,6 +3108,7 @@ then all permissions are removed, thus removing the set entirely. .sp .ne 2 +.mk .na \fB\fBzfs hold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR .ad @@ -3212,6 +3122,7 @@ If a hold exists on a snapshot, attempts to destroy that snapshot by using the \fBzfs destroy\fR command return \fBEBUSY\fR. .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -3225,6 +3136,7 @@ snapshots of all descendent file systems. .sp .ne 2 +.mk .na \fB\fBzfs holds\fR [\fB-r\fR] \fIsnapshot\fR...\fR .ad @@ -3233,6 +3145,7 @@ snapshots of all descendent file systems. Lists all existing user references for the given snapshot or snapshots. .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -3246,6 +3159,7 @@ listing the holds on the named snapshot. .sp .ne 2 +.mk .na \fB\fBzfs release\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR .ad @@ -3258,6 +3172,7 @@ If a hold exists on a snapshot, attempts to destroy that snapshot by using the \fBzfs destroy\fR command return \fBEBUSY\fR. .sp .ne 2 +.mk .na \fB\fB-r\fR\fR .ad @@ -3408,7 +3323,7 @@ pool/home/bob setuid on default pool/home/bob readonly off default pool/home/bob zoned off default pool/home/bob snapdir hidden default -pool/home/bob aclmode discard default +pool/home/bob aclmode groupmask default pool/home/bob aclinherit restricted default pool/home/bob canmount on default pool/home/bob shareiscsi off default @@ -3602,7 +3517,7 @@ target. # \fBzfs set shareiscsi=on pool/volumes/vol1\fR # \fBiscsitadm list target\fR Target: pool/volumes/vol1 - iSCSI Name: + iSCSI Name: iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c Connections: 0 .fi @@ -3714,7 +3629,7 @@ Create time permissions on (tank/users) create,destroy Local+Descendent permissions on (tank/users) group staff create,mount -------------------------------------------------------------- +------------------------------------------------------------- .fi .in -2 .sp @@ -3765,7 +3680,7 @@ Local+Descendent permissions on (users/home) cindys% \fBzfs set quota=10G users/home/marks\fR cindys% \fBzfs get quota users/home/marks\fR NAME PROPERTY VALUE SOURCE -users/home/marks quota 10G local +users/home/marks quota 10G local .fi .in -2 .sp @@ -3790,7 +3705,7 @@ Create time permissions on (tank/users) create,destroy Local+Descendent permissions on (tank/users) group staff @pset,create,mount -------------------------------------------------------------- +------------------------------------------------------------- .fi .in -2 .sp @@ -3801,6 +3716,7 @@ Local+Descendent permissions on (tank/users) The following exit values are returned: .sp .ne 2 +.mk .na \fB\fB0\fR\fR .ad @@ -3811,6 +3727,7 @@ Successful completion. .sp .ne 2 +.mk .na \fB\fB1\fR\fR .ad @@ -3821,6 +3738,7 @@ An error occurred. .sp .ne 2 +.mk .na \fB\fB2\fR\fR .ad @@ -3837,12 +3755,13 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE _ -Interface Stability Committed +Interface StabilityCommitted .TE .SH SEE ALSO diff --git a/man/man1m/zpool.1m b/man/man1m/zpool.1m index a2a9b723ccb7f..7a67781be25a5 100644 --- a/man/man1m/zpool.1m +++ b/man/man1m/zpool.1m @@ -1,20 +1,9 @@ '\" te .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2011, Nexenta Systems, Inc. All Rights Reserved. -.\" Copyright (c) 2012 by Delphix. All rights reserved. -.\" The contents of this file are subject to the terms of the Common Development -.\" and Distribution License (the "License"). You may not use this file except -.\" in compliance with the License. You can obtain a copy of the license at -.\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. -.\" -.\" See the License for the specific language governing permissions and -.\" limitations under the License. When distributing Covered Code, include this -.\" CDDL HEADER in each file and include the License file at -.\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this -.\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your -.\" own identifying information: -.\" Portions Copyright [yyyy] [name of copyright owner] -.TH ZPOOL 1M "Mar 16, 2012" +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. +.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the +.\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH zpool 1M "21 Sep 2009" "SunOS 5.11" "System Administration Commands" .SH NAME zpool \- configures ZFS storage pools .SH SYNOPSIS @@ -40,7 +29,7 @@ zpool \- configures ZFS storage pools .LP .nf -\fBzpool create\fR [\fB-fnd\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR] +\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ... .fi @@ -76,7 +65,7 @@ zpool \- configures ZFS storage pools .LP .nf -\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] +\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR .fi @@ -93,7 +82,7 @@ zpool \- configures ZFS storage pools .LP .nf -\fBzpool list\fR [\fB-Hv\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ... +\fBzpool list\fR [\fB-H\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ... .fi .LP @@ -108,11 +97,6 @@ zpool \- configures ZFS storage pools .LP .nf -\fBzpool reguid\fR \fIpool\fR -.fi - -.LP -.nf \fBzpool remove\fR \fIpool\fR \fIdevice\fR ... .fi @@ -138,7 +122,7 @@ zpool \- configures ZFS storage pools .LP .nf -\fBzpool upgrade\fR +\fBzpool upgrade\fR .fi .LP @@ -169,10 +153,12 @@ organized according to certain performance and fault characteristics. The following virtual devices are supported: .sp .ne 2 +.mk .na \fB\fBdisk\fR\fR .ad .RS 10n +.rt A block device, typically located under \fB/dev/dsk\fR. \fBZFS\fR can use individual slices or partitions, though the recommended mode of operation is to use whole disks. A disk can be specified by a full path, or it can be a @@ -184,10 +170,12 @@ disk, \fBZFS\fR automatically labels the disk, if necessary. .sp .ne 2 +.mk .na \fB\fBfile\fR\fR .ad .RS 10n +.rt A regular file. The use of files as a backing store is strongly discouraged. It is designed primarily for experimental purposes, as the fault tolerance of a file is only as good as the file system of which it is a part. A file must be @@ -196,10 +184,12 @@ specified by a full path. .sp .ne 2 +.mk .na \fB\fBmirror\fR\fR .ad .RS 10n +.rt A mirror of two or more devices. Data is replicated in an identical fashion across all components of a mirror. A mirror with \fIN\fR disks of size \fIX\fR can hold \fIX\fR bytes and can withstand (\fIN-1\fR) devices failing before @@ -208,6 +198,7 @@ data integrity is compromised. .sp .ne 2 +.mk .na \fB\fBraidz\fR\fR .ad @@ -224,6 +215,7 @@ data integrity is compromised. \fB\fBraidz3\fR\fR .ad .RS 10n +.rt A variation on \fBRAID-5\fR that allows for better distribution of parity and eliminates the "\fBRAID-5\fR write hole" (in which data and parity become inconsistent after a power loss). Data and parity is striped across all disks @@ -246,20 +238,24 @@ disks. The recommended number is between 3 and 9 to help increase performance. .sp .ne 2 +.mk .na \fB\fBspare\fR\fR .ad .RS 10n +.rt A special pseudo-\fBvdev\fR which keeps track of available hot spares for a pool. For more information, see the "Hot Spares" section. .RE .sp .ne 2 +.mk .na \fB\fBlog\fR\fR .ad .RS 10n +.rt A separate-intent log device. If more than one log device is specified, then writes are load-balanced between devices. Log devices can be mirrored. However, \fBraidz\fR \fBvdev\fR types are not supported for the intent log. For more @@ -268,10 +264,12 @@ information, see the "Intent Log" section. .sp .ne 2 +.mk .na \fB\fBcache\fR\fR .ad .RS 10n +.rt A device used to cache storage pool data. A cache device cannot be cannot be configured as a mirror or \fBraidz\fR group. For more information, see the "Cache Devices" section. @@ -331,10 +329,12 @@ devices. A top-level vdev or component device is in one of the following states: .sp .ne 2 +.mk .na \fB\fBDEGRADED\fR\fR .ad .RS 12n +.rt One or more top-level vdevs is in the degraded state because one or more component devices are offline. Sufficient replicas exist to continue functioning. @@ -362,10 +362,12 @@ functioning. .sp .ne 2 +.mk .na \fB\fBFAULTED\fR\fR .ad .RS 12n +.rt One or more top-level vdevs is in the faulted state because one or more component devices are offline. Insufficient replicas exist to continue functioning. @@ -390,38 +392,46 @@ prevent further use of the device. .sp .ne 2 +.mk .na \fB\fBOFFLINE\fR\fR .ad .RS 12n +.rt The device was explicitly taken offline by the "\fBzpool offline\fR" command. .RE .sp .ne 2 +.mk .na \fB\fBONLINE\fR\fR .ad .RS 12n +.rt The device is online and functioning. .RE .sp .ne 2 +.mk .na \fB\fBREMOVED\fR\fR .ad .RS 12n +.rt The device was physically removed while the system was running. Device removal detection is hardware-dependent and may not be supported on all platforms. .RE .sp .ne 2 +.mk .na \fB\fBUNAVAIL\fR\fR .ad .RS 12n +.rt The device could not be opened. If a pool is imported when a device was unavailable, then the device will be identified by a unique identifier instead of its path since the path was never correct in the first place. @@ -535,107 +545,76 @@ read-only statistics while others are configurable and change the behavior of the pool. The following are read-only properties: .sp .ne 2 +.mk .na \fB\fBavailable\fR\fR .ad .RS 20n +.rt Amount of storage available within the pool. This property can also be referred to by its shortened column name, "avail". .RE .sp .ne 2 +.mk .na \fB\fBcapacity\fR\fR .ad .RS 20n +.rt Percentage of pool space used. This property can also be referred to by its shortened column name, "cap". .RE .sp .ne 2 -.na -\fB\fBexpandsize\fR\fR -.ad -.RS 20n -Amount of uninitialized space within the pool or device that can be used to -increase the total capacity of the pool. Uninitialized space consists of -any space on an EFI labeled vdev which has not been brought online -(i.e. zpool online -e). This space occurs when a LUN is dynamically expanded. -.RE - -.sp -.ne 2 -.na -\fB\fBfree\fR\fR -.ad -.RS 20n -The amount of free space available in the pool. -.RE - -.sp -.ne 2 -.na -\fB\fBfreeing\fR\fR -.ad -.RS 20n -After a file system or snapshot is destroyed, the space it was using is -returned to the pool asynchronously. \fB\fBfreeing\fR\fR is the amount of -space remaining to be reclaimed. Over time \fB\fBfreeing\fR\fR will decrease -while \fB\fBfree\fR\fR increases. -.RE - -.sp -.ne 2 +.mk .na \fB\fBhealth\fR\fR .ad .RS 20n +.rt The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR", "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR". .RE .sp .ne 2 +.mk .na \fB\fBguid\fR\fR .ad .RS 20n +.rt A unique identifier for the pool. .RE .sp .ne 2 +.mk .na \fB\fBsize\fR\fR .ad .RS 20n +.rt Total size of the storage pool. .RE .sp .ne 2 -.na -\fB\fBunsupported@\fR\fIfeature_guid\fR\fR -.ad -.RS 20n -Information about unsupported features that are enabled on the pool. See -\fBzpool-features\fR(5) for details. -.RE - -.sp -.ne 2 +.mk .na \fB\fBused\fR\fR .ad .RS 20n +.rt Amount of storage space used within the pool. .RE .sp .LP -The space usage properties report actual physical space available to the +These space usage properties report actual physical space available to the storage pool. The physical space can be different from the total amount of space that any contained datasets can actually use. The amount of space used in a \fBraidz\fR configuration depends on the characteristics of the data being @@ -649,6 +628,7 @@ these discrepancies may become more noticeable. The following property can be set at creation time and import time: .sp .ne 2 +.mk .na \fB\fBaltroot\fR\fR .ad @@ -659,7 +639,7 @@ points within the pool. This can be used when examining an unknown pool where the mount points cannot be trusted, or in an alternate boot environment, where the typical paths are not valid. \fBaltroot\fR is not a persistent property. It is valid only while the system is up. Setting \fBaltroot\fR defaults to using -\fBcachefile\fR=none, though this may be overridden using an explicit setting. +\fBcachefile\fR=none, though this may be overridden using an explicit setting. .RE .sp @@ -668,6 +648,7 @@ The following properties can be set at creation time and import time, and later changed with the \fBzpool set\fR command: .sp .ne 2 +.mk .na \fB\fBautoexpand\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -683,6 +664,7 @@ can also be referred to by its shortened column name, \fBexpand\fR. .sp .ne 2 +.mk .na \fB\fBautoreplace\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -698,6 +680,7 @@ property can also be referred to by its shortened column name, "replace". .sp .ne 2 +.mk .na \fB\fBbootfs\fR=\fIpool\fR/\fIdataset\fR\fR .ad @@ -709,6 +692,7 @@ expected to be set mainly by the installation and upgrade programs. .sp .ne 2 +.mk .na \fB\fBcachefile\fR=\fIpath\fR | \fBnone\fR\fR .ad @@ -733,17 +717,7 @@ exported or destroyed, the file is removed. .sp .ne 2 -.na -\fB\fBcomment\fR=\fB\fItext\fR\fR -.ad -.RS 4n -A text string consisting of printable ASCII characters that will be stored -such that it is available even if the pool becomes faulted. An administrator -can provide additional information about a pool using this property. -.RE - -.sp -.ne 2 +.mk .na \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -756,6 +730,7 @@ permissions defined on the dataset. See \fBzfs\fR(1M) for more information on .sp .ne 2 +.mk .na \fB\fBfailmode\fR=\fBwait\fR | \fBcontinue\fR | \fBpanic\fR\fR .ad @@ -767,20 +742,24 @@ storage device(s) or a failure of all devices within the pool. The behavior of such an event is determined as follows: .sp .ne 2 +.mk .na \fB\fBwait\fR\fR .ad .RS 12n +.rt Blocks all \fBI/O\fR access until the device connectivity is recovered and the errors are cleared. This is the default behavior. .RE .sp .ne 2 +.mk .na \fB\fBcontinue\fR\fR .ad .RS 12n +.rt Returns \fBEIO\fR to any new write \fBI/O\fR requests but allows reads to any of the remaining healthy devices. Any write requests that have yet to be committed to disk would be blocked. @@ -788,10 +767,12 @@ committed to disk would be blocked. .sp .ne 2 +.mk .na \fB\fBpanic\fR\fR .ad .RS 12n +.rt Prints out a message to the console and generates a system crash dump. .RE @@ -799,18 +780,7 @@ Prints out a message to the console and generates a system crash dump. .sp .ne 2 -.na -\fB\fBfeature@\fR\fIfeature_name\fR=\fBenabled\fR\fR -.ad -.RS 4n -The value of this property is the current state of \fIfeature_name\fR. The -only valid value when setting this property is \fBenabled\fR which moves -\fIfeature_name\fR to the enabled state. See \fBzpool-features\fR(5) for -details on feature states. -.RE - -.sp -.ne 2 +.mk .na \fB\fBlistsnaps\fR=on | off\fR .ad @@ -823,6 +793,7 @@ value is "off". .sp .ne 2 +.mk .na \fB\fBversion\fR=\fIversion\fR\fR .ad @@ -831,8 +802,8 @@ value is "off". The current on-disk version of the pool. This can be increased, but never decreased. The preferred method of updating pools is with the "\fBzpool upgrade\fR" 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 value. +is needed for backwards compatibility. This property can be any number between +1 and the current version reported by "\fBzpool upgrade -v\fR". .RE .SS "Subcommands" @@ -847,6 +818,7 @@ pools, add capacity to storage pools, and provide information about the storage pools. The following subcommands are supported: .sp .ne 2 +.mk .na \fB\fBzpool\fR \fB-?\fR\fR .ad @@ -857,6 +829,7 @@ Displays a help message. .sp .ne 2 +.mk .na \fB\fBzpool add\fR [\fB-fn\fR] \fIpool\fR \fIvdev\fR ...\fR .ad @@ -868,20 +841,24 @@ the \fB-f\fR option, and the device checks performed are described in the "zpool create" subcommand. .sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad .RS 6n +.rt Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting replication level. Not all devices can be overridden in this manner. .RE .sp .ne 2 +.mk .na \fB\fB-n\fR\fR .ad .RS 6n +.rt Displays the configuration that would be used without actually adding the \fBvdev\fRs. The actual pool creation can still fail due to insufficient privileges or device sharing. @@ -894,6 +871,7 @@ device. .sp .ne 2 +.mk .na \fB\fBzpool attach\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR\fR .ad @@ -908,10 +886,12 @@ three-way mirror, and so on. In either case, \fInew_device\fR begins to resilver immediately. .sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad .RS 6n +.rt Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner. .RE @@ -920,6 +900,7 @@ devices can be overridden in this manner. .sp .ne 2 +.mk .na \fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR .ad @@ -932,8 +913,9 @@ those errors associated with the specified device or devices are cleared. .sp .ne 2 +.mk .na -\fB\fBzpool create\fR [\fB-fnd\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR +\fB\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ...\fR .ad @@ -963,10 +945,8 @@ Unless the \fB-R\fR option is specified, the default mount point is root dataset cannot be mounted. This can be overridden with the \fB-m\fR option. .sp -By default all supported features are enabled on the new pool unless the -\fB-d\fR option is specified. -.sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad @@ -978,6 +958,7 @@ replication level. Not all devices can be overridden in this manner. .sp .ne 2 +.mk .na \fB\fB-n\fR\fR .ad @@ -990,18 +971,7 @@ device sharing. .sp .ne 2 -.na -\fB\fB-d\fR\fR -.ad -.sp .6 -.RS 4n -Do not enable any features on the new pool. Individual features can be enabled -by setting their corresponding properties to \fBenabled\fR with the \fB-o\fR -option. See \fBzpool-features\fR(5) for details about feature properties. -.RE - -.sp -.ne 2 +.mk .na \fB\fB-o\fR \fIproperty=value\fR [\fB-o\fR \fIproperty=value\fR] ...\fR .ad @@ -1013,6 +983,7 @@ valid properties that can be set. .sp .ne 2 +.mk .na \fB\fB-O\fR \fIfile-system-property=value\fR\fR .ad @@ -1029,6 +1000,7 @@ can be set. .sp .ne 2 +.mk .na \fB\fB-R\fR \fIroot\fR\fR .ad @@ -1039,6 +1011,7 @@ Equivalent to "-o cachefile=none,altroot=\fIroot\fR" .sp .ne 2 +.mk .na \fB\fB-m\fR \fImountpoint\fR\fR .ad @@ -1054,6 +1027,7 @@ information on dataset mount points, see \fBzfs\fR(1M). .sp .ne 2 +.mk .na \fB\fBzpool destroy\fR [\fB-f\fR] \fIpool\fR\fR .ad @@ -1063,10 +1037,12 @@ Destroys the given pool, freeing up any devices for other use. This command tries to unmount any active datasets before destroying the pool. .sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad .RS 6n +.rt Forces any active datasets contained within the pool to be unmounted. .RE @@ -1074,6 +1050,7 @@ Forces any active datasets contained within the pool to be unmounted. .sp .ne 2 +.mk .na \fB\fBzpool detach\fR \fIpool\fR \fIdevice\fR\fR .ad @@ -1085,6 +1062,7 @@ other valid replicas of the data. .sp .ne 2 +.mk .na \fB\fBzpool export\fR [\fB-f\fR] \fIpool\fR ...\fR .ad @@ -1104,10 +1082,12 @@ labels. Otherwise, disk drivers on platforms of different endianness will not recognize the disks. .sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad .RS 6n +.rt Forcefully unmount all datasets, using the "\fBunmount -f\fR" command. .sp This command will forcefully export the pool even if it has a shared spare that @@ -1118,6 +1098,7 @@ is currently being used. This may lead to potential data corruption. .sp .ne 2 +.mk .na \fB\fBzpool get\fR "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...\fR .ad @@ -1143,6 +1124,7 @@ properties. .sp .ne 2 +.mk .na \fB\fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...\fR .ad @@ -1152,20 +1134,24 @@ Displays the command history of the specified pools or all pools if no pool is specified. .sp .ne 2 +.mk .na \fB\fB-i\fR\fR .ad .RS 6n +.rt Displays internally logged \fBZFS\fR events in addition to user initiated events. .RE .sp .ne 2 +.mk .na \fB\fB-l\fR\fR .ad .RS 6n +.rt Displays log records in long format, which in addition to standard format includes, the user name, the hostname, and the zone in which the operation was performed. @@ -1175,6 +1161,7 @@ performed. .sp .ne 2 +.mk .na \fB\fBzpool import\fR [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR]\fR @@ -1194,10 +1181,12 @@ The numeric identifier is unique, and can be used instead of the pool name when multiple exported pools of the same name are available. .sp .ne 2 +.mk .na \fB\fB-c\fR \fIcachefile\fR\fR .ad .RS 16n +.rt Reads configuration from the given \fBcachefile\fR that was created with the "\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of searching for devices. @@ -1205,20 +1194,24 @@ searching for devices. .sp .ne 2 +.mk .na \fB\fB-d\fR \fIdir\fR\fR .ad .RS 16n +.rt Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times. .RE .sp .ne 2 +.mk .na \fB\fB-D\fR\fR .ad .RS 16n +.rt Lists destroyed pools only. .RE @@ -1226,6 +1219,7 @@ Lists destroyed pools only. .sp .ne 2 +.mk .na \fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] @@ -1240,10 +1234,12 @@ are imported. Destroyed pools, pools that were previously destroyed with the is specified. .sp .ne 2 +.mk .na \fB\fB-o\fR \fImntopts\fR\fR .ad .RS 21n +.rt Comma-separated list of mount options to use when mounting datasets within the pool. See \fBzfs\fR(1M) for a description of dataset properties and mount options. @@ -1251,20 +1247,24 @@ options. .sp .ne 2 +.mk .na \fB\fB-o\fR \fIproperty=value\fR\fR .ad .RS 21n +.rt Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties. .RE .sp .ne 2 +.mk .na \fB\fB-c\fR \fIcachefile\fR\fR .ad .RS 21n +.rt Reads configuration from the given \fBcachefile\fR that was created with the "\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of searching for devices. @@ -1272,47 +1272,57 @@ searching for devices. .sp .ne 2 +.mk .na \fB\fB-d\fR \fIdir\fR\fR .ad .RS 21n +.rt Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times. This option is incompatible with the \fB-c\fR option. .RE .sp .ne 2 +.mk .na \fB\fB-D\fR\fR .ad .RS 21n +.rt Imports destroyed pools only. The \fB-f\fR option is also required. .RE .sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad .RS 21n +.rt Forces import, even if the pool appears to be potentially active. .RE .sp .ne 2 +.mk .na \fB\fB-a\fR\fR .ad .RS 21n +.rt Searches for and imports all pools found. .RE .sp .ne 2 +.mk .na \fB\fB-R\fR \fIroot\fR\fR .ad .RS 21n +.rt Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR". .RE @@ -1321,6 +1331,7 @@ property to "\fIroot\fR". .sp .ne 2 +.mk .na \fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] @@ -1340,6 +1351,7 @@ this was a failed export, or whether the device is really in use from another host. To import a pool in this state, the \fB-f\fR option is required. .sp .ne 2 +.mk .na \fB\fB-o\fR \fImntopts\fR\fR .ad @@ -1352,6 +1364,7 @@ options. .sp .ne 2 +.mk .na \fB\fB-o\fR \fIproperty=value\fR\fR .ad @@ -1363,6 +1376,7 @@ for more information on the available pool properties. .sp .ne 2 +.mk .na \fB\fB-c\fR \fIcachefile\fR\fR .ad @@ -1375,6 +1389,7 @@ searching for devices. .sp .ne 2 +.mk .na \fB\fB-d\fR \fIdir\fR\fR .ad @@ -1386,6 +1401,7 @@ specified multiple times. This option is incompatible with the \fB-c\fR option. .sp .ne 2 +.mk .na \fB\fB-D\fR\fR .ad @@ -1396,6 +1412,7 @@ Imports destroyed pool. The \fB-f\fR option is also required. .sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad @@ -1406,6 +1423,7 @@ Forces import, even if the pool appears to be potentially active. .sp .ne 2 +.mk .na \fB\fB-R\fR \fIroot\fR\fR .ad @@ -1419,6 +1437,7 @@ property to "\fIroot\fR". .sp .ne 2 +.mk .na \fB\fBzpool iostat\fR [\fB-T\fR \fBu\fR | \fBd\fR] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR @@ -1432,10 +1451,12 @@ system is shown. If \fIcount\fR is specified, the command exits after \fIcount\fR reports are printed. .sp .ne 2 +.mk .na \fB\fB-T\fR \fBu\fR | \fBd\fR\fR .ad .RS 12n +.rt Display a time stamp. .sp Specify \fBu\fR for a printed representation of the internal representation of @@ -1445,10 +1466,12 @@ time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See .sp .ne 2 +.mk .na \fB\fB-v\fR\fR .ad .RS 12n +.rt Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wide statistics. .RE @@ -1457,8 +1480,9 @@ the pool, in addition to the pool-wide statistics. .sp .ne 2 +.mk .na -\fB\fBzpool list\fR [\fB-Hv\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ...\fR +\fB\fBzpool list\fR [\fB-H\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ...\fR .ad .sp .6 .RS 4n @@ -1466,39 +1490,34 @@ Lists the given pools along with a health status and space usage. When given no arguments, all pools in the system are listed. .sp .ne 2 +.mk .na \fB\fB-H\fR\fR .ad .RS 12n +.rt Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space. .RE .sp .ne 2 +.mk .na \fB\fB-o\fR \fIprops\fR\fR .ad .RS 12n +.rt Comma-separated list of properties to display. See the "Properties" section for a list of valid properties. The default list is "name, size, used, available, -expandsize, capacity, dedupratio, health, altroot" -.RE - -.sp -.ne 2 -.na -\fB\fB-v\fR\fR -.ad -.RS 12n -Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within -the pool, in addition to the pool-wise statistics. +capacity, health, altroot" .RE .RE .sp .ne 2 +.mk .na \fB\fBzpool offline\fR [\fB-t\fR] \fIpool\fR \fIdevice\fR ...\fR .ad @@ -1510,10 +1529,12 @@ no attempt is made to read or write to the device. This command is not applicable to spares or cache devices. .sp .ne 2 +.mk .na \fB\fB-t\fR\fR .ad .RS 6n +.rt Temporary. Upon reboot, the specified physical device reverts to its previous state. .RE @@ -1522,6 +1543,7 @@ state. .sp .ne 2 +.mk .na \fB\fBzpool online\fR [\fB-e\fR] \fIpool\fR \fIdevice\fR...\fR .ad @@ -1532,10 +1554,12 @@ Brings the specified physical device online. This command is not applicable to spares or cache devices. .sp .ne 2 +.mk .na \fB\fB-e\fR\fR .ad .RS 6n +.rt Expand the device to use all available space. If the device is part of a mirror or \fBraidz\fR then all devices must be expanded before the new space will become available to the pool. @@ -1545,17 +1569,7 @@ become available to the pool. .sp .ne 2 -.na -\fB\fBzpool reguid\fR \fIpool\fR -.ad -.sp .6 -.RS 4n -Generates a new unique identifier for the pool. You must ensure that all devices in this pool are online and -healthy before performing this action. -.RE - -.sp -.ne 2 +.mk .na \fB\fBzpool remove\fR \fIpool\fR \fIdevice\fR ...\fR .ad @@ -1571,6 +1585,7 @@ a pool. .sp .ne 2 +.mk .na \fB\fBzpool replace\fR [\fB-f\fR] \fIpool\fR \fIold_device\fR [\fInew_device\fR]\fR @@ -1591,10 +1606,12 @@ this case, the new disk may have the same \fB/dev/dsk\fR path as the old device, even though it is actually a different disk. \fBZFS\fR recognizes this. .sp .ne 2 +.mk .na \fB\fB-f\fR\fR .ad .RS 6n +.rt Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner. .RE @@ -1603,6 +1620,7 @@ devices can be overridden in this manner. .sp .ne 2 +.mk .na \fB\fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ...\fR .ad @@ -1627,10 +1645,12 @@ progress, \fBZFS\fR does not allow a scrub to be started until the resilver completes. .sp .ne 2 +.mk .na \fB\fB-s\fR\fR .ad .RS 6n +.rt Stop scrubbing. .RE @@ -1638,6 +1658,7 @@ Stop scrubbing. .sp .ne 2 +.mk .na \fB\fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR\fR .ad @@ -1649,6 +1670,7 @@ more information on what properties can be set and acceptable values. .sp .ne 2 +.mk .na \fB\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...\fR .ad @@ -1665,20 +1687,24 @@ because the amount of data in the pool and the other workloads on the system can change. .sp .ne 2 +.mk .na \fB\fB-x\fR\fR .ad .RS 6n +.rt Only display status for pools that are exhibiting errors or are otherwise unavailable. .RE .sp .ne 2 +.mk .na \fB\fB-v\fR\fR .ad .RS 6n +.rt Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub. .RE @@ -1687,6 +1713,7 @@ data errors since the last complete pool scrub. .sp .ne 2 +.mk .na \fB\fBzpool upgrade\fR\fR .ad @@ -1701,6 +1728,7 @@ inaccessible on the system. .sp .ne 2 +.mk .na \fB\fBzpool upgrade\fR \fB-v\fR\fR .ad @@ -1713,6 +1741,7 @@ with an explanation of the features provided with each version. .sp .ne 2 +.mk .na \fB\fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...\fR .ad @@ -1723,19 +1752,23 @@ pool will no longer be accessible on systems running older versions of the software. .sp .ne 2 +.mk .na \fB\fB-a\fR\fR .ad .RS 14n +.rt Upgrades all pools. .RE .sp .ne 2 +.mk .na \fB\fB-V\fR \fIversion\fR\fR .ad .RS 14n +.rt Upgrade to the specified version. If the \fB-V\fR flag is not specified, the pool is upgraded to the most recent version. This option can only be used to increase the version number, and only up to the most recent version supported @@ -1835,10 +1868,10 @@ The results from this command are similar to the following: .in +2 .nf # \fBzpool list\fR - NAME SIZE ALLOC FREE EXPANDSZ CAP DEDUP HEALTH ALTROOT - rpool 19.9G 8.43G 11.4G - 42% 1.00x ONLINE - - tank 61.5G 20.0G 41.5G - 32% 1.00x ONLINE - - zion - - - - - - FAULTED - + NAME SIZE USED AVAIL CAP HEALTH ALTROOT + pool 67.5G 2.92M 67.5G 0% ONLINE - + tank 67.5G 2.92M 67.5G 0% ONLINE - + zion - - - 0% FAULTED - .fi .in -2 .sp @@ -2053,57 +2086,40 @@ The command to remove the mirrored log \fBmirror-2\fR is: .in -2 .sp -.LP -\fBExample 15 \fRDisplaying expanded space on a device -.sp -.LP -The following command dipslays the detailed information for the \fIdata\fR -pool. This pool is comprised of a single \fIraidz\fR vdev where one of its -devices increased its capacity by 1GB. In this example, the pool will not -be able to utilized this extra capacity until all the devices under the -\fIraidz\fR vdev have been expanded. - -.sp -.in +2 -.nf -# \fBzpool list -v data\fR - NAME SIZE ALLOC FREE EXPANDSZ CAP DEDUP HEALTH ALTROOT - data 17.9G 174K 17.9G - 0% 1.00x ONLINE - - raidz1 17.9G 174K 17.9G - - c4t2d0 - - - 1G - c4t3d0 - - - - - c4t4d0 - - - - -.fi -.in -2 - .SH EXIT STATUS .sp .LP The following exit values are returned: .sp .ne 2 +.mk .na \fB\fB0\fR\fR .ad .RS 5n +.rt Successful completion. .RE .sp .ne 2 +.mk .na \fB\fB1\fR\fR .ad .RS 5n +.rt An error occurred. .RE .sp .ne 2 +.mk .na \fB\fB2\fR\fR .ad .RS 5n +.rt Invalid command line options were specified. .RE @@ -2115,15 +2131,16 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE _ -Interface Stability Evolving +Interface StabilityEvolving .TE .SH SEE ALSO .sp .LP -\fBzfs\fR(1M), \fBzpool-features\fR(5), \fBattributes\fR(5) +\fBzfs\fR(1M), \fBattributes\fR(5) diff --git a/man/man1m/zstreamdump.1m b/man/man1m/zstreamdump.1m index 70f6ee875eb75..d8b5e94681818 100644 --- a/man/man1m/zstreamdump.1m +++ b/man/man1m/zstreamdump.1m @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ZSTREAMDUMP 1M "Sep 21, 2009" +.TH zstreamdump 1M "21 Sep 2009" "SunOS 5.11" "System Administration Commands" .SH NAME zstreamdump \- filter data in zfs send stream .SH SYNOPSIS @@ -24,6 +24,7 @@ command, then displays headers and some statistics from that output. See The following options are supported: .sp .ne 2 +.mk .na \fB\fB-C\fR\fR .ad @@ -34,6 +35,7 @@ Suppress the validation of checksums. .sp .ne 2 +.mk .na \fB\fB-v\fR\fR .ad @@ -50,12 +52,13 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE _ -Interface Stability Uncommitted +Interface StabilityUncommitted .TE .SH SEE ALSO |