Skip to content

Commit cbcb7cc

Browse files
committed
flux-module(1): document trace subcommand
Problem: 'flux module trace' has no documentation. Add the trace subcommand to flux-module(1).
1 parent 654621e commit cbcb7cc

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

doc/man1/flux-module.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ SYNOPSIS
1212
| **flux** **module** **list** [*-l*]
1313
| **flux** **module** **stats** [*-R*] [*--clear*] *name*
1414
| **flux** **module** **debug** [*--setbit=VAL*] [*--clearbit=VAL*] [*--set=MASK*] [*--clear=MASK*] *name*
15+
| **flux** **module** **trace** [*-t TYPE,...*] [-T *topic-glob*] *name...*
1516
1617

1718

@@ -142,6 +143,39 @@ flag bits is private to the module and its test drivers.
142143

143144
Set one debug flag *VAL* to 0.
144145

146+
trace
147+
-----
148+
149+
.. program:: flux module trace
150+
151+
Display message summaries for messages transmitted and received by the
152+
named modules.
153+
154+
.. option:: -T, --topic=GLOB
155+
156+
Filter output by topic string.
157+
158+
.. option:: -t, --type=TYPE,...
159+
160+
Filter output by message type, a comma-separated list. Valid types are
161+
``request``, ``response``, ``event``, or ``control``.
162+
163+
.. option:: -L, --color=WHEN
164+
165+
Colorize output when supported; WHEN can be ``always`` (default if omitted),
166+
``never``, or ``auto`` (default).
167+
168+
.. option:: -H, --human
169+
170+
Display human-readable output. See also :option:`--color` and
171+
:option:`--delta`.
172+
173+
.. option:: -d, --delta
174+
175+
With :option:`--human`, display the time delta between messages instead
176+
of a relative offset since the last absolute timestamp.
177+
178+
145179
DEBUG OPTIONS
146180
=============
147181

0 commit comments

Comments
 (0)