docs: document changes to 'cyr_info proc' output

cyrusimap · Jun 26, 2023 · 934a332 · 934a332
1 parent 6ba241f
commit 934a332
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 4 deletions.
diff --git a/changes/next/proc-info-for-daemons b/changes/next/proc-info-for-daemons
@@ -0,0 +1,18 @@
+Description:
+
+Extends `cyr_info proc` to report DAEMON and EVENTS processes.
+
+
+Config changes:
+
+None
+
+
+Upgrade instructions:
+
+None
+
+
+GitHub issue:
+
+None
diff --git a/docsrc/imap/reference/manpages/systemcommands/cyr_info.rst b/docsrc/imap/reference/manpages/systemcommands/cyr_info.rst
@@ -66,7 +66,7 @@ configuring Cyrus easier.
 
 .. option:: proc
 
-    Print all currently connected processes in the proc directory
+    Print active processes that :cyrusman:`master(8)` is managing.
 
 Options
 =======
@@ -103,7 +103,7 @@ Examples
 
 ..
 
-        List all the proc files and who they're logged in as.
+        List the active processes that master is managing
 
 .. only:: html
 
@@ -145,4 +145,4 @@ Files
 
 See Also
 ========
-:cyrusman:`imapd.conf(5)`, :cyrusman:`cyrus.conf(5)`
+:cyrusman:`imapd.conf(5)`, :cyrusman:`cyrus.conf(5)`, :cyrusman:`master(8)`
diff --git a/docsrc/imap/reference/manpages/systemcommands/master.rst b/docsrc/imap/reference/manpages/systemcommands/master.rst
@@ -113,6 +113,9 @@ The environment variable **CYRUS_VERBOSE** can be set to log additional
 debugging information. Setting the value to 1 results in base level logging.
 Setting it higher results in more log messages being generated.
 
+The :cyrusman:`cyr_info(8)` utility's ``proc`` subcommand can be used to
+list the active processes that **master** is managing.
+
 Files
 =====
 
@@ -125,4 +128,4 @@ See Also
 
 :cyrusman:`cyrus.conf(5)`, :cyrusman:`imapd.conf(5)`, :cyrusman:`imapd(8)`,
 :cyrusman:`pop3d(8)`, :cyrusman:`lmtpd(8)`, :cyrusman:`timsieved(8)`,
-:cyrusman:`idled(8)`
+:cyrusman:`idled(8)`, :cyrusman:`cyr_info(8)`