command_line.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" >
  3. <head>
  4. <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Command line reference &mdash; Crown Manual 0.47.0 documentation</title>
  7. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <!--[if lt IE 9]>
  10. <script src="_static/js/html5shiv.min.js"></script>
  11. <![endif]-->
  12. <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
  13. <script src="_static/jquery.js"></script>
  14. <script src="_static/underscore.js"></script>
  15. <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
  16. <script src="_static/doctools.js"></script>
  17. <script src="_static/sphinx_highlight.js"></script>
  18. <script src="_static/js/theme.js"></script>
  19. <link rel="index" title="Index" href="genindex.html" />
  20. <link rel="search" title="Search" href="search.html" />
  21. <link rel="copyright" title="Copyright" href="copyright.html" />
  22. <link rel="next" title="Glossary" href="glossary.html" />
  23. <link rel="prev" title="boot.config reference" href="boot_config.html" />
  24. </head>
  25. <body class="wy-body-for-nav">
  26. <div class="wy-grid-for-nav">
  27. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  28. <div class="wy-side-scroll">
  29. <div class="wy-side-nav-search" >
  30. <a href="index.html">
  31. <img src="_static/crown-logo-white.svg" class="logo" alt="Logo"/>
  32. </a>
  33. <div class="version">
  34. 0.47.0
  35. </div>
  36. <div role="search">
  37. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  38. <input type="text" name="q" placeholder="Search docs" />
  39. <input type="hidden" name="check_keywords" value="yes" />
  40. <input type="hidden" name="area" value="default" />
  41. </form>
  42. </div>
  43. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  44. <ul class="current">
  45. <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
  46. <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
  47. <li class="toctree-l1"><a class="reference internal" href="basics.html">Basic concepts</a></li>
  48. <li class="toctree-l1"><a class="reference internal" href="lua_api.html">Lua API reference</a></li>
  49. <li class="toctree-l1"><a class="reference internal" href="boot_config.html">boot.config reference</a></li>
  50. <li class="toctree-l1 current"><a class="current reference internal" href="#">Command line reference</a><ul>
  51. <li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
  52. <li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li>
  53. </ul>
  54. </li>
  55. <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
  56. <li class="toctree-l1"><a class="reference internal" href="copyright.html">License</a></li>
  57. </ul>
  58. <ul>
  59. <li class="toctree-l1"><a class="reference internal" href="hackers/index.html">Hackers</a></li>
  60. </ul>
  61. </div>
  62. </div>
  63. </nav>
  64. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  65. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  66. <a href="index.html">Crown Manual</a>
  67. </nav>
  68. <div class="wy-nav-content">
  69. <div class="rst-content">
  70. <div role="navigation" aria-label="Page navigation">
  71. <ul class="wy-breadcrumbs">
  72. <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
  73. <li>Command line reference</li>
  74. <li class="wy-breadcrumbs-aside">
  75. <a href="_sources/command_line.rst.txt" rel="nofollow"> View page source</a>
  76. </li>
  77. </ul>
  78. <hr/>
  79. </div>
  80. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  81. <div itemprop="articleBody">
  82. <section id="command-line-reference">
  83. <h1>Command line reference<a class="headerlink" href="#command-line-reference" title="Permalink to this heading">¶</a></h1>
  84. <section id="examples">
  85. <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
  86. <p>Compile source data from <code class="docutils literal notranslate"><span class="pre">/home/user/demo</span></code> using a mapped <code class="docutils literal notranslate"><span class="pre">core</span></code> folder.</p>
  87. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">crown</span><span class="o">-</span><span class="n">development64</span> <span class="o">--</span><span class="n">source</span><span class="o">-</span><span class="nb">dir</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">user</span><span class="o">/</span><span class="n">demo</span> <span class="o">--</span><span class="nb">map</span><span class="o">-</span><span class="n">source</span><span class="o">-</span><span class="nb">dir</span> <span class="n">core</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">user</span> <span class="o">--</span><span class="nb">compile</span>
  88. </pre></div>
  89. </div>
  90. <p>Run the engine using compiled data from <code class="docutils literal notranslate"><span class="pre">/home/user/demo_linux</span></code>:</p>
  91. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">crown</span><span class="o">-</span><span class="n">development64</span> <span class="o">--</span><span class="n">data</span><span class="o">-</span><span class="nb">dir</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">user</span><span class="o">/</span><span class="n">demo_linux</span>
  92. </pre></div>
  93. </div>
  94. </section>
  95. <section id="options">
  96. <h2>Options<a class="headerlink" href="#options" title="Permalink to this heading">¶</a></h2>
  97. <dl>
  98. <dt><code class="docutils literal notranslate"><span class="pre">-h</span></code> <code class="docutils literal notranslate"><span class="pre">--help</span></code></dt><dd><p>Display the help and quit.</p>
  99. </dd>
  100. <dt><code class="docutils literal notranslate"><span class="pre">-v</span></code> <code class="docutils literal notranslate"><span class="pre">--version</span></code></dt><dd><p>Display engine version and quit.</p>
  101. </dd>
  102. <dt><code class="docutils literal notranslate"><span class="pre">--source-dir</span> <span class="pre">&lt;path&gt;</span></code></dt><dd><p>Use &lt;path&gt; as the source directory for resource compilation.</p>
  103. <p>The &lt;path&gt; must be absolute.</p>
  104. </dd>
  105. <dt><code class="docutils literal notranslate"><span class="pre">--data-dir</span> <span class="pre">&lt;path&gt;</span></code></dt><dd><p>Use &lt;path&gt; as the destination directory for compiled resources.</p>
  106. <p>The &lt;path&gt; must be absolute.</p>
  107. </dd>
  108. <dt><code class="docutils literal notranslate"><span class="pre">--boot-dir</span> <span class="pre">&lt;path&gt;</span></code></dt><dd><p>Boot the engine with the <code class="docutils literal notranslate"><span class="pre">boot.config</span></code> from given &lt;path&gt;.</p>
  109. <p>The &lt;path&gt; must be relative.</p>
  110. </dd>
  111. <dt><code class="docutils literal notranslate"><span class="pre">--compile</span></code></dt><dd><p>Do a full compile of the resources.</p>
  112. <p>When using this option you must also specify <code class="docutils literal notranslate"><span class="pre">--platform</span></code>, <code class="docutils literal notranslate"><span class="pre">--source-dir</span></code> and <code class="docutils literal notranslate"><span class="pre">--data-dir</span></code>.</p>
  113. </dd>
  114. <dt><code class="docutils literal notranslate"><span class="pre">--platform</span> <span class="pre">&lt;platform&gt;</span></code></dt><dd><p>Compile resources for the given &lt;platform&gt;.
  115. Possible values for &lt;platform&gt; are:</p>
  116. <ul class="simple">
  117. <li><p><code class="docutils literal notranslate"><span class="pre">android</span></code></p></li>
  118. <li><p><code class="docutils literal notranslate"><span class="pre">linux</span></code></p></li>
  119. <li><p><code class="docutils literal notranslate"><span class="pre">windows</span></code></p></li>
  120. </ul>
  121. </dd>
  122. <dt><code class="docutils literal notranslate"><span class="pre">--continue</span></code></dt><dd><p>Run the engine after resource compilation.</p>
  123. </dd>
  124. <dt><code class="docutils literal notranslate"><span class="pre">--console-port</span> <span class="pre">&lt;port&gt;</span></code></dt><dd><p>Set port of the console.</p>
  125. <p>When no port is specified, the engine uses the port 10001.</p>
  126. </dd>
  127. <dt><code class="docutils literal notranslate"><span class="pre">--wait-console</span></code></dt><dd><p>Wait for a console connection before starting up.</p>
  128. </dd>
  129. <dt><code class="docutils literal notranslate"><span class="pre">--parent-window</span> <span class="pre">&lt;handle&gt;</span></code></dt><dd><p>Set the parent window &lt;handle&gt; of the main window.</p>
  130. <p>This option should be used only by the tools.</p>
  131. </dd>
  132. <dt><code class="docutils literal notranslate"><span class="pre">--server</span></code></dt><dd><p>Run the engine in server mode.</p>
  133. <p>When using this option you must also specify <code class="docutils literal notranslate"><span class="pre">--source-dir</span></code>.</p>
  134. </dd>
  135. <dt><code class="docutils literal notranslate"><span class="pre">--run-unit-tests</span></code></dt><dd><p>Run unit tests and quit. Available only on <code class="docutils literal notranslate"><span class="pre">linux</span></code> and <code class="docutils literal notranslate"><span class="pre">windows</span></code>.</p>
  136. </dd>
  137. </dl>
  138. </section>
  139. </section>
  140. </div>
  141. </div>
  142. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  143. <a href="boot_config.html" class="btn btn-neutral float-left" title="boot.config reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  144. <a href="glossary.html" class="btn btn-neutral float-right" title="Glossary" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  145. </div>
  146. <hr/>
  147. <div role="contentinfo">
  148. <p>&#169; <a href="copyright.html">Copyright</a> Except where otherwise noted, content on this page is licensed under a CC-BY-SA 4.0 Int. License.</p>
  149. </div>
  150. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  151. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  152. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  153. </footer>
  154. </div>
  155. </div>
  156. </section>
  157. </div>
  158. <script>
  159. jQuery(function () {
  160. SphinxRtdTheme.Navigation.enable(true);
  161. });
  162. </script>
  163. <!-- Theme Analytics -->
  164. <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
  165. <script>
  166. window.dataLayer = window.dataLayer || [];
  167. function gtag(){dataLayer.push(arguments);}
  168. gtag('js', new Date());
  169. gtag('config', 'G-XNVGCMNDZH', {
  170. 'anonymize_ip': true,
  171. });
  172. </script>
  173. </body>
  174. </html>