diff --git a/docs/source/receptorctl/receptorctl_index.rst b/docs/source/receptorctl/receptorctl_index.rst index 61715334c..47c26cb0f 100644 --- a/docs/source/receptorctl/receptorctl_index.rst +++ b/docs/source/receptorctl/receptorctl_index.rst @@ -11,4 +11,5 @@ The Receptor client, ``receptorctl``, provides a command line interface for inte receptorctl_ping receptorctl_status + receptorctl_traceroute receptorctl_work_list diff --git a/docs/source/receptorctl/receptorctl_ping.rst b/docs/source/receptorctl/receptorctl_ping.rst index 3a1a3c455..76009a486 100644 --- a/docs/source/receptorctl/receptorctl_ping.rst +++ b/docs/source/receptorctl/receptorctl_ping.rst @@ -21,7 +21,7 @@ Command syntax: ``receptorctl --socket= [--count ] [--delay u_str LISTEN 0 4096 /tmp/local.sock 38130170 * 0 users:(("receptor",pid=3226769,fd=7)) ``ps -fp $(pidof receptor)`` -``lsof -p <`` +``lsof -p `` ``count`` specifies the number of pings to send. The value must be a positive integer. The default is ``4``. diff --git a/docs/source/receptorctl/receptorctl_status.rst b/docs/source/receptorctl/receptorctl_status.rst index 78fbc7134..79d7c9b82 100644 --- a/docs/source/receptorctl/receptorctl_status.rst +++ b/docs/source/receptorctl/receptorctl_status.rst @@ -21,7 +21,7 @@ Command syntax: ``receptorctl --socket= status [--json]`` u_str LISTEN 0 4096 /tmp/local.sock 38130170 * 0 users:(("receptor",pid=3226769,fd=7)) ``ps -fp $(pidof receptor)`` -``lsof -p <`` +``lsof -p `` ``--json`` option returns the output in JSON format. The default output format is human-readable. diff --git a/docs/source/receptorctl/receptorctl_traceroute.rst b/docs/source/receptorctl/receptorctl_traceroute.rst new file mode 100644 index 000000000..de1b5564e --- /dev/null +++ b/docs/source/receptorctl/receptorctl_traceroute.rst @@ -0,0 +1,24 @@ +---------- +traceroute +---------- + +.. contents:: + :local: + +``receptorctl traceroute`` Displays the network route that packets follow to Receptor nodes. + +Command syntax: ``receptorctl --socket= traceroute `` + +``socket_path`` is the control socket address for the Receptor connection. + The default is ``unix:`` for a Unix socket. + Use ``tcp://`` for a TCP socket. + The corresponding environment variable is ``RECEPTORCTL_SOCKET``. + +.. code-block:: text + + ss --listening --processes --unix 'src = unix:' + Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process + u_str LISTEN 0 4096 /tmp/local.sock 38130170 * 0 users:(("receptor",pid=3226769,fd=7)) + +``ps -fp $(pidof receptor)`` +``lsof -p `` diff --git a/docs/source/receptorctl/receptorctl_work_list.rst b/docs/source/receptorctl/receptorctl_work_list.rst index 5763f1b75..a85872fcf 100644 --- a/docs/source/receptorctl/receptorctl_work_list.rst +++ b/docs/source/receptorctl/receptorctl_work_list.rst @@ -21,7 +21,7 @@ Command syntax: ``receptorctl --socket= work list`` u_str LISTEN 0 4096 /tmp/local.sock 38130170 * 0 users:(("receptor",pid=3226769,fd=7)) ``ps -fp $(pidof receptor)`` -``lsof -p <`` +``lsof -p `` The output is divided into work unit sections listed below. Field values might be listed separately.