[tor-commits] [tor/master] Document __OwningControllerProcess torrc option and mention polling interval

[dgoulet at torproject.org]

commit 94a2376e01a5a35b3ce030874a15faba56ea6322
Author: rl1987 <rl1987 at sdf.lonestar.org>
Date:   Mon Mar 9 16:00:50 2020 +0200

    Document __OwningControllerProcess torrc option and mention polling interval
---
 changes/doc32971 | 3 +++
 doc/tor.1.txt    | 5 +++++
 2 files changed, 8 insertions(+)

diff --git a/changes/doc32971 b/changes/doc32971
new file mode 100644
index 000000000..014d2a7ce
--- /dev/null
+++ b/changes/doc32971
@@ -0,0 +1,3 @@
+  o Documentation (manpage):
+    - Document __OwningControllerProcess torrc option and specify polling
+      interval. Resolves issue 32971.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index f517a78f6..91c558e88 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -760,6 +760,11 @@ forward slash (/) in the configuration file and on the command line.
     This setting will be ignored for connections to the loopback
     addresses (127.0.0.0/8 and ::1).
 
+[[OwningControllerProcess]] **$$__$$OwningControllerProcess** __PID__::
+    Make Tor instance periodically check for presence of a controller process
+    with given PID and terminate itself if this process is no longer alive.
+    Polling interval is 15 seconds.
+
 [[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
     If this option is set manually, or via the "perconnbwburst" consensus
     field, Tor will use it for separate rate limiting for each connection