superguard 0.0.3__tar.gz

superguard-0.0.3/CHANGES.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.0.2 (2026-07-15)
+- Add changes from superlance main from commit=ab1b8a5f8d5b0c6eb223f45cc483d582f76c315a to commit=ebde11bd8b571196382ca5bbae10be1ea465d17d
+
+## 0.0.1 (2026-07-15)
+- Initial version
+- Forked from superlance 2.0.0, renamed to superguard
+- Support Python 2.7, 3.4+

superguard-0.0.3/COPYRIGHT.txt

@@ -0,0 +1,19 @@
+Superlance is Copyright (c) 2008-2013 Agendaless Consulting and Contributors.
+(http://www.agendaless.com), All Rights Reserved
+
+  This software is subject to the provisions of the license at
+  http://www.repoze.org/LICENSE.txt . A copy of this license should
+  accompany this distribution.  THIS SOFTWARE IS PROVIDED "AS IS" AND
+  ANY AND ALL EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING,
+  BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF TITLE,
+  MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS FOR A PARTICULAR
+  PURPOSE.
+
+---
+
+Superguard is Copyright (c) 2025-present Superguard Contributors.
+All Rights Reserved.
+
+Superguard is a derivative work of superlance, substantially modified
+and extended. This software is subject to the same license terms as
+superlance (see LICENSE.txt).

superguard-0.0.3/LICENSE.txt

@@ -0,0 +1,53 @@
+Superguard is derived from superlance (https://github.com/Supervisor/superlance)
+and is licensed under the same terms. The original license is reproduced below.
+
+======================================================================
+Original superlance License
+======================================================================
+
+Superlance is licensed under the following license:
+
+  A copyright notice accompanies this license document that identifies
+  the copyright holders.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are
+  met:
+
+  1.  Redistributions in source code must retain the accompanying
+      copyright notice, this list of conditions, and the following
+      disclaimer.
+
+  2.  Redistributions in binary form must reproduce the accompanying
+      copyright notice, this list of conditions, and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+  3.  Names of the copyright holders must not be used to endorse or
+      promote products derived from this software without prior
+      written permission from the copyright holders.
+
+  4.  If any files are modified, you must cause the modified files to
+      carry prominent notices stating that you changed the files and
+      the date of any change.
+
+  Disclaimer
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND
+    ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+    TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+    PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+    TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+    TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+    THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+    SUCH DAMAGE.
+
+======================================================================
+Superguard
+======================================================================
+
+Superguard is licensed under the same terms as superlance (above).

superguard-0.0.3/MANIFEST.in

@@ -0,0 +1,8 @@
+include CHANGES.md
+include COPYRIGHT.txt
+include LICENSE.txt
+include README.rst
+include docs/Makefile
+recursive-include docs *.py *.rst
+recursive-exclude docs/_build *
+

superguard-0.0.3/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: superguard
+Version: 0.0.3
+Summary: Modern health check and process monitoring toolkit for supervisord
+Home-page: https://github.com/daqianai/superguard
+Author: Superguard Contributors
+Author-email: wcxontheway@126.com
+License: BSD-derived (http://www.repoze.org/LICENSE.txt)
+Keywords: supervisor monitoring health-check process-management
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: No Input/Output (Daemon)
+Classifier: Intended Audience :: System Administrators
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Boot
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Systems Administration
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: supervisor
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: mock; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+superguard README
+=================
+
+Superguard is a package of plugin utilities for monitoring and controlling
+processes that run under `supervisor <http://supervisord.org>`_.
+
+Please see ``docs/index.rst`` for complete documentation.
+
+
+# Changelog
+
+## 0.0.2 (2026-07-15)
+- Add changes from superlance main from commit=ab1b8a5f8d5b0c6eb223f45cc483d582f76c315a to commit=ebde11bd8b571196382ca5bbae10be1ea465d17d
+
+## 0.0.1 (2026-07-15)
+- Initial version
+- Forked from superlance 2.0.0, renamed to superguard
+- Support Python 2.7, 3.4+

superguard-0.0.3/README.rst

@@ -0,0 +1,7 @@
+superguard README
+=================
+
+Superguard is a package of plugin utilities for monitoring and controlling
+processes that run under `supervisor <http://supervisord.org>`_.
+
+Please see ``docs/index.rst`` for complete documentation.

superguard-0.0.3/docs/Makefile

@@ -0,0 +1,89 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  dirhtml   to make HTML files named index.html in directories"
+	@echo "  pickle    to make pickle files"
+	@echo "  json      to make JSON files"
+	@echo "  htmlhelp  to make HTML files and a HTML help project"
+	@echo "  qthelp    to make HTML files and a qthelp project"
+	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck to check all external links for integrity"
+	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/superguard.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/superguard.qhc"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

superguard-0.0.3/docs/conf.py

@@ -0,0 +1,201 @@
+# -*- coding: utf-8 -*-
+#
+# superguard documentation build configuration file, created by
+# sphinx-quickstart on Thu Jun 10 11:55:43 2010.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# 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.
+# sys.path.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix of source filenames.
+source_suffix = ".rst"
+
+# The encoding of source files.
+# source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "superguard"
+copyright = (
+    "2008-2013 Agendaless Consulting, Inc. | 2025-present Superguard Contributors"
+)
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = "0.0.3"
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+# unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ["_build"]
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = "default"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_use_modindex = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "superguarddoc"
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+# latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+# latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+    (
+        "index",
+        "superguard.tex",
+        "superguard Documentation",
+        "Superguard Contributors",
+        "manual",
+    ),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+# latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_use_modindex = True

superguard-0.0.3/docs/crashmail.rst

@@ -0,0 +1,78 @@
+:command:`crashmail` Documentation
+==================================
+
+:command:`crashmail` is a supervisor "event listener", intended to be
+subscribed to ``PROCESS_STATE_EXITED`` events. When :command:`crashmail`
+receives that event, and the transition is "unexpected", :command:`crashmail`
+sends an email notification to a configured address.
+
+:command:`crashmail` is incapable of monitoring the process status of processes
+which are not :command:`supervisord` child processes.
+
+:command:`crashmail` is a "console script" installed when you install
+:mod:`superguard`.  Although :command:`crashmail` is an executable program, it
+isn't useful as a general-purpose script:  it must be run as a
+:command:`supervisor` event listener to do anything useful.
+
+Command-Line Syntax
+-------------------
+
+.. code-block:: sh
+
+   $ crashmail [-p processname] [-a] [-o string] [-m mail_address] \
+               [-s sendmail]
+
+.. program:: crashmail
+
+.. cmdoption:: -p <process_name>, --program=<process_name>
+
+   Send mail when the specified :command:`supervisord` child process
+   transitions unexpectedly to the ``EXITED`` state.
+
+   This option can be provided more than once to have :command:`crashmail`
+   monitor more than one program.
+
+   To monitor a process which is part of a :command:`supervisord` group,
+   specify its name as ``group_name:process_name``.
+
+.. cmdoption:: -a, --any
+
+   Send mail when any :command:`supervisord` child process transitions
+   unexpectedly to the ``EXITED`` state.
+
+   Overrides any ``-p`` parameters passed in the same :command:`crashmail`
+   process invocation.
+
+.. cmdoption:: -o <prefix>, --optionalheader=<prefix>
+
+   Specify a parameter used as a prefix in the mail :mailheader:`Subject`
+   header.
+
+.. cmdoption:: -s <sendmail_command>, --sendmail_program=<sendmail_command>
+
+   Specify the sendmail command to use to send email.
+
+   Must be a command which accepts header and message data on stdin and
+   sends mail.  Default is ``/usr/sbin/sendmail -t -i``.
+
+.. cmdoption:: -m <email_address>, --email=<email_address>
+
+   Specify an email address to which crash notification messages are sent.
+   If no email address is specified, email will not be sent.
+
+
+Configuring :command:`crashmail` Into the Supervisor Config
+-----------------------------------------------------------
+
+An ``[eventlistener:x]`` section must be placed in :file:`supervisord.conf`
+in order for :command:`crashmail` to do its work. See the "Events" chapter in
+the Supervisor manual for more information about event listeners.
+
+The following example assumes that :command:`crashmail` is on your system
+:envvar:`PATH`.
+
+.. code-block:: ini
+
+   [eventlistener:crashmail]
+   command=crashmail -p program1 -p group1:program2 -m dev@example.com
+   events=PROCESS_STATE_EXITED

superguard-0.0.3/docs/crashmailbatch.rst

@@ -0,0 +1,82 @@
+:command:`crashmailbatch` Documentation
+=======================================
+
+:command:`crashmailbatch` is a supervisor "event listener", intended to be
+subscribed to ``PROCESS_STATE`` and ``TICK_60`` events.  It monitors
+all processes running under a given supervisord instance.
+
+Similar to :command:`crashmail`, :command:`crashmailbatch` sends email 
+alerts when processes die unexpectedly.  The difference is that all alerts 
+generated within the configured time interval are batched together to avoid 
+sending too many emails.   
+
+:command:`crashmailbatch` is a "console script" installed when you install
+:mod:`superguard`.  Although :command:`crashmailbatch` is an executable 
+program, it isn't useful as a general-purpose script:  it must be run as a
+:command:`supervisor` event listener to do anything useful.
+
+Command-Line Syntax
+-------------------
+
+.. code-block:: sh
+
+   $ crashmailbatch --toEmail=<email address> --fromEmail=<email address> \
+           [--interval=<batch interval in minutes>] [--subject=<email subject>] \
+		   [--tickEvent=<event name>] [--smtpHost=<SMTP server>] \
+           [--userName=<SMTP username>] [--password=<STMP password>] \
+           [--tls]
+   
+.. program:: crashmailbatch
+
+.. cmdoption:: -t <destination email>, --toEmail=<destination email>
+   
+   Specify comma separated email addresses to which crash notification messages are sent.
+ 
+.. cmdoption:: -f <source email>, --fromEmail=<source email>
+   
+   Specify an email address from which crash notification messages are sent.
+
+.. cmdoption:: -i <interval>, --interval=<interval>
+   
+   Specify the time interval in minutes to use for batching notifcations.
+   Defaults to 1.0 minute.
+
+.. cmdoption:: -s <email subject>, --subject=<email subject>
+   
+   Override the email subject line.  Defaults to "Crash alert from supervisord"
+
+.. cmdoption:: -e <event name>, --tickEvent=<event name>
+
+   Override the TICK event name.  Defaults to "TICK_60"
+   
+.. cmdoption:: -H <STMP server> --smtpHost <SMTP server>
+
+   Specify STMP server for sending email
+
+.. cmdoption:: -u <STMP username> --userName <SMTP username>
+
+   Specify STMP username
+
+.. cmdoption:: -p <STMP password> --password <SMTP password>
+
+   Specify STMP password
+
+.. cmdoption:: --tls
+
+   Use Transport Layer Security (TLS)
+
+Configuring :command:`crashmailbatch` Into the Supervisor Config
+----------------------------------------------------------------
+
+An ``[eventlistener:x]`` section must be placed in :file:`supervisord.conf`
+in order for :command:`crashmailbatch` to do its work. See the "Events" chapter in
+the Supervisor manual for more information about event listeners.
+
+The following example assumes that :command:`crashmailbatch` is on your system
+:envvar:`PATH`.
+
+.. code-block:: ini
+
+   [eventlistener:crashmailbatch]
+   command=crashmailbatch --toEmail="alertme@fubar.com" --fromEmail="supervisord@fubar.com" 
+   events=PROCESS_STATE,TICK_60

superguard-0.0.3/docs/crashsms.rst

@@ -0,0 +1,62 @@
+:command:`crashsms` Documentation
+==================================
+
+:command:`crashsms` is a supervisor "event listener", intended to be
+subscribed to ``PROCESS_STATE`` events and ``TICK`` events such as ``TICK_60``.  It monitors
+all processes running under a given supervisord instance.
+
+Similar to :command:`crashmailbatch`, :command:`crashsms` sends SMS alerts
+through an email gateway.  Messages are formatted to fit in SMS
+
+:command:`crashsms` is a "console script" installed when you install
+:mod:`superguard`.  Although :command:`crashsms` is an executable 
+program, it isn't useful as a general-purpose script:  it must be run as a
+:command:`supervisor` event listener to do anything useful.
+
+Command-Line Syntax
+-------------------
+
+.. code-block:: sh
+
+   $ crashsms --toEmail=<email address> --fromEmail=<email address> \
+           [--interval=<batch interval in minutes>] [--subject=<email subject>] \
+		   [--tickEvent=<event name>]
+   
+.. program:: crashsms
+
+.. cmdoption:: -t <destination email>, --toEmail=<destination email>
+   
+   Specify comma separated email addresses to which crash notification messages are sent.
+ 
+.. cmdoption:: -f <source email>, --fromEmail=<source email>
+   
+   Specify an email address from which crash notification messages are sent.
+
+.. cmdoption:: -i <interval>, --interval=<interval>
+   
+   Specify the time interval in minutes to use for batching notifcations.
+   Defaults to 1.0 minute.
+
+.. cmdoption:: -s <email subject>, --subject=<email subject>
+   
+   Set the email subject line.  Default is None
+
+.. cmdoption:: -e <event name>, --tickEvent=<event name>
+
+   Override the TICK event name.  Defaults to "TICK_60"
+
+Configuring :command:`crashsms` Into the Supervisor Config
+-----------------------------------------------------------
+
+An ``[eventlistener:x]`` section must be placed in :file:`supervisord.conf`
+in order for :command:`crashsms` to do its work. See the "Events" chapter in
+the Supervisor manual for more information about event listeners.
+
+The following example assumes that :command:`crashsms` is on your system
+:envvar:`PATH`.
+
+.. code-block:: ini
+
+   [eventlistener:crashsms]
+   command=crashsms --toEmail="<mobile number>@<sms email gateway>" --fromEmail="supervisord@fubar.com" 
+   events=PROCESS_STATE,TICK_60