CLI Usage.html 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  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>&lt;no title&gt; &#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="stylesheet" href="_static/custom.css" type="text/css" />
  25. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  26. </head>
  27. <body>
  28. <div class="document">
  29. <div class="documentwrapper">
  30. <div class="bodywrapper">
  31. <div class="body" role="main">
  32. <p># XDice Command-Line</p>
  33. <p>Run <cite>python roll.py [options] &lt;expr&gt;</cite></p>
  34. <blockquote>
  35. <div><dl class="docutils">
  36. <dt>Usage:</dt>
  37. <dd>roll [options] &lt;expr&gt;</dd>
  38. <dt>Options:</dt>
  39. <dd><table class="first docutils option-list" frame="void" rules="none">
  40. <col class="option" />
  41. <col class="description" />
  42. <tbody valign="top">
  43. <tr><td class="option-group">
  44. <kbd><span class="option">-s</span></kbd></td>
  45. <td>Numeric score only</td></tr>
  46. </tbody>
  47. </table>
  48. <p class="last">-h –help Displays help message
  49. –version Displays current xdice version</p>
  50. </dd>
  51. </dl>
  52. </div></blockquote>
  53. <p>### Examples</p>
  54. <ul>
  55. <li><p class="first">Basic use</p>
  56. <blockquote>
  57. <div><p><cite>python roll 1d6+1</cite>
  58. <cite>&gt;&gt; 2 ([1]+1)</cite></p>
  59. </div></blockquote>
  60. </li>
  61. <li><p class="first">Numeric score only</p>
  62. <blockquote>
  63. <div><p><cite>python roll -s 1d6+1</cite>
  64. <cite>&gt;&gt; 2</cite></p>
  65. </div></blockquote>
  66. </li>
  67. </ul>
  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. <div class="relations">
  76. <h3>Related Topics</h3>
  77. <ul>
  78. <li><a href="index.html">Documentation overview</a><ul>
  79. </ul></li>
  80. </ul>
  81. </div>
  82. <div id="searchbox" style="display: none" role="search">
  83. <h3>Quick search</h3>
  84. <form class="search" action="search.html" method="get">
  85. <div><input type="text" name="q" /></div>
  86. <div><input type="submit" value="Go" /></div>
  87. <input type="hidden" name="check_keywords" value="yes" />
  88. <input type="hidden" name="area" value="default" />
  89. </form>
  90. </div>
  91. <script type="text/javascript">$('#searchbox').show(0);</script>
  92. </div>
  93. </div>
  94. <div class="clearer"></div>
  95. </div>
  96. <div class="footer">
  97. &copy;2017, Olivier Massot.
  98. |
  99. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
  100. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
  101. |
  102. <a href="_sources/CLI Usage.md.txt"
  103. rel="nofollow">Page source</a>
  104. </div>
  105. </body>
  106. </html>