129 lines
3.5 KiB
Groff
129 lines
3.5 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
|
|
.TH GPROFNG "1" "October 2022" "GNU gprofng binutils version 2.39.50" "User Commands"
|
|
.SH NAME
|
|
gprofng \- the driver for the gprofng tool suite
|
|
.SH SYNOPSIS
|
|
.B gprofng
|
|
[\fI\,OPTION(S)\/\fR] \fI\,COMMAND \/\fR[\fI\,KEYWORD\/\fR] [\fI\,ARGUMENTS\/\fR]
|
|
.SH DESCRIPTION
|
|
This is the driver for the GPROFNG tools suite to gather and analyze performance data.
|
|
.SH OPTIONS
|
|
.TP
|
|
.B
|
|
\fB\-\-version\fR
|
|
print the version number and exit.
|
|
.TP
|
|
.B
|
|
\fB\-\-help\fR
|
|
print usage information and exit.
|
|
.TP
|
|
.B
|
|
\fB\-\-check\fR
|
|
verify if the hardware and software environment is supported.
|
|
.TP
|
|
.B
|
|
\fB\-\-verbose\fR {on|off}
|
|
enable (on) or disable (off) verbose mode; the default is "off".
|
|
.PP
|
|
.SH COMMANDS
|
|
.PP
|
|
The driver supports various commands. These are listed below.
|
|
.PP
|
|
It is also possible to invoke the lower level commands directly, but since these
|
|
are subject to change, in particular the options, we recommend to use the driver.
|
|
.PP
|
|
The man pages for the commands below can be viewed using the command name with
|
|
"gprofng" replaced by "gp" and the spaces replaced by a dash ("\-"). For
|
|
example the man page name for "gprofng collect app" is "gp\-collect\-app".
|
|
.PP
|
|
The following combination of commands and keywords are supported:
|
|
.PP
|
|
Collect performance data
|
|
.TP
|
|
.B
|
|
gprofng collect app
|
|
collect application performance data.
|
|
.PP
|
|
Display the performance results
|
|
.TP
|
|
.B
|
|
gprofng display text
|
|
display the performance data in ASCII format.
|
|
.TP
|
|
.B
|
|
gprofng display html
|
|
generate an HTML file from one or more experiments.
|
|
.TP
|
|
.B
|
|
gprofng display src
|
|
display source or disassembly with compiler annotations.
|
|
.PP
|
|
Miscellaneous commands
|
|
.TP
|
|
.B
|
|
gprofng archive
|
|
include binaries and source code in an experiment directory.
|
|
.SH ENVIRONMENT
|
|
The following environment variables are supported:
|
|
.TP
|
|
.B
|
|
GPROFNG_MAX_CALL_STACK_DEPTH
|
|
set the depth of the call stack (default is 256).
|
|
.TP
|
|
.B
|
|
GPROFNG_USE_JAVA_OPTIONS
|
|
may be set when profiling a C/C++ application
|
|
that uses dlopen() to execute Java code.
|
|
.TP
|
|
.B
|
|
GPROFNG_SSH_REMOTE_DISPLAY
|
|
use this variable to define the ssh command
|
|
executed by the remote display tool.
|
|
.TP
|
|
.B
|
|
GPROFNG_SKIP_VALIDATION
|
|
set this variable to disable checking hardware,
|
|
system, and Java versions.
|
|
.TP
|
|
.B
|
|
GPROFNG_ALLOW_CORE_DUMP
|
|
set this variable to allow a core file to be
|
|
generated; otherwise an error report is created on \fI\,/tmp\/\fP.
|
|
.TP
|
|
.B
|
|
GPROFNG_ARCHIVE
|
|
use this variable to define the settings for automatic
|
|
archiving upon experiment recording completion.
|
|
.TP
|
|
.B
|
|
GPROFNG_ARCHIVE_COMMON_DIR
|
|
set this variable to the location of the common archive.
|
|
.TP
|
|
.B
|
|
GPROFNG_JAVA_MAX_CALL_STACK_DEPTH
|
|
set the depth of the Java call stack; the default
|
|
is 256; set to 0 to disable capturing of call stacks.
|
|
.TP
|
|
.B
|
|
GPROFNG_JAVA_NATIVE_MAX_CALL_STACK_DEPTH
|
|
set the depth of the Java native call stack;
|
|
the default is 256; set to 0 to disable capturing
|
|
of call stacks (JNI and assembly call stacks
|
|
are not captured).
|
|
.PP
|
|
.SH DOCUMENTATION
|
|
.PP
|
|
A getting started guide for gprofng is maintained as a Texinfo manual. If the info and
|
|
gprofng programs are properly installed at your site, the command "info gprofng"
|
|
should give you access to this document.
|
|
.PP
|
|
.SH SEE ALSO
|
|
.PP
|
|
gp\-archive(1), gp\-collect\-app(1), gp\-display\-html(1), gp\-display\-src(1), gp\-display\-text(1)
|
|
.SH COPYRIGHT
|
|
Copyright \(co 2021 Free Software Foundation, Inc.
|
|
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
|
|
.br
|
|
This is free software: you are free to change and redistribute it.
|
|
There is NO WARRANTY, to the extent permitted by law.
|