cli.html 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Command-Line &#8212; xdice 1.0.0 documentation</title>
  7. <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: './',
  12. VERSION: '1.0.0',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true,
  16. SOURCELINK_SUFFIX: '.txt'
  17. };
  18. </script>
  19. <script type="text/javascript" src="_static/jquery.js"></script>
  20. <script type="text/javascript" src="_static/underscore.js"></script>
  21. <script type="text/javascript" src="_static/doctools.js"></script>
  22. <link rel="index" title="Index" href="genindex.html" />
  23. <link rel="search" title="Search" href="search.html" />
  24. <link rel="next" title="API Reference" href="api.html" />
  25. <link rel="prev" title="Dice Notation" href="dice_notation.html" />
  26. <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  27. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  28. </head>
  29. <body>
  30. <div class="document">
  31. <div class="documentwrapper">
  32. <div class="bodywrapper">
  33. <div class="body" role="main">
  34. <div class="section" id="command-line">
  35. <h1>Command-Line<a class="headerlink" href="#command-line" title="Permalink to this headline">¶</a></h1>
  36. <p>Run <code class="docutils literal"><span class="pre">python</span> <span class="pre">roll.py</span> <span class="pre">[options]</span> <span class="pre">&lt;expr&gt;</span></code></p>
  37. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Usage</span><span class="p">:</span>
  38. <span class="n">roll</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="o">&lt;</span><span class="n">expr</span><span class="o">&gt;</span>
  39. <span class="n">Options</span><span class="p">:</span>
  40. <span class="o">-</span><span class="n">s</span> <span class="n">Numeric</span> <span class="n">score</span> <span class="n">only</span>
  41. <span class="o">-</span><span class="n">v</span> <span class="n">Verbose</span> <span class="n">result</span>
  42. <span class="o">-</span><span class="n">h</span> <span class="o">--</span><span class="n">help</span> <span class="n">Displays</span> <span class="n">help</span> <span class="n">message</span>
  43. <span class="o">--</span><span class="n">version</span> <span class="n">Displays</span> <span class="n">current</span> <span class="n">xdice</span> <span class="n">version</span>
  44. </pre></div>
  45. </div>
  46. <ul class="simple">
  47. <li>Basic use</li>
  48. </ul>
  49. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">roll</span> <span class="mi">1</span><span class="n">d6</span><span class="o">+</span><span class="mi">1</span>
  50. <span class="o">&gt;&gt;</span> <span class="mi">2</span> <span class="p">([</span><span class="mi">1</span><span class="p">]</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span>
  51. </pre></div>
  52. </div>
  53. <ul class="simple">
  54. <li>Numeric score only (-s)</li>
  55. </ul>
  56. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">roll</span> <span class="o">-</span><span class="n">s</span> <span class="mi">1</span><span class="n">d6</span><span class="o">+</span><span class="mi">1</span>
  57. <span class="o">&gt;&gt;</span> <span class="mi">2</span>
  58. </pre></div>
  59. </div>
  60. <ul class="simple">
  61. <li>Verbose (-v)</li>
  62. </ul>
  63. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">roll</span> <span class="o">-</span><span class="n">v</span> <span class="mi">2</span><span class="o">*</span><span class="p">(</span><span class="mi">3</span><span class="n">D6L1</span><span class="o">+</span><span class="mi">2</span><span class="n">D4</span><span class="p">)</span><span class="o">+</span><span class="n">R3</span><span class="p">(</span><span class="mi">1</span><span class="n">d4</span><span class="o">+</span><span class="mi">2</span><span class="p">)</span>
  64. <span class="o">&gt;&gt;</span> <span class="p">(</span><span class="mi">2</span><span class="o">*</span><span class="p">(</span><span class="mi">3</span><span class="n">d6l1</span><span class="p">(</span><span class="n">scores</span><span class="p">:[</span><span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">],</span> <span class="n">dropped</span><span class="p">:[</span><span class="mi">3</span><span class="p">])</span><span class="o">+</span><span class="mi">2</span><span class="n">d4</span><span class="p">(</span><span class="n">scores</span><span class="p">:[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">]))</span><span class="o">+</span><span class="p">(</span><span class="mi">1</span><span class="n">d4</span><span class="p">(</span><span class="n">scores</span><span class="p">:[</span><span class="mi">4</span><span class="p">])</span><span class="o">+</span><span class="mi">2</span><span class="o">+</span><span class="mi">1</span><span class="n">d4</span><span class="p">(</span><span class="n">scores</span><span class="p">:[</span><span class="mi">1</span><span class="p">])</span><span class="o">+</span><span class="mi">2</span><span class="o">+</span><span class="mi">1</span><span class="n">d4</span><span class="p">(</span><span class="n">scores</span><span class="p">:[</span><span class="mi">4</span><span class="p">])</span><span class="o">+</span><span class="mi">2</span><span class="p">))</span>
  65. </pre></div>
  66. </div>
  67. </div>
  68. </div>
  69. </div>
  70. </div>
  71. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  72. <div class="sphinxsidebarwrapper">
  73. <h1 class="logo"><a href="index.html">xdice</a></h1>
  74. <h3>Navigation</h3>
  75. <ul class="current">
  76. <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
  77. <li class="toctree-l1"><a class="reference internal" href="dice_notation.html">Dice Notation</a></li>
  78. <li class="toctree-l1 current"><a class="current reference internal" href="#">Command-Line</a></li>
  79. <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
  80. </ul>
  81. <div class="relations">
  82. <h3>Related Topics</h3>
  83. <ul>
  84. <li><a href="index.html">Documentation overview</a><ul>
  85. <li>Previous: <a href="dice_notation.html" title="previous chapter">Dice Notation</a></li>
  86. <li>Next: <a href="api.html" title="next chapter">API Reference</a></li>
  87. </ul></li>
  88. </ul>
  89. </div>
  90. <div id="searchbox" style="display: none" role="search">
  91. <h3>Quick search</h3>
  92. <form class="search" action="search.html" method="get">
  93. <div><input type="text" name="q" /></div>
  94. <div><input type="submit" value="Go" /></div>
  95. <input type="hidden" name="check_keywords" value="yes" />
  96. <input type="hidden" name="area" value="default" />
  97. </form>
  98. </div>
  99. <script type="text/javascript">$('#searchbox').show(0);</script>
  100. </div>
  101. </div>
  102. <div class="clearer"></div>
  103. </div>
  104. <div class="footer">
  105. &copy;2017, Olivier Massot.
  106. |
  107. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
  108. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
  109. |
  110. <a href="_sources/cli.rst.txt"
  111. rel="nofollow">Page source</a>
  112. </div>
  113. </body>
  114. </html>