Skip to content

Commit 10b28ba

Browse files
committed
8322812: Manpage for jcmd is missing JFR.view command
Reviewed-by: mgronlun Backport-of: 350f9c1
1 parent d383365 commit 10b28ba

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

src/jdk.jcmd/share/man/jcmd.1

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -681,6 +681,55 @@ If no path is provided, the data from the recording is discarded.
681681
value)
682682
.RE
683683
.TP
684+
\f[V]JFR.view\f[R] [\f[I]options\f[R]]
685+
Display event data in predefined views.
686+
.RS
687+
.PP
688+
Impact: Medium
689+
.PP
690+
\f[B]Note:\f[R]
691+
.PP
692+
The \f[I]options\f[R] must be specified using either \f[I]key\f[R] or
693+
\f[I]key\f[R]\f[V]=\f[R]\f[I]value\f[R] syntax.
694+
If no parameters are entered, then a list of available views are
695+
displayed.
696+
.PP
697+
\f[I]options\f[R]:
698+
.IP \[bu] 2
699+
\f[V]cell-height\f[R]: (Optional) Maximum number of rows in a table
700+
cell.
701+
(INT, default value depends on the view)
702+
.IP \[bu] 2
703+
\f[V]maxage\f[R]: (Optional) Length of time for the view to span.
704+
(INT followed by \[aq]s\[aq] for seconds \[aq]m\[aq] for minutes or
705+
\[aq]h\[aq] for hours, default value is 10m)
706+
.IP \[bu] 2
707+
\f[V]maxsize\f[R]: (Optional) Maximum size for the view to span in bytes
708+
if one of the following suffixes is not used: \[aq]m\[aq] or \[aq]M\[aq]
709+
for megabytes OR \[aq]g\[aq] or \[aq]G\[aq] for gigabytes.
710+
(STRING, default value is 32MB)
711+
.IP \[bu] 2
712+
\f[V]truncate\f[R]: (Optional) Maximum number of rows in a table cell.
713+
(INT, default value depends on the view)
714+
.IP \[bu] 2
715+
\f[V]verbose\f[R]: (Optional) Displays the query that makes up the view.
716+
(BOOLEAN, default value is false)
717+
.IP \[bu] 2
718+
\f[V]width\f[R]: (Optional) The width of the view in characters.
719+
(INT, default value depends on the view)
720+
.PP
721+
\f[I]arguments\f[R]:
722+
.IP \[bu] 2
723+
\f[V]view\f[R]: Name of the view or event type to display.
724+
Use \f[V]help JFR.view\f[R] to see a list of available views.
725+
(STRING, no default value)
726+
.PP
727+
The view parameter can be an event type name.
728+
Use \f[V]JFR.view types\f[R] to see a list.
729+
To display all views, use \f[V]JFR.view all-views\f[R].
730+
To display all events, use \f[V]JFR.view all-events\f[R].
731+
.RE
732+
.TP
684733
\f[V]JVMTI.agent_load\f[R] [\f[I]arguments\f[R]]
685734
Loads JVMTI native agent.
686735
.RS

0 commit comments

Comments
 (0)