PageRenderTime 10ms CodeModel.GetById 1ms app.highlight 7ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/core/zotonic.html

https://code.google.com/p/zotonic/
HTML | 87 lines | 72 code | 15 blank | 0 comment | 0 complexity | 4e62b95ba6856704c5c85677161341fd MD5 | raw file
 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 2<html>
 3<head>
 4<title>Module zotonic</title>
 5<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
 6</head>
 7<body bgcolor="white">
 8<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
 9<hr>
10
11<h1>Module zotonic</h1>
12<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Start/stop functions for Zotonic.
13<p>Copyright Š 2009 Marc Worrell</p>
14
15<p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>).</p>
16
17<h2><a name="description">Description</a></h2>Start/stop functions for Zotonic
18<h2><a name="index">Function Index</a></h2>
19<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#ensure_started-1">ensure_started/1</a></td><td></td></tr>
20<tr><td valign="top"><a href="#run_tests-0">run_tests/0</a></td><td></td></tr>
21<tr><td valign="top"><a href="#start-0">start/0</a></td><td>Start the zotonic server.</td></tr>
22<tr><td valign="top"><a href="#start-1">start/1</a></td><td>Start the zotonic server.</td></tr>
23<tr><td valign="top"><a href="#status-0">status/0</a></td><td>Print the status of the current node.</td></tr>
24<tr><td valign="top"><a href="#status-1">status/1</a></td><td>Get server status.</td></tr>
25<tr><td valign="top"><a href="#stop-0">stop/0</a></td><td>Stop the zotonic server.</td></tr>
26<tr><td valign="top"><a href="#stop-1">stop/1</a></td><td>Stop a zotonic server on a specific node.</td></tr>
27<tr><td valign="top"><a href="#update-0">update/0</a></td><td>Update the server.</td></tr>
28<tr><td valign="top"><a href="#update-1">update/1</a></td><td>Update the server on a specific node with new code on disk and flush the caches.</td></tr>
29</table>
30
31<h2><a name="functions">Function Details</a></h2>
32
33<h3 class="function"><a name="ensure_started-1">ensure_started/1</a></h3>
34<div class="spec">
35<p><tt>ensure_started(App) -&gt; any()</tt></p>
36</div>
37
38<h3 class="function"><a name="run_tests-0">run_tests/0</a></h3>
39<div class="spec">
40<p><tt>run_tests() -&gt; any()</tt></p>
41</div>
42
43<h3 class="function"><a name="start-0">start/0</a></h3>
44<div class="spec">
45<p><tt>start() -&gt; ok</tt></p>
46</div><p>Start the zotonic server.</p>
47
48<h3 class="function"><a name="start-1">start/1</a></h3>
49<div class="spec">
50<p><tt>start(Args::_Args) -&gt; ok</tt></p>
51</div><p>Start the zotonic server.</p>
52
53<h3 class="function"><a name="status-0">status/0</a></h3>
54<div class="spec">
55<p><tt>status() -&gt; ok</tt></p>
56</div><p>Print the status of the current node.</p>
57
58<h3 class="function"><a name="status-1">status/1</a></h3>
59<div class="spec">
60<p><tt>status(X1::[<a href="#type-node">node()</a>]) -&gt; ok</tt></p>
61</div><p>Get server status.  Prints the state of sites running.</p>
62
63<h3 class="function"><a name="stop-0">stop/0</a></h3>
64<div class="spec">
65<p><tt>stop() -&gt; ok</tt></p>
66</div><p>Stop the zotonic server.</p>
67
68<h3 class="function"><a name="stop-1">stop/1</a></h3>
69<div class="spec">
70<p><tt>stop(X1::[Node]) -&gt; <a href="#type-void">void()</a></tt></p>
71</div><p>Stop a zotonic server on a specific node</p>
72
73<h3 class="function"><a name="update-0">update/0</a></h3>
74<div class="spec">
75<p><tt>update() -&gt; ok</tt></p>
76</div><p>Update the server.  Compiles and loads any new code, flushes caches and rescans all modules.</p>
77
78<h3 class="function"><a name="update-1">update/1</a></h3>
79<div class="spec">
80<p><tt>update(X1::[Node]) -&gt; ok</tt></p>
81</div><p>Update the server on a specific node with new code on disk and flush the caches.</p>
82<hr>
83
84<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
85<p><i>Generated by EDoc, Aug 12 2011, 20:01:40.</i></p>
86</body>
87</html>