Location: PHPKode > projects > WhiteCrane > readme.html
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>README</title>
<style type="text/css">
html {
	background-color:#EBEBEB;
}
body {
	color: #333;
	font-family: Meiryo, sans-serif;
	background-color: #F4F6F8;
	text-shadow: #EEEEEE 1px 0px 1px;
	font-size: 12px;
	padding:12px;
	margin:0;
}
a {
	color: #06C;
}
a:hover {
	color: #d54e21;
}
h1, h2, h3 {
	color:#005A9C;
}
.home {
	display: block;
	padding: 0px;
	margin-top:-18px;
	color: #CCC;
	font-size: 13px;
	background-color:#005A9C;
	text-decoration:none;
}
.inter {
	font-weight: bold;
	color: #06C;
}
</style>
</head>
<body>
<div><a class="home" href="./readme.html">&nbsp;</a></div>
<h1>README</h1>
<p>WhiteCrane Version 1.3.6<br />
  <strong>Copyright 2005-2009 Ameoto Systems. All Rights Reserved.</strong></p>
<p>This software is licensed under the Creative Commons Attribution-NoDerivs 2.5 License and is free to use and modify, but not redistribute as your own.</p>
<pre>THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS 
CREATIVE COMMONS PUBLIC LICENCE ("CCPL" OR "LICENCE"). THE WORK IS 
PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE 
WORK OTHER THAN AS AUTHORISED UNDER THIS LICENCE AND/OR APPLICABLE 
LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND 
AGREE TO BE BOUND BY THE TERMS OF THIS LICENCE. THE LICENSOR GRANTS 
YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF 
SUCH TERMS AND CONDITIONS.
<br />THIS SOFTWARE IS PROVIDED BY AMEOTO SYSTEMS ''AS IS'' AND IN NO EVENT<br />SHALL AMEOTO SYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, <br />INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES <br />(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR <br />SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) <br />HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,<br />STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)<br />ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED <br />OF THE POSSIBILITY OF SUCH DAMAGE.</pre>
<h2>1. Installation</h2>
<p>To install simply extract and upload the contents of this archive to your web server and make your way to the installer.php and follow the on screen guide.<br />
  We recommend installing WhiteCrane to the base directory of your domain for best compatibility. </p>
<p>If the installation should fail see the FAQ below or send mail to hide@address.com</p>
<h2>2. FAQ</h2>
<ul>
  <li>
    <p><strong>After i install WhiteCrane i can't seem to login</strong><br />
      If your looking for the login box just press the + on the bottom right of the page. If you still can't login you can try <br />
      reinstalling by deleting the config.php file and running the installer script again.</p>
  </li>
  <li>
    <p><strong>Oh noes! i turned off &quot;display login on every page&quot; and can't login!</strong><br />
      To login in you can send your details via the url <br />
      e.g.&nbsp;<a href="http://example.com/path-to-wc/index.php?act=log&amp;username=yournamehere&amp;password=yourpassword">http://example.com/path-to-wc/index.php?act=log&amp;username=yournamehere&amp;password=yourpassword</a></p>
  </li>
  <li>
    <p><strong>When installing it asks to send information to Ameoto Systems</strong><br />
      The installation script sends minimal information about your server and an address to access it from. Additionally when and if your site is added to the database all version checks will originate from&nbsp;http://ping.ameoto.com/~v1&nbsp;or https://ping.ameoto.com/~v2</p>
  </li>
</ul>
<h2 id="cls_inter">3. Console Interface</h2>
<p>WhiteCrane has a minimal console interface built in for running cron jobs, benchmarking and debugging among many other things.<br>
  The console interface is enabled by default and may leave may become a security risk if run over CGI(modern web servers now use fastCGI over<br>
  a socket connection and are safe).</p>
<p>Using the interface is simple. $argv[1] is used for console mode detection and the argument &quot;<span class="inter">console</span>&quot; must be passed to enable this mode.<br>
  In console mode there is no html output besides that of evoked html mode functions. Below is an example of how to invoke the console interface and <br>
  have it dump a list of pages from Index().</p>
<pre class="bash" style="font-family:monospace;">$ php index.php console index
&nbsp;
<span style="color: #666666; font-style: italic;"># Mr CLI</span> 
<span style="color: #666666; font-style: italic;"># Copyright 2009 Ameoto Systems. All Rights Reserved.</span> 
<span style="color: #666666; font-style: italic;"># Written by TheTooth, thetooth[at]ameoto.com</span> 
&nbsp;
Session: 032ca61c1321c65fe9b44bc1fe6a631cc0e6ca55
&nbsp;
Array parent Index<span style="color: #7a0874; font-weight: bold;">&#40;</span><span style="color: #7a0874; font-weight: bold;">&#41;</span> 
   Array
   <span style="color: #7a0874; font-weight: bold;">&#40;</span> 
   <span style="color: #7a0874; font-weight: bold;">&#91;</span><span style="color: #000000;">0</span><span style="color: #7a0874; font-weight: bold;">&#93;</span> =<span style="color: #000000; font-weight: bold;">&gt;</span> .svn
   <span style="color: #7a0874; font-weight: bold;">&#91;</span><span style="color: #000000;">1</span><span style="color: #7a0874; font-weight: bold;">&#93;</span> =<span style="color: #000000; font-weight: bold;">&gt;</span> home.txt
   <span style="color: #7a0874; font-weight: bold;">&#91;</span><span style="color: #000000;">2</span><span style="color: #7a0874; font-weight: bold;">&#93;</span> =<span style="color: #000000; font-weight: bold;">&gt;</span> syntax.txt
   <span style="color: #7a0874; font-weight: bold;">&#41;</span> 
&nbsp;
SAFE EXIT <span style="color: #000000;">0</span></pre>
<p>There are many predefined functions available but if you need to run a line of code remotely you can use the argument &quot;<span class="inter">input</span>&quot; which will allow you to <br>
  eval a line of php within the local console environment. Also if you want to run batch jobs you may use the 'batch' argument to have it include a <br>
  custom script for execution e.g.</p>
<pre class="bash" style="font-family:monospace;">$ php index.php console batch /var/www/dev/batchjob1.php</pre>
<p>In addition there are a few console modes. &quot;<span class="inter">console</span>&quot; for basic I/O with banner on run, &quot;<span class="inter">s-console</span>&quot; for basic I/O without banner or console <br>
  output(safe exit message remains) and &quot;<span class="inter">r-console</span>&quot; which will repeat the set mode 1,000 times before exiting automatically, this is useful for <br>
  benchmarks and memory tests only, be careful using it or your host is going to be pissed.</p>
<p><strong>List of argv[2] modes:</strong></p>
<ul>
  <li><strong>input </strong><br>
    Allows you to evaluate a line of code within WhiteCrane's global's environment(access database and pages via API's).</li>
  <li><strong>index </strong><br>
    Displays an array dump of Index(), can be used to find files with damaged filenames causing crashing in parser.</li>
  <li><strong>purge-cache </strong><br>
    Purges the cache folder, cron shortcut.</li>
  <li><strong>build-cache </strong><br>
    Rebuilds the cache folder, cron shortcut.</li>
  <li><strong>batch </strong><br>
    Allows you to pass a file for execution(via (string)$argv[3]), dies if file is not found.</li>
</ul>
<h2>4. Support</h2>
<p> Please use the&nbsp;<a href="http://dev.ameoto.com/help.php">Support Form</a>&nbsp;for any questions regarding WhiteCrane, if unavailable send mail to&nbsp;<a href="mailto:hide@address.com">hide@address.com</a></p>
</body>
</html>
Return current item: WhiteCrane