Skip to content

Commit 3f0b43a

Browse files
committed
doc: document --signal option for submission commands
Problem: The submission cli --signal option is not documented. Add a description of this option to the submit-other-options.rst source file so it will be present in all submission command man pages.
1 parent 368c49d commit 3f0b43a

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/man1/common/submit-other-options.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,20 @@ OTHER OPTIONS
4444
is accepted, e.g. ``2021-06-21 8am``, ``in an hour``,
4545
``tomorrow morning``, etc.
4646

47+
**--signal=SIG@TIME**
48+
Send signal ``SIG`` to job ``TIME`` before the job time limit. ``SIG``
49+
can specify either an integer signal number or a full or abbreviated
50+
signal name, e.g. ``SIGUSR1`` or ``USR1`` or ``10``. ``TIME`` is
51+
specified in Flux Standard Duration, e.g. ``30`` for 30s or ``1h`` for
52+
1 hour. Either parameter may be omitted, with defaults of ``SIGUSR1``
53+
and 60s. For example, ``--signal=USR2`` will send ``SIGUSR2`` to
54+
the job 60 seconds before expiration, and ``--signal=@3m`` will send
55+
``SIGUSR1`` 3 minutes before expiration. Note that if ``TIME`` is
56+
greater than the remaining time of a job as it starts, the job will
57+
be signaled immediately.
58+
59+
The default behavior is to not send any warning signal to jobs.
60+
4761
**--taskmap=SCHEME[:VALUE]**
4862
Choose an alternate method for mapping job task IDs to nodes of the
4963
job. The job shell maps tasks using a "block" distribution scheme by

0 commit comments

Comments
 (0)