doc/build/html/commands/config.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>Command config &#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 prepare" href="prepare.html" />
  20     <link rel="prev" title="Command doc" href="doc.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="command-config">
  36 <h1>Command config<a class="headerlink" href="#command-config" title="Permalink to this headline">¶</a></h1>
  37 <div class="section" id="description">
  38 <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
  39 <p>The <strong>config</strong> command manages sat configuration.
  40 It allows display, manipulation and operation on configuration files</p>
  41 </div>
  42 <div class="section" id="usage">
  43 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
  44 <ul>
  45 <li><p class="first">Edit the user personal configuration file <code class="docutils literal notranslate"><span class="pre">$HOME/.salomeTools/SAT.pyconf</span></code>. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:</p>
  46 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o">--</span><span class="n">edit</span>
  47 </pre></div>
  48 </div>
  49 </li>
  50 <li><p class="first">List the available applications (they come from the sat projects defined in <code class="docutils literal notranslate"><span class="pre">data/local.pyconf</span></code>:</p>
  51 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o">--</span><span class="nb">list</span>
  52 </pre></div>
  53 </div>
  54 </li>
  55 <li><p class="first">Edit the configuration of an application:</p>
  56 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">edit</span>
  57 </pre></div>
  58 </div>
  59 </li>
  60 <li><p class="first">Copy an application configuration file into the user personal directory:</p>
  61 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">copy</span> <span class="p">[</span><span class="n">new_name</span><span class="p">]</span>
  62 </pre></div>
  63 </div>
  64 </li>
  65 <li><div class="first line-block">
  66 <div class="line">Print the value of a configuration parameter.</div>
  67 <div class="line">Use the automatic completion to get recursively the parameter names.</div>
  68 <div class="line">Use <em>–no_label</em> option to get <em>only</em> the value, <em>without</em> label (useful in automatic scripts).</div>
  69 <div class="line">Examples (with <em>SALOME-xx</em> as <em>SALOME-8.4.0</em> ):</div>
  70 </div>
  71 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># sat config --value &lt;parameter_path&gt;</span>
  72 sat config --value .         <span class="c1"># all the configuration</span>
  73 sat config --value LOCAL
  74 sat config --value LOCAL.workdir
  75
  76 <span class="c1"># sat config &lt;application&gt; --value &lt;parameter_path&gt;</span>
  77 sat config SALOME-xx --value APPLICATION.workdir
  78 sat config SALOME-xx --no_label --value APPLICATION.workdir
  79 </pre></div>
  80 </div>
  81 </li>
  82 <li><div class="first line-block">
  83 <div class="line">Print in one-line-by-value mode the value of a configuration parameter,</div>
  84 <div class="line">with its source <em>expression</em>, if any.</div>
  85 <div class="line">This is a debug mode, useful for developers.</div>
  86 <div class="line">Prints the parameter path, the source expression if any, and the final value:</div>
  87 </div>
  88 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">-</span><span class="n">g</span> <span class="n">USER</span>
  89 </pre></div>
  90 </div>
  91 <div class="admonition note">
  92 <p class="first admonition-title">Note</p>
  93 <p>And so, <em>not only for fun</em>, to get <strong>all expressions</strong> of configuration</p>
  94 <div class="last highlight-bash notranslate"><div class="highlight"><pre><span></span>sat config SALOME-xx -g . <span class="p">|</span> grep -e <span class="s2">&quot;--&gt;&quot;</span>
  95 </pre></div>
  96 </div>
  97 </div>
  98 </li>
  99 <li><p class="first">Print the patches that are applied:</p>
 100 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">--</span><span class="n">show_patchs</span>
 101 </pre></div>
 102 </div>
 103 </li>
 104 <li><p class="first">Get information on a product configuration:</p>
 105 </li>
 106 </ul>
 107 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># sat config &lt;application&gt; --info &lt;product&gt;</span>
 108 sat config SALOME-xx --info KERNEL
 109 sat config SALOME-xx --info qt
 110 </pre></div>
 111 </div>
 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>Exploring a current configuration.</p>
 116 <ul class="simple">
 117 <li><strong>PATHS</strong>: To get list of directories where to find files.</li>
 118 <li><strong>USER</strong>: To get user preferences (editor, pdf viewer, web browser, default working dir).</li>
 119 </ul>
 120 <p>sat commands:</p>
 121 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">-</span><span class="n">v</span> <span class="n">PATHS</span>
 122 <span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">-</span><span class="n">v</span> <span class="n">USERS</span>
 123 </pre></div>
 124 </div>
 125 </div>
 126 </div>
 127
 128
 129           </div>
 130         </div>
 131       </div>
 132       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 133         <div class="sphinxsidebarwrapper">
 134             <p class="logo"><a href="../index.html">
 135               <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
 136             </a></p>
 137   <h3><a href="../index.html">Table Of Contents</a></h3>
 138   <ul>
 139 <li><a class="reference internal" href="#">Command config</a><ul>
 140 <li><a class="reference internal" href="#description">Description</a></li>
 141 <li><a class="reference internal" href="#usage">Usage</a></li>
 142 <li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
 143 </ul>
 144 </li>
 145 </ul>
 146 <div class="relations">
 147 <h3>Related Topics</h3>
 148 <ul>
 149   <li><a href="../index.html">Documentation overview</a><ul>
 150       <li>Previous: <a href="doc.html" title="previous chapter">Command doc</a></li>
 151       <li>Next: <a href="prepare.html" title="next chapter">Command prepare</a></li>
 152   </ul></li>
 153 </ul>
 154 </div>
 155   <div role="note" aria-label="source link">
 156     <h3>This Page</h3>
 157     <ul class="this-page-menu">
 158       <li><a href="../_sources/commands/config.rst.txt"
 159             rel="nofollow">Show Source</a></li>
 160     </ul>
 161    </div>
 162 <div id="searchbox" style="display: none" role="search">
 163   <h3>Quick search</h3>
 164     <div class="searchformwrapper">
 165     <form class="search" action="../search.html" method="get">
 166       <input type="text" name="q" />
 167       <input type="submit" value="Go" />
 168       <input type="hidden" name="check_keywords" value="yes" />
 169       <input type="hidden" name="area" value="default" />
 170     </form>
 171     </div>
 172 </div>
 173 <script type="text/javascript">$('#searchbox').show(0);</script>
 174         </div>
 175       </div>
 176       <div class="clearer"></div>
 177     </div>
 178     <div class="footer">
 179       &copy;2018, CEA.
 180
 181       |
 182       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.3</a>
 183       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 184
 185       |
 186       <a href="../_sources/commands/config.rst.txt"
 187           rel="nofollow">Page source</a>
 188     </div>
 189
 190
 191
 192
 193   </body>
 194 </html>