.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "GP-DISPLAY-HTML.1 1"
.TH GP-DISPLAY-HTML.1 1 "2023-11-25" "binutils-2.41.50" "User Commands"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
gprofng display html \- Generate an HTML based directory structure to browse the profiles
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBgprofng display html\fR [\fIoption(s)\fR] \fIexperiment(s)\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Process one or more experiments to generate a directory containing the
\&\fIindex.html\fR file that may be used to browse the experiment data.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
Print the version number and exit.
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
Print usage information and exit.
.IP "\fB\-\-verbose {on|off}\fR" 4
.IX Item "--verbose {on|off}"
Enable (\fBon\fR) or disable (\fBoff)\fR verbose mode.
The default is \fBoff\fR.
.IP "\fB\-\-debug {on|s|m|l|xl|off}\fR" 4
.IX Item "--debug {on|s|m|l|xl|off}"
.PD 0
.IP "\fB\-d      {on|s|m|l|xl|off}\fR" 4
.IX Item "-d {on|s|m|l|xl|off}"
.PD
Control the printing of run time information to assist with troubleshooting,
or further development of this tool.  The keyword is case insensitive.
A setting of \fBon\fR gives a modest amount of information. The keywords
\&\fBs\fR, \fBm\fR, \fBl\fR, and \fBxl\fR give an increasing amount of
information, while \fBoff\fR disables the printing of debug information.
This is also the default.
.Sp
Note that currently \fBon\fR, \fBs\fR, \fBm\fR, and \fBl\fR are
equivalent.  This is expected to change in future updates.
.IP "\fB\-\-\-highlight\-percentage\fR \fIvalue\fR" 4
.IX Item "---highlight-percentage value"
.PD 0
.IP "\fB\-hp\fR \fIvalue\fR" 4
.IX Item "-hp value"
.PD
Set a percentage value in the interval [0,100] to select and color code source
lines, as well as instructions, that are within this percentage of the maximum
metric value(s).  The default is 90 (%).
.Sp
A value of zero \fB(\-hp 0)\fR disables this feature.
.IP "\fB\-\-output\fR \fIdirname\fR" 4
.IX Item "--output dirname"
.PD 0
.IP "\fB\-o\fR       \fIdirname\fR" 4
.IX Item "-o dirname"
.PD
Use \fIdirname\fR as the directory name to store the \s-1HTML\s0 files in.
The default name is \fBdisplay.<n>.html\fR with \fI<n>\fR the first
positive integer number not in use.  An existing directory with the
same name is not overwritten.
.IP "\fB\-\-overwrite\fR \fIdirname\fR" 4
.IX Item "--overwrite dirname"
.PD 0
.IP "\fB\-O\fR          \fIdirname\fR" 4
.IX Item "-O dirname"
.PD
Use \fIdirname\fR as the directory name to store the \s-1HTML\s0 files in.
.IP "\fB\-\-quiet {on|off}\fR" 4
.IX Item "--quiet {on|off}"
.PD 0
.IP "\fB\-q      {on|off}\fR" 4
.IX Item "-q {on|off}"
.PD
Control the display of all warning, debug and verbose messages.
If set to \fBon\fR, the settings for verbose, warnings and debug are ignored.
By default the quiet mode is disabled (\fB\-q off\fR).
.IP "\fB\-\-warnings {on|off}\fR" 4
.IX Item "--warnings {on|off}"
.PD 0
.IP "\fB\-w         {on|off}\fR" 4
.IX Item "-w {on|off}"
.PD
Enable (\fBon\fR), or disable (\fBoff\fR) run time warning messages from
the tool. By default these are enabled.
.SH "NOTES"
.IX Header "NOTES"
When setting a directory name for the \s-1HTML\s0 files to be stored in, make sure that
umask is set to the correct access permissions.
.PP
Regardless of the setting for the warning messages, any warnings are accessible
through the main \fIindex.html\fR page.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBgprofng\fR\|(1), \fBgp\-archive\fR\|(1), \fBgp\-collect\-app\fR\|(1), \fBgp\-display\-src\fR\|(1), \fBgp\-display\-text\fR\|(1)
.PP
The user guide for gprofng is maintained as a Texinfo manual.  If the
\&\fBinfo\fR and \fBgprofng\fR programs are correctly installed, the
command \fBinfo gprofng\fR should give access to this document.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2022\-2023 Free Software Foundation, Inc.
.PP
Permission is granted to copy, distribute and/or modify this document
under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, with no Front-Cover Texts, and with no
Back-Cover Texts.  A copy of the license is included in the
section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".