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