Skip to content

Commit 8e79bd4

Browse files
committed
doc: update documentation of flux resource eventlog options
Problem: New options to `flux resource eventlog` are not documented in flux-resource(1). Update the docs.
1 parent 852ac6d commit 8e79bd4

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

doc/man1/flux-resource.rst

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ SYNOPSIS
2222
| **flux** **resource** **reload** [-f] [--xml] *path*
2323
2424
| **flux** **resource** **acquire-mute**
25-
| **flux** **resource** **eventlog** [*-w* *EVENT*] [*-F*]
25+
| **flux** **resource** **eventlog** [*-w* *EVENT*] [*-f* *FORMAT*] [*-T* *FORMAT*] [*-L* [*WHEN*]] [*-H*] [*-F*]
2626
2727
DESCRIPTION
2828
===========
@@ -364,6 +364,26 @@ eventlog
364364

365365
Watch the resource journal, which is described in RFC 44.
366366

367+
.. option:: -f, --format=FORMAT
368+
369+
Specify the eventlog output format. Valid choices are *text* (the default)
370+
or *json*.
371+
372+
.. option:: -T, --time-format=FORMAT
373+
374+
Specify the timestamp format. Valid choices are *raw* (the default), *iso*,
375+
*offset*, and *human*.
376+
377+
.. option:: -H, --human
378+
379+
Display human-readable output. Equivalent to :option:`-T human -f text`.
380+
381+
.. option:: -L, --color[=WHEN]
382+
383+
Control color output. The optional argument *WHEN* can be one of *auto*,
384+
*never*, or *always*. If *WHEN* is omitted, it defaults to *always*.
385+
Otherwise the default is *auto*.
386+
367387
.. option:: -F, --follow
368388

369389
After printing the current eventlog, wait for new events and print

doc/test/spell.en.pws

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -942,3 +942,4 @@ SATTR
942942
myprogram
943943
unref
944944
sigprocmask
945+
iso

0 commit comments

Comments
 (0)