source: epicsdf/doc/build/html/host/index.html @ 597

Last change on this file since 597 was 597, checked in by jemian, 11 years ago

add HTML documentation to SVN

  • Property svn:executable set to *
  • Property svn:mime-type set to text/html
File size: 6.5 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<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>Host computer support documentation &mdash; epicsdf v1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="epicsdf v1.0 documentation" href="../index.html" />
26    <link rel="up" title="Contents" href="../contents.html" />
27    <link rel="next" title="Source code documentation" href="../src/index.html" />
28    <link rel="prev" title="EPICS IOC support documentation" href="../epics/index.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="../src/index.html" title="Source code documentation"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="../epics/index.html" title="EPICS IOC support documentation"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">epicsdf v1.0 documentation</a> &raquo;</li>
47          <li><a href="../contents.html" accesskey="U">Contents</a> &raquo;</li> 
48      </ul>
49    </div>
50      <div class="sphinxsidebar">
51        <div class="sphinxsidebarwrapper">
52  <h4>Previous topic</h4>
53  <p class="topless"><a href="../epics/index.html"
54                        title="previous chapter">EPICS IOC support documentation</a></p>
55  <h4>Next topic</h4>
56  <p class="topless"><a href="../src/index.html"
57                        title="next chapter">Source code documentation</a></p>
58  <h3>This Page</h3>
59  <ul class="this-page-menu">
60    <li><a href="../_sources/host/index.txt"
61           rel="nofollow">Show Source</a></li>
62  </ul>
63<div id="searchbox" style="display: none">
64  <h3>Quick search</h3>
65    <form class="search" action="../search.html" method="get">
66      <input type="text" name="q" size="18" />
67      <input type="submit" value="Go" />
68      <input type="hidden" name="check_keywords" value="yes" />
69      <input type="hidden" name="area" value="default" />
70    </form>
71    <p class="searchtip" style="font-size: 90%">
72    Enter search terms or a module, class or function name.
73    </p>
74</div>
75<script type="text/javascript">$('#searchbox').show(0);</script>
76        </div>
77      </div>
78
79    <div class="document">
80      <div class="documentwrapper">
81        <div class="bodywrapper">
82          <div class="body">
83           
84  <div class="section" id="host-computer-support-documentation">
85<h1>Host computer support documentation<a class="headerlink" href="#host-computer-support-documentation" title="Permalink to this headline">¶</a></h1>
86<p>The host computer support package consists of a bash shell script and
87a Makefile, both located in the directory: &lt;epicsdf&gt;/shell/</p>
88<p>Most important is the bash shell script: epicsdf.sh.
89It is used to start, stop, restart, and check that the Python job is running.
90The shell logs all its output (and that of the Python code)
91into the file epicsdf.log in the same directory.
92The process identifier (PID) is recorded in the file epicsdf.pid.</p>
93<p>There is also a Makefile in the same directory for convenience.</p>
94<blockquote>
95<div><table border="1" class="docutils">
96<colgroup>
97<col width="24%" />
98<col width="34%" />
99<col width="42%" />
100</colgroup>
101<thead valign="bottom">
102<tr><th class="head">Makefile</th>
103<th class="head">bash shell</th>
104<th class="head">description</th>
105</tr>
106</thead>
107<tbody valign="top">
108<tr><td>make</td>
109<td>epicsdf.sh checkup</td>
110<td>make sure the python job
111is running and restart
112it if is not</td>
113</tr>
114<tr><td>make start</td>
115<td>epicsdf.sh start</td>
116<td>start the python job</td>
117</tr>
118<tr><td>make stop</td>
119<td>epicsdf.sh stop</td>
120<td>stop the python job</td>
121</tr>
122<tr><td>make restart</td>
123<td>epicsdf.sh restart</td>
124<td>restart the python job</td>
125</tr>
126</tbody>
127</table>
128</div></blockquote>
129<p>To make sure the Python script is running, enter these commands
130as a cron task (which run a check every five minutes):</p>
131<div class="highlight-python"><pre># cron task
132#  watch some local disk partition and report it to EPICS, send emails if space runs low
133   */5 * * * * /path/to/epicsdf/shell/epicsdf.sh start</pre>
134</div>
135<table class="docutils field-list" frame="void" rules="none">
136<col class="field-name" />
137<col class="field-body" />
138<tbody valign="top">
139<tr class="field"><th class="field-name">note:</th><td class="field-body">To edit a cron task, you need to set an environment variable for an
140editor such as EDITOR=nano and then type &#8220;crontab -e&#8221; on the command
141line.  Paste in the line above, save the edits, and quit the editor.</td>
142</tr>
143</tbody>
144</table>
145</div>
146
147
148          </div>
149        </div>
150      </div>
151      <div class="clearer"></div>
152    </div>
153    <div class="related">
154      <h3>Navigation</h3>
155      <ul>
156        <li class="right" style="margin-right: 10px">
157          <a href="../genindex.html" title="General Index"
158             >index</a></li>
159        <li class="right" >
160          <a href="../py-modindex.html" title="Python Module Index"
161             >modules</a> |</li>
162        <li class="right" >
163          <a href="../src/index.html" title="Source code documentation"
164             >next</a> |</li>
165        <li class="right" >
166          <a href="../epics/index.html" title="EPICS IOC support documentation"
167             >previous</a> |</li>
168        <li><a href="../index.html">epicsdf v1.0 documentation</a> &raquo;</li>
169          <li><a href="../contents.html" >Contents</a> &raquo;</li> 
170      </ul>
171    </div>
172    <div class="footer">
173        &copy; Copyright 2011, Pete Jemian.
174      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
175    </div>
176  </body>
177</html>
Note: See TracBrowser for help on using the repository browser.