Source

tkf.bitbucket.org / neorg-doc / commands.html

Full commit


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>NEOrg commands &mdash; NEOrg v0.0.1 documentation</title>
    <link rel="stylesheet" href="_static/haiku.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/print.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '0.0.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/theme_extras.js"></script>
    <link rel="top" title="NEOrg v0.0.1 documentation" href="index.html" />
    <link rel="prev" title="Example usages of the special directives" href="examples.html" />
 
<script type="text/javascript">
  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'UA-22829655-1']);
  _gaq.push(['_trackPageview']);
</script>

  </head>
  <body>
      <div class="header"><h1 class="heading"><a href="index.html">
          <span>NEOrg v0.0.1 documentation</span></a></h1>
        <h2 class="heading"><span>NEOrg commands</span></h2>
      </div>
      <div class="topnav">
      
        <p>
        «&#160;&#160;<a href="examples.html">Example usages of the special directives</a>
        &#160;&#160;::&#160;&#160;
        <a class="uplink" href="index.html">Contents</a>
        </p>

      </div>
      <div class="content">
        
        
  <div class="section" id="neorg-commands">
<h1>NEOrg commands<a class="headerlink" href="#neorg-commands" title="Permalink to this headline"></a></h1>
<div class="admonition-neorg-sub-commands admonition ">
<p class="first admonition-title">NEOrg sub-commands</p>
<ul class="last simple">
<li><a class="reference internal" href="#init">init</a></li>
<li><a class="reference internal" href="#serve">serve</a></li>
</ul>
</div>
<div class="highlight-python"><pre>usage: neorg [-h] {init,serve} ...

NEOrg - Numerical Simulation Organizer

positional arguments:
  {init,serve}
    init        initialize neorg directory
    serve       start stand-alone webserver

optional arguments:
  -h, --help    show this help message and exit</pre>
</div>
<div class="section" id="init">
<h2><tt class="docutils literal"><span class="pre">init</span></tt><a class="headerlink" href="#init" title="Permalink to this headline"></a></h2>
<div class="highlight-python"><pre>usage: neorg init [-h] [dest]

positional arguments:
  dest        root directory to initialize (default: ".")

optional arguments:
  -h, --help  show this help message and exit</pre>
</div>
</div>
<div class="section" id="serve">
<h2><tt class="docutils literal"><span class="pre">serve</span></tt><a class="headerlink" href="#serve" title="Permalink to this headline"></a></h2>
<div class="highlight-python"><pre>usage: neorg serve [-h] [-p PORT] [-R ROOT] [-b] [--debug]

optional arguments:
  -h, --help            show this help message and exit
  -p PORT, --port PORT  port to listen (default: 8000)
  -R ROOT, --root ROOT  root directory (where `.neorg/` exists)
  -b, --browser         open web browser
  --debug               set DEBUG=True to run in debug mode</pre>
</div>
</div>
</div>


      </div>
      <div class="bottomnav">
      
        <p>
        «&#160;&#160;<a href="examples.html">Example usages of the special directives</a>
        &#160;&#160;::&#160;&#160;
        <a class="uplink" href="index.html">Contents</a>
        </p>

      </div>


    <div class="footer">
        &copy; Copyright 2011, Takafumi Arakaki.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    </div>
<div class="footer">This page uses <a href="http://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com.
<script type="text/javascript">
  (function() {
    var ga = document.createElement('script');
    ga.src = ('https:' == document.location.protocol ?
              'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
    ga.setAttribute('async', 'true');
    document.documentElement.firstChild.appendChild(ga);
  })();
</script>
</div>

  </body>
</html>