summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbwarsaw2002-10-04 15:12:10 +0000
committerbwarsaw2002-10-04 15:12:10 +0000
commiteb692bfd4882686c69d255249a409d5b3341645a (patch)
tree6556fe8f8ed02cd074f638d2e0ca85e95fcd081d
parent341386bbfb78fb23d09cfbc280b32d14a80e32e3 (diff)
downloadmailman-eb692bfd4882686c69d255249a409d5b3341645a.tar.gz
mailman-eb692bfd4882686c69d255249a409d5b3341645a.tar.zst
mailman-eb692bfd4882686c69d255249a409d5b3341645a.zip
Updated docstring
-rw-r--r--bin/mailmanctl63
1 files changed, 31 insertions, 32 deletions
diff --git a/bin/mailmanctl b/bin/mailmanctl
index 38960b895..aee8b54b3 100644
--- a/bin/mailmanctl
+++ b/bin/mailmanctl
@@ -19,31 +19,30 @@
"""Primary start-up and shutdown script for Mailman's qrunner daemon.
This script starts, stops, and restarts the main Mailman queue runners, making
-sure that the various long-running sub-qrunners are still alive and kicking.
-It does this by forking and exec'ing the sub-qrunners and waiting on their
-pids. When it detects a subprocess has exited, it may restart it.
+sure that the various long-running qrunners are still alive and kicking. It
+does this by forking and exec'ing the qrunners and waiting on their pids.
+When it detects a subprocess has exited, it may restart it.
-The sub-qrunners respond to SIGINT, SIGTERM, and SIGHUP. SIGINT and SIGTERM
-both cause the sub-qrunners to exit cleanly, but the master will only restart
-sub-qrunners that have exited due to a SIGINT. SIGHUP causes the master
-qrunner and sub-qrunners to close their log files, and reopen then upon the
-next printed message.
+The qrunners respond to SIGINT, SIGTERM, and SIGHUP. SIGINT and SIGTERM both
+cause the qrunners to exit cleanly, but the master will only restart qrunners
+that have exited due to a SIGINT. SIGHUP causes the master and the qrunners
+to close their log files, and reopen then upon the next printed message.
-The master qrunner also responds to SIGINT, SIGTERM, and SIGHUP, which it
-simply passes on to the sub-qrunners (note that the master will close and
-reopen its own log files on receipt of a SIGHUP). The master qrunner also
-leaves its own process id in the file data/master-qrunner.pid but you normally
-don't need to use this pid directly. The `start', `stop', `restart', and
-`open' commands handle everything for you.
+The master also responds to SIGINT, SIGTERM, and SIGHUP, which it simply
+passes on to the qrunners (note that the master will close and reopen its own
+log files on receipt of a SIGHUP). The master also leaves its own process id
+in the file data/master-qrunner.pid but you normally don't need to use this
+pid directly. The `start', `stop', `restart', and `reopen' commands handle
+everything for you.
Usage: %(PROGRAM)s [options] [ start | stop | restart | reopen ]
Options:
-n/--no-restart
- Don't restart the sub-qrunners when they exit because of an error or a
- SIGINT (they are never restarted if they exit in response to a
- SIGTERM). Use this only for debugging. Only useful if the `start'
+ Don't restart the qrunners when they exit because of an error or a
+ SIGINT. They are never restarted if they exit in response to a
+ SIGTERM. Use this only for debugging. Only useful if the `start'
command is given.
-u/--run-as-user
@@ -58,12 +57,12 @@ Options:
not recommended for normal production environments.
-s/--stale-lock-cleanup
- If mailmanctl finds an existing master qrunner lock, it will normally
- exit with an error message. With this option, mailmanctl will perform
- an extra level of checking. If a process matching the host/pid
- described in the lock file is running, mailmanctl will still exit, but
- if no matching process is found, mailmanctl will remove the apparently
- stale lock and make another attempt to claim the master lock.
+ If mailmanctl finds an existing master lock, it will normally exit
+ with an error message. With this option, mailmanctl will perform an
+ extra level of checking. If a process matching the host/pid described
+ in the lock file is running, mailmanctl will still exit, but if no
+ matching process is found, mailmanctl will remove the apparently stale
+ lock and make another attempt to claim the master lock.
-q/--quiet
Don't print status messages. Error messages are still printed to
@@ -74,18 +73,18 @@ Options:
Commands:
- start - Start the master qrunner daemon and all sub-qrunners. Prints a
- message and exits if the master qrunner daemon is already
- running.
+ start - Start the master daemon and all qrunners. Prints a message and
+ exits if the master daemon is already running.
- stop - Stops the master qrunner daemon and all sub-qrunners. After
- stopping, no more messages will be processed.
+ stop - Stops the master daemon and all qrunners. After stopping, no
+ more messages will be processed.
- restart - Restarts the sub-qrunners, but not the master qrunner. This is
- really handy for development because without restarting, the
- sub-qrunners won't reload any changed modules.
+ restart - Restarts the qrunners, but not the master process. Use this
+ whenever you upgrade or update Mailman so that the qrunners will
+ use the newly installed code.
- reopen - This will simply cause all log files to be re-opened.
+ reopen - This will close all log files, causing them to be re-opened the
+ next time a message is written to them
"""
import sys