@@ -39,7 +39,8 @@ OPTIONS
3939
4040.. option :: -l , --label-io
4141
42- Label lines of output with the source RANK.
42+ Label lines of output with the source broker RANK. This option is not
43+ affected by :option: `--jobid `.
4344
4445.. option :: -n , --noinput
4546
@@ -52,21 +53,34 @@ OPTIONS
5253
5354.. option :: -r , --rank=IDSET
5455
55- Target specific ranks in *IDSET *. Default is to target "all" ranks.
56+ Target specific ranks, where *IDSET * is a set of zero-origin node ranks in
57+ RFC 22 format. If :option: `--jobid ` is specified, the ranks are interpreted
58+ as an index into the list of nodes assigned to the job. Otherwise, they
59+ refer to the nodes assigned to the Flux instance.
60+
61+ The default is to target all ranks. As a special case, :option: `--rank=all `
62+ is accepted and behaves the same as the default.
5663
5764.. option :: -x , --exclude=IDSET
5865
59- Exclude ranks in *IDSET *.
66+ Exclude specific ranks. *IDSET * is as described in :option: ` --rank ` .
6067
6168.. option :: -j , --jobid=JOBID
6269
63- Use the job shell exec service for job *JOBID * instead of the broker's
64- exec service. The default *IDSET * will be set to the nodes assigned
65- to the job, and the :option: `--rank ` and :option: `--exclude ` options are
66- applied relative to this set. For example, :option: `flux exec -j ID -r 0 `
67- will run only on the first node assigned to *JOBID *, and :option: `flux
68- exec -j ID -x 0 ` will run on all nodes assigned to *JOBID * except the
69- first node.
70+ Run *COMMAND * on the nodes allocated to *JOBID * instead of the nodes
71+ assigned to the Flux instance.
72+
73+ This uses the exec service embedded in :man1: `flux-shell ` rather than
74+ :man1: `flux-broker `.
75+
76+ The interpretation of :option: `--rank ` and :option: `--exclude ` is adjusted
77+ as noted in their descriptions. For example, :option: `flux exec -j ID -r 0 `
78+ will run only on the first node assigned to *JOBID *, and
79+ :option: `flux exec -j ID -x 0 ` will run on all nodes assigned to *JOBID *
80+ except the first node.
81+
82+ This option is only available when the job owner is the same as the Flux
83+ instance owner.
7084
7185.. option :: -v , --verbose
7286
0 commit comments