doc/build/html/usage_of_sat.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9     <title>Usage of SAlomeTools &#8212; salomeTools 5.0.0dev documentation</title>
  10     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
  11     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  12     <script type="text/javascript" src="_static/documentation_options.js"></script>
  13     <script type="text/javascript" src="_static/jquery.js"></script>
  14     <script type="text/javascript" src="_static/underscore.js"></script>
  15     <script type="text/javascript" src="_static/doctools.js"></script>
  16     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  17     <link rel="index" title="Index" href="genindex.html" />
  18     <link rel="search" title="Search" href="search.html" />
  19     <link rel="next" title="Command config" href="commands/config.html" />
  20     <link rel="prev" title="Configuration" href="configuration.html" />
  21
  22   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  23
  24
  25   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  26
  27   </head><body>
  28
  29
  30     <div class="document">
  31       <div class="documentwrapper">
  32         <div class="bodywrapper">
  33           <div class="body" role="main">
  34
  35   <div class="section" id="usage-of-salometools">
  36 <h1>Usage of SAlomeTools<a class="headerlink" href="#usage-of-salometools" title="Permalink to this headline">¶</a></h1>
  37 <div class="section" id="usage">
  38 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
  39 <p>sat usage is a Command Line Interface (<a class="reference external" href="https://en.wikipedia.org/wiki/Command-line_interface">CLI</a>).</p>
  40 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sat <span class="o">[</span>generic_options<span class="o">]</span> <span class="o">[</span>command<span class="o">]</span> <span class="o">[</span>product<span class="o">]</span> <span class="o">[</span>command_options<span class="o">]</span>
  41 </pre></div>
  42 </div>
  43 <div class="section" id="options-of-sat">
  44 <h3>Options of sat<a class="headerlink" href="#options-of-sat" title="Permalink to this headline">¶</a></h3>
  45 <p>Useful <em>not exhaustive</em> generic options of <em>sat</em> CLI.</p>
  46 <div class="section" id="help-or-h">
  47 <h4><em>–help or -h</em><a class="headerlink" href="#help-or-h" title="Permalink to this headline">¶</a></h4>
  48 <p>Get help as simple text.</p>
  49 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sat --help          <span class="c1"># get the list of existing commands</span>
  50 sat --help compile  <span class="c1"># get the help on a specific command &#39;compile&#39;</span>
  51 </pre></div>
  52 </div>
  53 </div>
  54 <div class="section" id="debug-or-g">
  55 <h4><em>–debug or -g</em><a class="headerlink" href="#debug-or-g" title="Permalink to this headline">¶</a></h4>
  56 <p>Execution in debug mode allows to see more trace and <em>stack</em> if an exception is raised.</p>
  57 </div>
  58 <div class="section" id="verbose-or-v">
  59 <h4><em>–verbose or -v</em><a class="headerlink" href="#verbose-or-v" title="Permalink to this headline">¶</a></h4>
  60 <p>Change verbosity level (default is 3).</p>
  61 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># for product &#39;SALOME_xx&#39; for example</span>
  62 <span class="c1"># execute compile command in debug mode with trace level 4</span>
  63 sat -g -v <span class="m">4</span> compile SALOME_xx
  64 </pre></div>
  65 </div>
  66 </div>
  67 </div>
  68 </div>
  69 <div class="section" id="build-a-salome-product">
  70 <h2>Build a SALOME product<a class="headerlink" href="#build-a-salome-product" title="Permalink to this headline">¶</a></h2>
  71 <div class="section" id="get-the-list-of-available-products">
  72 <h3>Get the list of available products<a class="headerlink" href="#get-the-list-of-available-products" title="Permalink to this headline">¶</a></h3>
  73 <p>To get the list of the current available products in your context:</p>
  74 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sat config --list
  75 </pre></div>
  76 </div>
  77 </div>
  78 <div class="section" id="prepare-sources-of-a-product">
  79 <h3>Prepare sources of a product<a class="headerlink" href="#prepare-sources-of-a-product" title="Permalink to this headline">¶</a></h3>
  80 <p>To prepare (get) <em>all</em> the sources of a product (<em>SALOME_xx</em> for example):</p>
  81 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sat prepare SALOME_xx
  82 </pre></div>
  83 </div>
  84 <div class="line-block">
  85 <div class="line">The sources are usually copied in directories</div>
  86 <div class="line"><em>$USER.workDir + SALOME_xx… + SOURCES + $PRODUCT.name</em></div>
  87 </div>
  88 </div>
  89 <div class="section" id="compile-salome">
  90 <h3>Compile SALOME<a class="headerlink" href="#compile-salome" title="Permalink to this headline">¶</a></h3>
  91 <p>To compile products:</p>
  92 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># compile all prerequisites/products</span>
  93 sat compile SALOME_xx
  94
  95 <span class="c1"># compile only 2 products (KERNEL and SAMPLES), if not done yet</span>
  96 sat compile SALOME_xx --products KERNEL,SAMPLES
  97
  98 <span class="c1"># compile only 2 products, unconditionaly</span>
  99 sat compile SALOME_xx ---products SAMPLES --clean_all
 100 </pre></div>
 101 </div>
 102 <div class="line-block">
 103 <div class="line">The products are usually build in the directories</div>
 104 <div class="line"><em>$USER.workDir + SALOME_xx… + BUILD + $PRODUCT.name</em></div>
 105 <div class="line"><br /></div>
 106 <div class="line">The products are usually installed in the directories</div>
 107 <div class="line"><em>$USER.workDir + SALOME_xx… + INSTALL + $PRODUCT.name</em></div>
 108 </div>
 109 </div>
 110 </div>
 111 </div>
 112
 113
 114           </div>
 115         </div>
 116       </div>
 117       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 118         <div class="sphinxsidebarwrapper">
 119             <p class="logo"><a href="index.html">
 120               <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
 121             </a></p>
 122   <h3><a href="index.html">Table Of Contents</a></h3>
 123   <ul>
 124 <li><a class="reference internal" href="#">Usage of SAlomeTools</a><ul>
 125 <li><a class="reference internal" href="#usage">Usage</a><ul>
 126 <li><a class="reference internal" href="#options-of-sat">Options of sat</a><ul>
 127 <li><a class="reference internal" href="#help-or-h"><em>–help or -h</em></a></li>
 128 <li><a class="reference internal" href="#debug-or-g"><em>–debug or -g</em></a></li>
 129 <li><a class="reference internal" href="#verbose-or-v"><em>–verbose or -v</em></a></li>
 130 </ul>
 131 </li>
 132 </ul>
 133 </li>
 134 <li><a class="reference internal" href="#build-a-salome-product">Build a SALOME product</a><ul>
 135 <li><a class="reference internal" href="#get-the-list-of-available-products">Get the list of available products</a></li>
 136 <li><a class="reference internal" href="#prepare-sources-of-a-product">Prepare sources of a product</a></li>
 137 <li><a class="reference internal" href="#compile-salome">Compile SALOME</a></li>
 138 </ul>
 139 </li>
 140 </ul>
 141 </li>
 142 </ul>
 143 <div class="relations">
 144 <h3>Related Topics</h3>
 145 <ul>
 146   <li><a href="index.html">Documentation overview</a><ul>
 147       <li>Previous: <a href="configuration.html" title="previous chapter">Configuration</a></li>
 148       <li>Next: <a href="commands/config.html" title="next chapter">Command config</a></li>
 149   </ul></li>
 150 </ul>
 151 </div>
 152   <div role="note" aria-label="source link">
 153     <h3>This Page</h3>
 154     <ul class="this-page-menu">
 155       <li><a href="_sources/usage_of_sat.rst.txt"
 156             rel="nofollow">Show Source</a></li>
 157     </ul>
 158    </div>
 159 <div id="searchbox" style="display: none" role="search">
 160   <h3>Quick search</h3>
 161     <div class="searchformwrapper">
 162     <form class="search" action="search.html" method="get">
 163       <input type="text" name="q" />
 164       <input type="submit" value="Go" />
 165       <input type="hidden" name="check_keywords" value="yes" />
 166       <input type="hidden" name="area" value="default" />
 167     </form>
 168     </div>
 169 </div>
 170 <script type="text/javascript">$('#searchbox').show(0);</script>
 171         </div>
 172       </div>
 173       <div class="clearer"></div>
 174     </div>
 175     <div class="footer">
 176       &copy;2018, CEA.
 177
 178       |
 179       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.3</a>
 180       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 181
 182       |
 183       <a href="_sources/usage_of_sat.rst.txt"
 184           rel="nofollow">Page source</a>
 185     </div>
 186
 187
 188
 189
 190   </body>
 191 </html>