| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" |
| 56 |
.\" Required to disable full justification in groff 1.23.0. |
| 57 |
.if n .ds AD l |
| 58 |
.\" ======================================================================== |
| 59 |
.\" |
| 60 |
.IX Title "GPROFNG-DISPLAY-HTML 1" |
| 61 |
.TH GPROFNG-DISPLAY-HTML 1 2025-07-27 binutils-2.45 "User Commands" |
| 62 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 63 |
.\" way too many mistakes in technical documents. |
| 64 |
.if n .ad l |
| 65 |
.nh |
| 66 |
.SH NAME |
| 67 |
gprofng\-display\-html \- Generate an HTML based directory structure to browse the profiles |
| 68 |
.SH SYNOPSIS |
| 69 |
.IX Header "SYNOPSIS" |
| 70 |
\&\fBgprofng display html\fR [\fIoption(s)\fR] \fIexperiment(s)\fR |
| 71 |
.SH DESCRIPTION |
| 72 |
.IX Header "DESCRIPTION" |
| 73 |
Process one or more experiments to generate a directory containing the |
| 74 |
\&\fIindex.html\fR file that may be used to browse the experiment data. |
| 75 |
.SH OPTIONS |
| 76 |
.IX Header "OPTIONS" |
| 77 |
.IP \fB\-\-version\fR 4 |
| 78 |
.IX Item "--version" |
| 79 |
Print the version number and exit. |
| 80 |
.IP \fB\-\-help\fR 4 |
| 81 |
.IX Item "--help" |
| 82 |
Print usage information and exit. |
| 83 |
.IP \fB\-\-verbose\fR 4 |
| 84 |
.IX Item "--verbose" |
| 85 |
Enable verbose mode to show diagnostic messages about the processing of the |
| 86 |
data. By default verbose mode is disabled. |
| 87 |
.IP "\fB\-d [\fR\fIdb\-vol\-size\fR\fB], \-\-debug[=\fR\fIdb\-vol\-size\fR\fB]\fR" 4 |
| 88 |
.IX Item "-d [db-vol-size], --debug[=db-vol-size]" |
| 89 |
Control the printing of run time debug information to assist with the |
| 90 |
troubleshooting, or further development of this tool. |
| 91 |
.Sp |
| 92 |
The \fIdb\-vol\-size\fR parameter controls the output volume and is one from |
| 93 |
the list \fBs\fR, \fBS\fR, \fBm\fR, \fBM\fR, \fBl\fR, \fBL\fR, \fBxl\fR, |
| 94 |
or \fBXL\fR. If \fIdb\-vol\-size\fR is not set, a modest amount of information |
| 95 |
is printed. This is equivalent to select \fBs\fR, or \fBS\fR. The volume |
| 96 |
of data goes up as the size increases. Note that currently \fBl/L\fR is |
| 97 |
equivalent to \fBxl/XL\fR, but this is expected to change in future updates. |
| 98 |
By default debug mode is disabled. |
| 99 |
.IP \fB\-\-highlight\-percentage=\fR\fIvalue\fR 4 |
| 100 |
.IX Item "--highlight-percentage=value" |
| 101 |
Set a percentage value in the interval [0,100] to select and color code source |
| 102 |
lines, as well as instructions, that are within this percentage of the maximum |
| 103 |
metric value(s). The default is 90 (%). A value of zero disables this |
| 104 |
feature. |
| 105 |
.IP "\fB\-o\fR \fIdirname\fR\fB, \-\-output=\fR\fIdirname\fR" 4 |
| 106 |
.IX Item "-o dirname, --output=dirname" |
| 107 |
Use \fIdirname\fR as the directory name to store the results in. In |
| 108 |
absence of this option, the default name is \fBdisplay.<n>.html\fR. |
| 109 |
This directory is created in the current directory. |
| 110 |
The number \fI<n>\fR is the first positive integer number not in use in |
| 111 |
this naming scheme. An existing directory with the same name is not |
| 112 |
overwritten. |
| 113 |
In case the directory exists already, an error message is printed and |
| 114 |
the tool terminates. |
| 115 |
.IP "\fB\-O\fR \fIdirname\fR\fB, \-\-overwrite=\fR\fIdirname\fR" 4 |
| 116 |
.IX Item "-O dirname, --overwrite=dirname" |
| 117 |
Use \fIdirname\fR as the directory name to store the results in. In |
| 118 |
absence of this option, the default name is \fBdisplay.<n>.html\fR. |
| 119 |
This directory is created in the current directory. |
| 120 |
The number \fI<n>\fR is the first positive integer number not in use in |
| 121 |
this naming scheme. An existing directory with the same name is silently |
| 122 |
overwritten. |
| 123 |
.IP "\fB\-q, \-\-quiet\fR" 4 |
| 124 |
.IX Item "-q, --quiet" |
| 125 |
Disable the display of all warning, debug, verbose and any other messages. |
| 126 |
If enabled, the settings for verbose and debug are accepted, but ignored. |
| 127 |
With this option, there is no screen output, other than errors. By default |
| 128 |
quiet mode is disabled. |
| 129 |
.IP \fB\-\-nowarnings\fR 4 |
| 130 |
.IX Item "--nowarnings" |
| 131 |
Disable the printing of warning messages on stdout. By default warning |
| 132 |
messages are printed. |
| 133 |
.SH NOTES |
| 134 |
.IX Header "NOTES" |
| 135 |
.IP \- 4 |
| 136 |
The options and values are case sensitive. |
| 137 |
.IP \- 4 |
| 138 |
In this release, the option syntax has changed to be more compliant with other |
| 139 |
tools and commands. |
| 140 |
.Sp |
| 141 |
The options that used to have an \fBon\fR or \fBoff\fR value only, now act |
| 142 |
as a switch. The option negates the default setting. For example, by |
| 143 |
default, verbose mode is disabled. It is enabled by using the |
| 144 |
\&\fB\-\-verbose\fR option. |
| 145 |
.Sp |
| 146 |
The long options, those starting with \f(CW\*(C`\-\-\*(C'\fR, that require a value, expect |
| 147 |
the \f(CW\*(C`=\*(C'\fR sign between the option and the value. |
| 148 |
.Sp |
| 149 |
While the previous syntax and choices are accepted still, we strongly |
| 150 |
recommend to change the usage of the options according to the new syntax |
| 151 |
and values. At some point, these legacy settings may no longer be accepted. |
| 152 |
.Sp |
| 153 |
To assist with the transition, a warning message is shown if the legacy |
| 154 |
syntax, or value, or both, are used. |
| 155 |
.IP \- 4 |
| 156 |
The \fB\-hp\fR option is still accepted, but it will be deprecated in a |
| 157 |
future release. Use the \fB\-\-highlight\-percentage\fR option instead. |
| 158 |
.IP \- 4 |
| 159 |
When setting a directory name for the HTML files to be stored in, make sure |
| 160 |
that umask is set to the correct access permissions. |
| 161 |
.IP \- 4 |
| 162 |
Regardless of the setting for the warning messages, if there are warnings, they |
| 163 |
are accessible through the main \fIindex.html\fR page. |
| 164 |
.IP \- 4 |
| 165 |
The tool tries to accumulate as many warnings and errors as possible, before |
| 166 |
taking action. In this way, it is easier to address multiple issues at |
| 167 |
once. As a result of this approach, it may be that the messages do not show |
| 168 |
immediately. In particular, warnings are shown towards the end of the |
| 169 |
execution, but one or more errors will terminate execution before the |
| 170 |
processing begins. |
| 171 |
.SH "SEE ALSO" |
| 172 |
.IX Header "SEE ALSO" |
| 173 |
\&\fBgprofng\fR\|(1), |
| 174 |
\&\fBgprofng\-archive\fR\|(1), |
| 175 |
\&\fBgprofng\-collect\-app\fR\|(1), |
| 176 |
\&\fBgprofng\-display\-src\fR\|(1), |
| 177 |
\&\fBgprofng\-display\-text\fR\|(1) |
| 178 |
.PP |
| 179 |
The user guide for gprofng is maintained as a Texinfo manual. If the |
| 180 |
\&\fBinfo\fR and \fBgprofng\fR programs are correctly installed, the |
| 181 |
command \fBinfo gprofng\fR should give access to this document. |
| 182 |
.SH COPYRIGHT |
| 183 |
.IX Header "COPYRIGHT" |
| 184 |
Copyright (c) 2022\-2025 Free Software Foundation, Inc. |
| 185 |
.PP |
| 186 |
Permission is granted to copy, distribute and/or modify this document |
| 187 |
under the terms of the GNU Free Documentation License, Version 1.3 |
| 188 |
or any later version published by the Free Software Foundation; |
| 189 |
with no Invariant Sections, with no Front\-Cover Texts, and with no |
| 190 |
Back\-Cover Texts. A copy of the license is included in the |
| 191 |
section entitled "GNU Free Documentation License". |