Skip to content

Commit acd5635

Browse files
committed
doc: document R subcommand in flux-resource(1)
Problem: The `flux resource R` command is undocumented. Document the `R` subcommand in the flux-resource(1) man page.
1 parent 894de4e commit acd5635

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

doc/man1/flux-resource.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,21 @@ COMMANDS
8080
specify ranks or hosts which do not exist, the result will be filtered
8181
to include only those ranks or hosts that are present in *TARGETS*.
8282

83+
**R** [-s STATE,..] [-i TARGETS]
84+
Emit an RFC 20 Resource Set on stdout.
85+
86+
With *-s,--states=STATE,...*, the set of resource states is restricted
87+
to a list of provided states. Valid states include "up", "down",
88+
"allocated", "free", and "all". Note that the scheduler represents
89+
offline, excluded, and drained resources as "down" due to the simplified
90+
interface with the resource service defined by RFC 27.
91+
92+
With *-i, --include=TARGETS*, the results are filtered to only include
93+
resources matching **TARGETS**, which may be specified either as an idset
94+
of broker ranks or list of hosts in hostlist form. It is not an error to
95+
specify ranks or hosts which do not exist, the result will be filtered
96+
to include only those ranks or hosts that are present in *TARGETS*.
97+
8398
**status** [-n] [-o FORMAT] [-s STATE,...] [-i TARGETS] [--skip-empty]
8499
Show system view of resources. This command queries both the resource
85100
service and scheduler to identify resources that are available,

0 commit comments

Comments
 (0)