path: root/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1
diff options
authorMark Johnston <markj@FreeBSD.org>2018-08-16 19:28:44 +0000
committerMark Johnston <markj@FreeBSD.org>2018-08-16 19:28:44 +0000
commitf0af0b312fd38c5ca57c35d30383f3d3e655a6f8 (patch)
tree8dbe88210d9bd699383e87daebcb6adcadbde0eb /cddl/contrib/opensolaris/cmd/dtrace/dtrace.1
parentc542c43ef1df2a13c059910afc58b49699cc72ea (diff)
Add partial documentation for dtrace(1)'s -x configuration options.
Some options are still missing descriptions, but they can be filled in over time. Submitted by: raichoo <raichoo@googlemail.com> Reviewed by: 0mp (previous version) MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D16671
Notes: svn path=/head/; revision=337926
Diffstat (limited to 'cddl/contrib/opensolaris/cmd/dtrace/dtrace.1')
1 files changed, 111 insertions, 2 deletions
diff --git a/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 b/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1
index 907baee660b6..a566e5eafaaa 100644
--- a/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1
+++ b/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1
@@ -1,4 +1,3 @@
-'\" te
.\" The contents of this file are subject to the terms of the
@@ -21,7 +20,7 @@
.\" $FreeBSD$
-.Dd April 18, 2015
+.Dd August 16, 2018
@@ -523,6 +522,116 @@ Enable or modify a DTrace runtime option or D compiler option.
Boolean options are enabled by specifying their name.
Options with values are set by separating the option name and value with an
equals sign (=).
+.Ar size
+argument may be suffixed with one of
+.Cm K ,
+.Cm M ,
+.Cm G
+.Cm T
+(either upper or lower case) to indicate a multiple of
+Kilobytes, Megabytes, Gigabytes or Terabytes
+.Ar time
+argument may be suffixed with one of
+.Cm ns ,
+.Cm nsec ,
+.Cm us ,
+.Cm usec ,
+.Cm ms ,
+.Cm msec ,
+.Cm s ,
+.Cm sec ,
+.Cm m ,
+.Cm min ,
+.Cm h ,
+.Cm hour ,
+.Cm d ,
+.Cm day ,
+.Cm hz .
+If no suffix is specified
+.Cm hz
+will be used as the unit.
+.Bl -tag -width indent
+.It Sy aggrate Ns = Ns Ar time
+Rate of aggregation reading.
+.It Sy aggsize Ns = Ns Ar size
+Size of the aggregation buffer.
+.It Sy bufpolicy Ns = Ns Cm fill Ns | Ns Cm switch Ns | Ns Cm ring
+Specifies the buffer policy for the principal buffer.
+.It Sy bufresize Ns = Ns Cm auto Ns | Ns Cm manual
+Buffer resizing policy.
+.It Sy bufsize Ns = Ns Ar size
+Size of the per-CPU principal buffer.
+Same as the
+.Fl b
+.It Sy cleanrate Ns = Ns Ar time
+Cleaning rate.
+Must be specified in number-per-second with the
+.Dq Li hz
+.It Sy cpu Ns = Ns Ar scalar
+Specifies the CPU on which to enable tracing.
+.It Sy defaultargs
+Allow references to unspecified macro arguments.
+.It Sy destructive
+Allow destructive actions.
+Same as the
+.Fl w
+.It Sy dynvarsize Ns = Ns Ar size
+Size of the dynamic variable space.
+.It Sy flowindent
+Turn on flow indentation.
+Same as the
+.Fl F
+.It Sy grabanon
+Claim anonymous state.
+Same as the
+.Fl a
+.It Sy jstackframes Ns = Ns Ar scalar
+Number of default stack frames for
+.Fn jstack .
+.It Sy jstackstrsize Ns = Ns Ar scalar
+Default string space size for
+.Fn jstack .
+.It Sy nspec Ns = Ns Ar scalar
+Number of speculations.
+.It Sy quiet
+Set quiet mode.
+Same as the
+.Fl q
+.It Sy specsize Ns = Ns Ar size
+Size of the speculation buffer.
+.It Sy strsize Ns = Ns Ar size
+Maximum size of strings.
+.It Sy stackframes Ns = Ns Ar scalar
+Maximum number of kernelspace stack frames to unwind when executing the
+.Fn stack
+.It Sy stackindent Ns = Ns Ar scalar
+Number of whitespace characters to use when indenting
+.Fn stack
+.Fn ustack
+.It Sy statusrate Ns = Ns Ar time
+Rate of status checking.
+.It Sy switchrate Ns = Ns Ar time
+Rate of buffer switching.
+.It Sy ustackframes Ns = Ns Ar scalar
+Maximum number of userspace stack frames to unwind when executing the
+.Fn ustack
.It Fl X Cm a | c | s | t
Specify the degree of conformance to the ISO C standard that should be selected
when invoking