doc/build/html/commands/package.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>Command package &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 generate" href="generate.html" />
  31     <link rel="prev" title="Command clean" href="clean.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="command-package">
  48 <h1>Command package<a class="headerlink" href="#command-package" title="Permalink to this headline">¶</a></h1>
  49 <div class="section" id="description">
  50 <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
  51 <p>The <strong>package</strong> command creates a <a class="reference external" href="http://www.salome-platform.org">SALOME</a> archive (usually a compressed <a class="reference external" href="https://en.wikipedia.org/wiki/Tar_(computing)">Tar</a> file .tgz).
  52 This tar file is used later to intall SALOME on other remote computer.</p>
  53 <p>Depending on the selected options, the archive includes sources and binaries
  54 of SALOME products and prerequisites.</p>
  55 <p>Usually utility <em>salomeTools</em> is included in the archive.</p>
  56 <div class="admonition note">
  57 <p class="first admonition-title">Note</p>
  58 <p class="last">By default the package includes the sources of prerequisites and products.
  59 To select a subset use the <em>--without_property</em> or <em>--with_vcs</em> options.</p>
  60 </div>
  61 </div>
  62 <div class="section" id="usage">
  63 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
  64 <ul>
  65 <li><p class="first">Create a package for a product (example as <em>SALOME_xx</em>):</p>
  66 <div class="highlight-python"><pre>sat package SALOME_xx</pre>
  67 </div>
  68 <p>This command will create an archive named <tt class="docutils literal"><span class="pre">SALOME_xx.tgz</span></tt>
  69 in the working directory (<tt class="docutils literal"><span class="pre">USER.workDir</span></tt>).
  70 If the archive already exists, do nothing.</p>
  71 </li>
  72 <li><p class="first">Create a package with a specific name:</p>
  73 <div class="highlight-python"><pre>sat package SALOME_xx --name YourSpecificName</pre>
  74 </div>
  75 </li>
  76 </ul>
  77 <div class="admonition note">
  78 <p class="first admonition-title">Note</p>
  79 <p>By default, the archive is created in the working directory of the user (<tt class="docutils literal"><span class="pre">USER.workDir</span></tt>).</p>
  80 <p>If the option <em>--name</em> is used with a path (relative or absolute) it will be used.</p>
  81 <p>If the option <em>--name</em> is not used and binaries (prerequisites and products)
  82 are included in the package, the <a class="reference external" href="https://en.wikipedia.org/wiki/Operating_system">OS</a> architecture
  83 will be appended to the name (example: <tt class="docutils literal"><span class="pre">SALOME_xx-CO7.tgz</span></tt>).</p>
  84 <p>Examples:</p>
  85 <div class="last highlight-python"><pre># Creates SALOME_xx.tgz in $USER.workDir
  86 sat package SALOME_xx
  87
  88 # Creates SALOME_xx_&lt;arch&gt;.tgz in $USER.workDir
  89 sat package SALOME_xx --binaries
  90
  91 # Creates MySpecificName.tgz in $USER.workDir
  92 sat package SALOME_xx --name MySpecificName</pre>
  93 </div>
  94 </div>
  95 <ul>
  96 <li><p class="first">Force the creation of the archive (if it already exists):</p>
  97 <div class="highlight-python"><pre>sat package SALOME_xx --force</pre>
  98 </div>
  99 </li>
 100 <li><p class="first">Include the binaries in the archive (products and prerequisites):</p>
 101 <div class="highlight-python"><pre>sat package SALOME_xx --binaries</pre>
 102 </div>
 103 <p>This command will create an archive named <tt class="docutils literal"><span class="pre">SALOME_xx</span> <span class="pre">_&lt;arch&gt;.tgz</span></tt>
 104 where &lt;arch&gt; is the <a class="reference external" href="https://en.wikipedia.org/wiki/Operating_system">OS</a> architecture of the machine.</p>
 105 </li>
 106 <li><p class="first">Do not delete Version Control System (<a class="reference external" href="https://en.wikipedia.org/wiki/Version_control">VCS</a>) informations from the configurations files of the embedded salomeTools:</p>
 107 <div class="highlight-python"><pre>sat package SALOME_xx --with_vcs</pre>
 108 </div>
 109 <p>The version control systems known by this option are <a class="reference external" href="https://fr.wikipedia.org/wiki/Concurrent_versions_system">CVS</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Apache_Subversion">SVN</a> and <a class="reference external" href="https://git-scm.com">Git</a>.</p>
 110 </li>
 111 </ul>
 112 </div>
 113 <div class="section" id="some-useful-configuration-pathes">
 114 <h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
 115 <p>No specific configuration.</p>
 116 </div>
 117 </div>
 118
 119
 120           </div>
 121         </div>
 122       </div>
 123       <div class="sphinxsidebar">
 124         <div class="sphinxsidebarwrapper">
 125             <p class="logo"><a href="../index.html">
 126               <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
 127             </a></p>
 128   <h3><a href="../index.html">Table Of Contents</a></h3>
 129   <ul>
 130 <li><a class="reference internal" href="#">Command package</a><ul>
 131 <li><a class="reference internal" href="#description">Description</a></li>
 132 <li><a class="reference internal" href="#usage">Usage</a></li>
 133 <li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
 134 </ul>
 135 </li>
 136 </ul>
 137 <div class="relations">
 138 <h3>Related Topics</h3>
 139 <ul>
 140   <li><a href="../index.html">Documentation overview</a><ul>
 141       <li>Previous: <a href="clean.html" title="previous chapter">Command clean</a></li>
 142       <li>Next: <a href="generate.html" title="next chapter">Command generate</a></li>
 143   </ul></li>
 144 </ul>
 145 </div>
 146   <h3>This Page</h3>
 147   <ul class="this-page-menu">
 148     <li><a href="../_sources/commands/package.txt"
 149            rel="nofollow">Show Source</a></li>
 150   </ul>
 151 <div id="searchbox" style="display: none">
 152   <h3>Quick search</h3>
 153     <form class="search" action="../search.html" method="get">
 154       <input type="text" name="q" />
 155       <input type="submit" value="Go" />
 156       <input type="hidden" name="check_keywords" value="yes" />
 157       <input type="hidden" name="area" value="default" />
 158     </form>
 159     <p class="searchtip" style="font-size: 90%">
 160     Enter search terms or a module, class or function name.
 161     </p>
 162 </div>
 163 <script type="text/javascript">$('#searchbox').show(0);</script>
 164         </div>
 165       </div>
 166       <div class="clearer"></div>
 167     </div>
 168     <div class="footer">
 169       &copy;2018, CEA.
 170
 171       |
 172       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
 173       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
 174
 175       |
 176       <a href="../_sources/commands/package.txt"
 177           rel="nofollow">Page source</a>
 178     </div>
 179
 180
 181
 182
 183   </body>
 184 </html>