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