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