source: pvMail/doc/build/html/contents.html @ 802

Last change on this file since 802 was 802, checked in by jemian, 10 years ago

documentation

  • Property svn:mime-type set to text/html
File size: 9.4 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>Contents &mdash; PvMail 3 (3.0-r801) documentation</title>
12   
13    <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
14    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '',
19        VERSION:     '3 (3.0-r801)',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="_static/jquery.js"></script>
26    <script type="text/javascript" src="_static/underscore.js"></script>
27    <script type="text/javascript" src="_static/doctools.js"></script>
28    <link rel="top" title="PvMail 3 (3.0-r801) documentation" href="index.html" />
29    <link rel="next" title="pvMail.py: command-line interface" href="cli.html" />
30    <link rel="prev" title="PvMail" href="index.html" /> 
31  </head>
32  <body>
33    <div class="related">
34      <h3>Navigation</h3>
35      <ul>
36        <li class="right" style="margin-right: 10px">
37          <a href="genindex.html" title="General Index"
38             accesskey="I">index</a></li>
39        <li class="right" >
40          <a href="py-modindex.html" title="Python Module Index"
41             >modules</a> |</li>
42        <li class="right" >
43          <a href="cli.html" title="pvMail.py: command-line interface"
44             accesskey="N">next</a> |</li>
45        <li class="right" >
46          <a href="index.html" title="PvMail"
47             accesskey="P">previous</a> |</li>
48        <li><a href="index.html">PvMail 3 (3.0-r801) documentation</a> &raquo;</li> 
49      </ul>
50    </div>
51      <div class="sphinxsidebar">
52        <div class="sphinxsidebarwrapper">
53  <h4>Previous topic</h4>
54  <p class="topless"><a href="index.html"
55                        title="previous chapter">PvMail</a></p>
56  <h4>Next topic</h4>
57  <p class="topless"><a href="cli.html"
58                        title="next chapter">pvMail.py: command-line interface</a></p>
59  <h3>This Page</h3>
60  <ul class="this-page-menu">
61    <li><a href="_sources/contents.txt"
62           rel="nofollow">Show Source</a></li>
63  </ul>
64<div id="searchbox" style="display: none">
65  <h3>Quick search</h3>
66    <form class="search" action="search.html" method="get">
67      <input type="text" name="q" />
68      <input type="submit" value="Go" />
69      <input type="hidden" name="check_keywords" value="yes" />
70      <input type="hidden" name="area" value="default" />
71    </form>
72    <p class="searchtip" style="font-size: 90%">
73    Enter search terms or a module, class or function name.
74    </p>
75</div>
76<script type="text/javascript">$('#searchbox').show(0);</script>
77        </div>
78      </div>
79
80    <div class="document">
81      <div class="documentwrapper">
82        <div class="bodywrapper">
83          <div class="body">
84           
85  <div class="section" id="contents">
86<h1>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h1>
87<div class="toctree-wrapper compound">
88<ul>
89<li class="toctree-l1"><a class="reference internal" href="cli.html">pvMail.py: command-line interface</a><ul>
90<li class="toctree-l2"><a class="reference internal" href="cli.html#starting-pvmail-from-the-command-line">Starting PvMail from the command-line</a></li>
91<li class="toctree-l2"><a class="reference internal" href="cli.html#starting-pvmail-from-the-command-line-at-the-aps">Starting PvMail from the command-line at the APS</a></li>
92</ul>
93</li>
94<li class="toctree-l1"><a class="reference internal" href="cli.html#command-line-parameters">command-line parameters</a><ul>
95<li class="toctree-l2"><a class="reference internal" href="cli.html#usage">usage</a></li>
96<li class="toctree-l2"><a class="reference internal" href="cli.html#positional-argument-trigger-pv">positional argument: <tt class="docutils literal"><span class="pre">trigger_PV</span></tt></a></li>
97<li class="toctree-l2"><a class="reference internal" href="cli.html#positional-argument-message-pv">positional argument: <tt class="docutils literal"><span class="pre">message_PV</span></tt></a></li>
98<li class="toctree-l2"><a class="reference internal" href="cli.html#positional-argument-email-addresses">positional argument: <tt class="docutils literal"><span class="pre">email_addresses</span></tt></a></li>
99<li class="toctree-l2"><a class="reference internal" href="cli.html#option-version-or-v">option: <tt class="docutils literal"><span class="pre">--version</span></tt>  or  <tt class="docutils literal"><span class="pre">-v</span></tt></a></li>
100<li class="toctree-l2"><a class="reference internal" href="cli.html#option-help-or-h">option: <tt class="docutils literal"><span class="pre">--help</span></tt>  or  <tt class="docutils literal"><span class="pre">-h</span></tt></a></li>
101<li class="toctree-l2"><a class="reference internal" href="cli.html#option-gui-or-g">option: <tt class="docutils literal"><span class="pre">--gui</span></tt>  or <tt class="docutils literal"><span class="pre">-g</span></tt></a></li>
102<li class="toctree-l2"><a class="reference internal" href="cli.html#option-l-log-file">option: <tt class="docutils literal"><span class="pre">-l</span> <span class="pre">LOG_FILE</span></tt></a></li>
103<li class="toctree-l2"><a class="reference internal" href="cli.html#option-i-logging-interval">option: <tt class="docutils literal"><span class="pre">-i</span> <span class="pre">LOGGING_INTERVAL</span></tt></a></li>
104<li class="toctree-l2"><a class="reference internal" href="cli.html#option-r-sleep-duration">option: <tt class="docutils literal"><span class="pre">-r</span> <span class="pre">SLEEP_DURATION</span></tt></a></li>
105</ul>
106</li>
107<li class="toctree-l1"><a class="reference internal" href="gui.html">pvMail.py: graphical user interface</a></li>
108<li class="toctree-l1"><a class="reference internal" href="test_database.html">EPICS test database</a><ul>
109<li class="toctree-l2"><a class="reference internal" href="test_database.html#starting-softioc">starting: softIoc</a></li>
110<li class="toctree-l2"><a class="reference internal" href="test_database.html#watching-camonitor">watching: camonitor</a></li>
111<li class="toctree-l2"><a class="reference internal" href="test_database.html#changing-a-pv-caput">changing a PV: caput</a></li>
112<li class="toctree-l2"><a class="reference internal" href="test_database.html#test-db">test.db</a></li>
113</ul>
114</li>
115<li class="toctree-l1"><a class="reference internal" href="pvMail/modules.html">PvMail as a Python package</a><ul>
116<li class="toctree-l2"><a class="reference internal" href="pvMail/modules.html#installation">installation</a></li>
117<li class="toctree-l2"><a class="reference internal" href="pvMail/modules.html#starter-program">starter program</a></li>
118</ul>
119</li>
120<li class="toctree-l1"><a class="reference internal" href="pvMail/modules.html#pvmail-source-code-documentation">PvMail source code documentation</a><ul>
121<li class="toctree-l2"><a class="reference internal" href="pvMail/pvMail.html">PvMail Python Package</a><ul>
122<li class="toctree-l3"><a class="reference internal" href="pvMail/pvMail.html#module-PvMail.pvMail"><tt class="docutils literal"><span class="pre">pvMail</span></tt> Module</a><ul>
123<li class="toctree-l4"><a class="reference internal" href="pvMail/pvMail.html#pvmail-combined-cli-and-gui">pvMail: combined CLI and GUI</a></li>
124</ul>
125</li>
126<li class="toctree-l3"><a class="reference internal" href="pvMail/pvMail.html#module-PvMail.traits_gui"><tt class="docutils literal"><span class="pre">traits_gui</span></tt> Module</a><ul>
127<li class="toctree-l4"><a class="reference internal" href="pvMail/pvMail.html#pvmail-just-the-gui">pvMail: just the GUI</a></li>
128</ul>
129</li>
130</ul>
131</li>
132</ul>
133</li>
134<li class="toctree-l1"><a class="reference internal" href="info.html">More Information</a><ul>
135<li class="toctree-l2"><a class="reference internal" href="info.html#subversion-repository">subversion repository</a></li>
136<li class="toctree-l2"><a class="reference internal" href="info.html#project-management-site">project management site</a></li>
137<li class="toctree-l2"><a class="reference internal" href="info.html#documentation">Documentation</a></li>
138</ul>
139</li>
140<li class="toctree-l1"><a class="reference internal" href="info.html#todo-items-for-the-next-release">TODO items for the next release</a></li>
141<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
142</ul>
143</div>
144</div>
145
146
147          </div>
148        </div>
149      </div>
150      <div class="clearer"></div>
151    </div>
152    <div class="related">
153      <h3>Navigation</h3>
154      <ul>
155        <li class="right" style="margin-right: 10px">
156          <a href="genindex.html" title="General Index"
157             >index</a></li>
158        <li class="right" >
159          <a href="py-modindex.html" title="Python Module Index"
160             >modules</a> |</li>
161        <li class="right" >
162          <a href="cli.html" title="pvMail.py: command-line interface"
163             >next</a> |</li>
164        <li class="right" >
165          <a href="index.html" title="PvMail"
166             >previous</a> |</li>
167        <li><a href="index.html">PvMail 3 (3.0-r801) documentation</a> &raquo;</li> 
168      </ul>
169    </div>
170    <div class="footer">
171        &copy; Copyright (c) 2009-2012, UChicago Argonne, LLC (see LICENSE file for details).
172      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
173    </div>
174  </body>
175</html>
Note: See TracBrowser for help on using the repository browser.