Skip to content

Commit

Permalink
doc: document flux resource watch
Browse files Browse the repository at this point in the history
Problem: The new flux resource watch subcommand is not documented.

Add documentation in flux-resource.rst.
  • Loading branch information
chu11 committed Aug 16, 2023
1 parent cc83d23 commit 0813d4b
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/man1/flux-resource.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,13 @@ COMMANDS
*-f,--force*, resources may contain invalid ranks. This command is
primarily used in test.

**watch** [-a] [-r]
Output changes in resources from *resource.eventlog* to standard out as they
occur. May be useful when needing to see resource changes in real time. If
*-a,--all* is specified, all output all resource changes since the beginning of
the instance. If *-r,--ranks* is specified, ranks of resources will be output
instead of hosts.


OUTPUT FORMAT
=============
Expand Down

0 comments on commit 0813d4b

Please sign in to comment.