Skip to content

Commit 368c49d

Browse files
committed
doc: document the signal job shell option in flux-shell(1)
Problem: The `signal` job shell option is undocumented. Add a few stanzas describing the `signal` job shell option.
1 parent 323bdec commit 368c49d

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

doc/man1/flux-shell.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,19 @@ options are supported by the builtin plugins of ``flux-shell``:
363363
job's nodes if the scope is local, versus only the first node of the
364364
job if the scope is global.
365365

366+
**signal=OPTION**
367+
Deliver signal ``SIGUSR1`` to the job 60s before job expiration.
368+
To customize the signal number or amount of time before expiration to
369+
deliver the signal, the ``signal`` option may be an object with one
370+
or both of the keys ``signum`` or ``timeleft``. (See below)
371+
372+
**signal.signum**\ =\ *NUMBER*
373+
Send signal *NUMBER* to the job ``signal.timeleft`` seconds before
374+
the time limit.
375+
376+
**signal.timeleft**\ =\ *TIME*
377+
Send signal ``signal.signum`` *TIME* seconds before job expiration.
378+
366379
.. warning::
367380
The $FLUX_JOB_TMPDIR is cleaned up when the job ends, is guaranteed to
368381
be unique, and is generally on fast local storage such as a *tmpfs*.

doc/test/spell.en.pws

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -705,3 +705,4 @@ libc
705705
unbuffered
706706
statex
707707
pmix
708+
SIGUSR

0 commit comments

Comments
 (0)