[DTrace-devel] [PATCH 3/7] man: fix manpage
Kris Van Hees
kris.van.hees at oracle.com
Tue Dec 6 21:50:25 UTC 2022
The manpage is moved to section 8 (System Management Commands) since
that is more appropriate. This also makes it no longer necessary to
handle the conflict with the dtrace manpage provided by systemtap for
its dtrace-lookalike utility.
The formatting macros have been updated to use the simpler (standard)
ones described in groff_man.
References to the Oracle Linux DTrace Guide have been updated.
Signed-off-by: Kris Van Hees <kris.van.hees at oracle.com>
---
GNUmakefile | 2 +-
cmd/Build | 4 +-
cmd/{dtrace.1 => dtrace.8} | 491 +++++++------------------------------
dtrace.spec | 25 +-
4 files changed, 98 insertions(+), 424 deletions(-)
rename cmd/{dtrace.1 => dtrace.8} (79%)
diff --git a/GNUmakefile b/GNUmakefile
index e26d4a86..54a3c48c 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -91,7 +91,7 @@ SYSTEMDUNITDIR := $(prefix)/lib/systemd/system
INSTSYSTEMDUNITDIR := $(DESTDIR)$(SYSTEMDUNITDIR)
DOCDIR := $(prefix)/share/doc/dtrace-$(VERSION)
INSTDOCDIR := $(DESTDIR)$(DOCDIR)
-MANDIR := $(prefix)/share/man/man1
+MANDIR := $(prefix)/share/man/man8
INSTMANDIR := $(DESTDIR)$(MANDIR)
TESTDIR := $(prefix)/lib$(BITNESS)/dtrace/testsuite
INSTTESTDIR := $(DESTDIR)$(TESTDIR)
diff --git a/cmd/Build b/cmd/Build
index 78c9a496..644a3449 100644
--- a/cmd/Build
+++ b/cmd/Build
@@ -46,5 +46,5 @@ install::
$(INSTLIBDIR)/dtrace
$(call describe-install-target,$(INSTSBINDIR),dtrace)
install -m 755 $(objdir)/dtrace $(INSTSBINDIR)
- $(call describe-install-target,$(INSTMANDIR),dtrace.1)
- install -m 644 $(dtrace_DIR)/dtrace.1 $(INSTMANDIR)
+ $(call describe-install-target,$(INSTMANDIR),dtrace.8)
+ install -m 644 $(dtrace_DIR)/dtrace.8 $(INSTMANDIR)
diff --git a/cmd/dtrace.1 b/cmd/dtrace.8
similarity index 79%
rename from cmd/dtrace.1
rename to cmd/dtrace.8
index e89a04fe..da845c36 100644
--- a/cmd/dtrace.1
+++ b/cmd/dtrace.8
@@ -1,511 +1,202 @@
'\" te
.\" Oracle Linux DTrace.
-.\" Copyright (c) 2009, 2014, Oracle and/or its affiliates. All Rights Reserved.
+.\" Copyright (c) 2009, 2022, Oracle and/or its affiliates. All Rights Reserved.
.\" Licensed under the Universal Permissive License v 1.0 as shown at
.\" http://oss.oracle.com/licenses/upl.
-.TH dtrace 1M "22 Oct 2014" "Oracle Linux" "Linux Programmer's Manual"
+.TH dtrace 8 "22 Oct 2014" "Oracle Linux" "Linux Programmer's Manual"
.SH NAME
dtrace \- DTrace dynamic tracing compiler and tracing utility
.SH SYNOPSIS
-.LP
-.nf
-\fBdtrace\fR [\fB-CeFGHhlqSvVwZ\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]]
-.fi
+.SY dtrace
+.OP \-CeFGHhlqSvVwZ
+.OP \-b bufsz
+.OP \-c cmd
+.br
+.OP \-D name\ [=value]
+.OP \-I path
+.OP \-L path
+.OP \-o output
+.br
+.OP \-s script
+.OP \-U name
+.OP \-x arg\ [=val]
+.br
+.OP \-X a\ |\ c\ |\ s\ |\ t
+.OP \-p pid
+.br
+.OP \-P provider\ [[predicate]\ action]
+.br
+.OP \-m [provider\:]\ module\ [[predicate]\ action]
+.br
+.OP \-f [[provider\:]\ module\:]\ function\ [[predicate]\ action]
+.br
+.OP \-n [[[provider\:]\ module\:]\ function\:]name\ [[predicate]\ action]
+.br
+.OP \-i probe-id\ [[predicate]\ action]
+.SY
.SH DESCRIPTION
-.sp
.LP
DTrace is a comprehensive dynamic tracing framework for the Linux 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.
-.sp
+The \fIOracle Linux DTrace 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.
.LP
The \fBdtrace\fR command provides a generic interface to the essential services provided by the DTrace facility, including:
.RS +4
-.TP
-.ie t \(bu
-.el o
+.IP o
Options that list the set of probes and providers currently published by DTrace
-.RE
-.RS +4
-.TP
-.ie t \(bu
-.el o
+.IP o
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
+.IP o
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
-.ie t \(bu
-.el o
+.IP o
Options that generate anonymous tracing programs
-.RE
-.RS +4
-.TP
-.ie t \(bu
-.el o
+.IP o
Options that generate program stability reports
-.RE
-.RS +4
-.TP
-.ie t \(bu
-.el o
+.IP o
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 \fI\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 \fIOracle Linux DTrace 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 interpretation of meta-characters by the shell.
-.sp
.LP
The following options are supported:
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-b\fR \fIbufsz\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-c\fR \fIcmd\fR\fR
-.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 \fI\fR for more information on macro variables.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+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 \fIOracle Linux DTrace Guide\fR for more information on macro variables.
+.TP
\fB\fB-C\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-D\fR \fIname\fR \fB[=\fR\fIvalue\fR\fB]\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-e\fR\fR
-.ad
-.sp .6
-.RS 4n
Exit after compiling any requests, but prior to enabling any probes. You can 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
+.TP
\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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-F\fR\fR
-.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\&.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-G\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-H\fR\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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-h\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-i\fR \fIprobe-id\fR\fB[[\fR\fIpredicate\fR] \fIaction\fR\fB]\fR\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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-I\fR \fIpath\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-L\fR \fIpath\fR\fR
-.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 search path. If it exists, a subdirectory of \fIpath\fR named after the minor version of the running kernel (e.g. 3.8) is searched immediately before \fIpath\fR. (But take note: dependency analysis is performed only within each directory, not across directories.)
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-l\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-o\fR \fIoutput\fR\fR
-.ad
-.sp .6
-.RS 4n
Specify the \fIoutput\fR file for the \fB-G\fR, \fB-h\fR, and \fB-l\fR options, or for the traced data itself. 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
-.ne 2
-.mk
-.na
+.TP
\fB\fB-p\fR \fIpid\fR\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 \fI\fR for more information on macro variables.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+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 \fIOracle Linux DTrace Guide\fR for more information on macro variables.
+.TP
\fB\fB-P\fR \fIprovider\fR \fB[[\fR\fIpredicate\fR\fB]\fR \fIaction\fR]\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-q\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-s\fR\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, or \fB-G\fR are present, the instrumentation specified by the D program is enabled and tracing begins.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-S\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-U\fR \fIname\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-v\fR\fR
-.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 \fI\fR.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+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 \fIOracle Linux DTrace Guide\fR.
+.TP
\fB\fB-V\fR\fR
-.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 \fI\fR for more information about DTrace versioning features. In conjunction with \fB-v\fR, also reports information on the version of the \fBdtrace\fR(1) tool and associated library.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+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 \fIOracle Linux DTrace Guide\fR for more information about DTrace versioning features. In conjunction with \fB-v\fR, also reports information on the version of the \fBdtrace\fR(1) tool and associated library.
+.TP
\fB\fB-w\fR\fR
-.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.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
+.TP
\fB\fB-x\fR \fIarg\fR [\fI=val\fR]\fR
-.ad
-.sp .6
-.RS 4n
-Enable or modify a DTrace runtime option or D compiler option. The list of options is found in the \fI\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
-.ne 2
-.mk
-.na
+Enable or modify a DTrace runtime option or D compiler option. The list of options is found in the \fIOracle Linux DTrace 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).
+.TP
\fB\fB-Z\fR\fR
-.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.
-.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 \fI\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 \fIOracle Linux DTrace Guide\fR.
+
.SH EXIT STATUS
-.sp
.LP
The following exit values are returned:
-.sp
-.ne 2
-.mk
-.na
-\fB0\fR
-.ad
-.RS 5n
-.rt
+.TP
+.B 0
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.
-.RE
-.sp
-.ne 2
-.mk
-.na
-\fB\fB1\fR\fR
-.ad
-.RS 5n
-.rt
+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.
+.TP
+.B 1
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.
-.RE
-.sp
-.ne 2
-.mk
-.na
-\fB\fB2\fR\fR
-.ad
-.RS 5n
-.rt
+For D program requests, an exit status of \fB1\fR indicates that program compilation failed or that the specified request could not be satisfied.
+.TP
+.B 2
Invalid command line options or arguments were specified.
-.RE
+.\" .RE
.SH "ENVIRONMENT VARIABLES"
-.SP
.LP
The following environment variables are consulted:
-
-.SP
-.NE 2
-.MK
-.NA
-\fBDTRACE_DEBUG\fR
-.AD
-.RS 5n
-.RT
+.IP DTRACE_DEBUG
Print libdtrace debugging output on standard error.
-.RE
-
-.SP
-.NE 2
-.MK
-.NA
-\fBLIBCTF_DEBUG\fR
-.AD
-.RS 5n
-.RT
+.IP LIBCTF_DEBUG
Print CTF type library debugging output on standard error.
-.RE
-
-.SP
-.NE 2
-.MK
-.NA
-\fBDTRACE_OPT_*\fR
-.AD
-.RS 5n
-.RT
+.IP DTRACE_OPT_*
Set a given DTrace option.
-.SP
-Options set this way are overridden both by options specified via \fB-x\fR on the command line, and by \fBsetopt\fR statements.
-.RE
-.SP
-.NE 2
-.MK
-.NA
-\fBDTRACE_MODULES_CONF\fR
-.AD
-.RS 5n
-.RT
+Options set this way are overridden both by options specified via \fB-x\fR on the command line, and by \fBsetopt\fR statements.
+.IP DTRACE_MODULES_CONF
The location of the file containing names of kernel modules to load (see below).
-.SP
If unset, \fB/etc/dtrace-modules\fR.
-.RE
.SH "FILES"
-.SP
.LP
The following files are consulted:
-
-.SP
-.NE 2
-.MK
-.NA
-\fB/etc/dtrace-modules\fR
-.AD
-.RS 5n
-.RT
+.IP /etc/dtrace-modules
A list of kernel module names, one per line, which are loaded in addition to \fBdtrace.ko\fR if the \fBdtrace\fR device is not found. (Failure to load these modules is not an error.)
-.RE
.SH SEE ALSO
-.sp
-.LP
-\fBcpp\fR(1), \fBisainfo\fR(1), \fBssh\fR(1)
-.sp
+.BR cpp (1),
+.BR ssh (1)
.LP
-\fISolaris Dynamic Tracing Guide\fR
+.I Oracle Linux DTrace Guide
+
.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 \fBdtrace\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 \fBdtrace\fR tool clears the deadlock.
diff --git a/dtrace.spec b/dtrace.spec
index 9bf62747..1049738d 100644
--- a/dtrace.spec
+++ b/dtrace.spec
@@ -184,13 +184,8 @@ make DESTDIR=$RPM_BUILD_ROOT VERSION=%{version} \
HDRPREFIX="$RPM_BUILD_ROOT/usr/include" \
install install-test
-# Because systemtap creates a dtrace.1 manpage we have to rename
-# ours and then shift theirs out of the way (since the systemtap
-# dtrace page references a non-existent binary)
-mv $RPM_BUILD_ROOT/usr/share/man/man1/dtrace.1 \
- $RPM_BUILD_ROOT/usr/share/man/man1/orcl-dtrace.1
-
-# The same is true of sdt.h.
+# Because systemtap creates a sdt.h header file we have to rename
+# ours and then shift theirs out of the way.
mv $RPM_BUILD_ROOT/usr/include/sys/sdt.h \
$RPM_BUILD_ROOT/usr/include/sys/sdt-dtrace.h
@@ -204,16 +199,8 @@ rm -rf $RPM_BUILD_DIR/%{name}-%{version}
%systemd_post dtprobed.service dtrace-usdt.target
systemctl enable dtprobed.service dtrace-usdt.target
systemctl start dtprobed.service
-# if systemtap-dtrace.1.gz doesn't exist then we can move the existing dtrace manpage
-MANDIR=/usr/share/man/man1
-if [ -e $MANDIR/dtrace.1.gz -a ! -e $MANDIR/systemtap-dtrace.1.gz ]; then
- mv $MANDIR/dtrace.1.gz $MANDIR/systemtap-dtrace.1.gz
- ln -s $MANDIR/orcl-dtrace.1.gz $MANDIR/dtrace.1.gz
-elif [ ! -e $MANDIR/dtrace.1.gz ]; then
- ln -s $MANDIR/orcl-dtrace.1.gz $MANDIR/dtrace.1.gz
-fi
-# likewise for sdt.h
+# if sdt-systemtap.h doesn't exist then we can move the existing dtrace sdt.h
SYSINCDIR=/usr/include/sys
if [ -e $SYSINCDIR/sdt.h -a ! -e $SYSINCDIR/sdt-systemtap.h ]; then
mv $SYSINCDIR/sdt.h $SYSINCDIR/sdt-systemtap.h
@@ -227,10 +214,6 @@ fi
%postun
/sbin/ldconfig
-MANDIR=/usr/share/man/man1
-if [ -h $MANDIR/dtrace.1.gz ]; then
- rm -f $MANDIR/dtrace.1.gz
-fi
%udev_rules_update
%systemd_postun dtprobed.service dtrace-usdt.target
@@ -241,7 +224,7 @@ fi
%{_libdir}/libdtrace.so.*
%{_sbindir}/dtrace
%{_sbindir}/dtprobed
-%{_mandir}/man1/orcl-dtrace.1.gz
+%{_mandir}/man8/dtrace.8.gz
%{_includedir}/sys/sdt-dtrace.h
%{_includedir}/sys/sdt_internal.h
%doc %{_docdir}/dtrace-%{version}/*
--
2.37.2
More information about the DTrace-devel
mailing list