Add receptorctl connect doc (#1052)

docs/requirements.txt

@@ -1,3 +1,4 @@
 pbr
-sphinx
 six
+sphinx
+sphinx_ansible_theme

docs/source/conf.py

@@ -3,14 +3,18 @@
 # This file only contains a selection of the most common options. For a full
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
+
 # -- Path setup --------------------------------------------------------------
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+
+
 # -- Project information -----------------------------------------------------
 
 project = "receptor"
@@ -70,12 +74,15 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
+
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
+
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
+
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -89,7 +96,10 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "receptor", "receptor Documentation", [author], 1)]
+man_pages = [
+    (master_doc, 'receptor', 'receptor Documentation',
+     [author], 1)
+]
 
 # -- Options for Texinfo output -------------------------------------------
 
@@ -107,3 +117,26 @@
         "Miscellaneous",
     ),
 ]
+
+# -- Options for QtHelp output  -------------------------------------------
+
+
+# -- Options for linkcheck builder  ---------------------------------------
+
+linkcheck_report_timeouts_as_broken = False
+linkcheck_timeout = 30
+
+# -- Options for xml builder  ---------------------------------------------
+
+xml_pretty = True
+
+# -- Options for C domain  ------------------------------------------------
+
+
+# -- Options for C++ domain  ----------------------------------------------
+
+
+# -- Options for Python domain  -------------------------------------------
+
+
+# -- Options for Javascript domain  ---------------------------------------

docs/source/receptorctl/receptorctl_connect.rst

@@ -0,0 +1,33 @@
+-------
+connect
+-------
+
+.. contents::
+   :local:
+
+``receptorctl connect`` establishes a connection between local client and a Receptor node.
+
+Command syntax: ``receptorctl --socket=<socket_path> connect <remote_node> <remote_control_service>``
+
+``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:<socket_path>'
+  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 <pid>``
+
+``remote_node`` is the identifier of a Receptor node.
+
+``remote_control_service`` is the service name of a Receptor node.
+
+.. seealso::
+
+    :ref:`connect_to_csv`
+        Connect to any Receptor control service running on the mesh.

docs/source/receptorctl/receptorctl_index.rst

@@ -9,6 +9,7 @@ The Receptor client, ``receptorctl``, provides a command line interface for inte
    :glob:
    :caption: Receptorctl commands
 
+   receptorctl_connect
    receptorctl_ping
    receptorctl_reload
    receptorctl_status

docs/source/receptorctl/receptorctl_reload.rst

@@ -7,7 +7,7 @@ reload
 
 ``receptorctl reload`` reloads the Receptor configuration for the connected node.
 
-Command syntax: ``receptorctl --socket=<socket_path> version``
+Command syntax: ``receptorctl --socket=<socket_path> reload``
 
 ``socket_path`` is the control socket address for the Receptor connection.
    The default is ``unix:`` for a Unix socket.