Skip to content

Commit fd9ad64

Browse files
Added receptorctl work release documentation (#1061)
1 parent afb23cd commit fd9ad64

File tree

3 files changed

+31
-1
lines changed

3 files changed

+31
-1
lines changed

docs/source/receptorctl/receptorctl_index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ The Receptor client, ``receptorctl``, provides a command line interface for inte
1717
receptorctl_version
1818
receptorctl_work_cancel
1919
receptorctl_work_list
20+
receptorctl_work_release

docs/source/receptorctl/receptorctl_work_cancel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ Command syntax: ``receptorctl --socket=<socket_path> work cancel <<Unit ID>> [..
2323
``ps -fp $(pidof receptor)``
2424
``lsof -p <pid>``
2525

26-
``Unit ID`` is a unique identifier for a work unit (job). When running the ``work cancel`` command, you should specify the ``Unit ID`` for the Receptor instance to which you are connected.
26+
``Unit ID`` is a unique identifier for a work unit (job). When running the ``work cancel`` command, you should specify the ``Unit ID`` for the Receptor node to which you are connected.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
------------
2+
work release
3+
------------
4+
5+
.. contents::
6+
:local:
7+
8+
``receptorctl work release`` deletes one or more units of work.
9+
10+
Command syntax: ``receptorctl --socket=<socket_path> work release [<<Options>>] <<Unit ID>> [...]``
11+
12+
``socket_path`` is the control socket address for the Receptor connection.
13+
The default is ``unix:`` for a Unix socket.
14+
Use ``tcp://`` for a TCP socket.
15+
The corresponding environment variable is ``RECEPTORCTL_SOCKET``.
16+
17+
.. code-block:: text
18+
19+
ss --listening --processes --unix 'src = unix:<socket_path>'
20+
Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process
21+
u_str LISTEN 0 4096 /tmp/local.sock 38130170 * 0 users:(("receptor",pid=3226769,fd=7))
22+
23+
``ps -fp $(pidof receptor)``
24+
``lsof -p <pid>``
25+
26+
``Unit ID`` is a unique identifier for a work unit (job). When running the ``work release`` command, you should specify the ``Unit ID`` for the Receptor node to which you are connected.
27+
28+
``--all`` deletes all work units known by the Receptor node to which you are connected.
29+
``--force`` deletes work units locally on the Receptor node to which you are connected and takes effect even if the remote Receptor node is unreachable.

0 commit comments

Comments
 (0)