Salome HOME
add doc/build for EZ direct html or pdf
[tools/sat.git] / doc / build / html / commands / log.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 log &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 environ" href="environ.html" />
31     <link rel="prev" title="Command application" href="application.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-log">
48 <h1>Command log<a class="headerlink" href="#command-log" 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>log</strong> command displays sat log in a web browser or in a terminal.</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">Show (in a web browser) the log of the commands corresponding to an application:</p>
57 <div class="highlight-python"><pre>sat log &lt;application&gt;</pre>
58 </div>
59 </li>
60 <li><p class="first">Show the log for commands that do not use any application:</p>
61 <div class="highlight-python"><pre>sat log</pre>
62 </div>
63 </li>
64 <li><p class="first">The --terminal (or -t) display the log directly in the terminal, through a <a class="reference external" href="https://en.wikipedia.org/wiki/Command-line_interface">CLI</a> interactive menu:</p>
65 <div class="highlight-python"><pre>sat log &lt;application&gt; --terminal</pre>
66 </div>
67 </li>
68 <li><p class="first">The --last option displays only the last command:</p>
69 <div class="highlight-python"><pre>sat log &lt;application&gt; --last</pre>
70 </div>
71 </li>
72 <li><p class="first">To access the last compilation log in terminal mode, use --last_terminal option:</p>
73 <div class="highlight-python"><pre>sat log &lt;application&gt; --last_terminal</pre>
74 </div>
75 </li>
76 <li><p class="first">The --clean (int) option erases the n older log files and print the number of remaining log files:</p>
77 <div class="highlight-python"><pre>sat log &lt;application&gt; --clean 50</pre>
78 </div>
79 </li>
80 </ul>
81 </div>
82 <div class="section" id="some-useful-configuration-pathes">
83 <h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
84 <ul class="simple">
85 <li><strong>USER</strong><ul>
86 <li><strong>browser</strong> : The browser used to show the log (by default <em>firefox</em>).</li>
87 <li><strong>log_dir</strong> : The directory used to store the log files.</li>
88 </ul>
89 </li>
90 </ul>
91 </div>
92 </div>
93
94
95           </div>
96         </div>
97       </div>
98       <div class="sphinxsidebar">
99         <div class="sphinxsidebarwrapper">
100             <p class="logo"><a href="../index.html">
101               <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
102             </a></p>
103   <h3><a href="../index.html">Table Of Contents</a></h3>
104   <ul>
105 <li><a class="reference internal" href="#">Command log</a><ul>
106 <li><a class="reference internal" href="#description">Description</a></li>
107 <li><a class="reference internal" href="#usage">Usage</a></li>
108 <li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
109 </ul>
110 </li>
111 </ul>
112 <div class="relations">
113 <h3>Related Topics</h3>
114 <ul>
115   <li><a href="../index.html">Documentation overview</a><ul>
116       <li>Previous: <a href="application.html" title="previous chapter">Command application</a></li>
117       <li>Next: <a href="environ.html" title="next chapter">Command environ</a></li>
118   </ul></li>
119 </ul>
120 </div>
121   <h3>This Page</h3>
122   <ul class="this-page-menu">
123     <li><a href="../_sources/commands/log.txt"
124            rel="nofollow">Show Source</a></li>
125   </ul>
126 <div id="searchbox" style="display: none">
127   <h3>Quick search</h3>
128     <form class="search" action="../search.html" method="get">
129       <input type="text" name="q" />
130       <input type="submit" value="Go" />
131       <input type="hidden" name="check_keywords" value="yes" />
132       <input type="hidden" name="area" value="default" />
133     </form>
134     <p class="searchtip" style="font-size: 90%">
135     Enter search terms or a module, class or function name.
136     </p>
137 </div>
138 <script type="text/javascript">$('#searchbox').show(0);</script>
139         </div>
140       </div>
141       <div class="clearer"></div>
142     </div>
143     <div class="footer">
144       &copy;2018, CEA.
145       
146       |
147       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
148       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
149       
150       |
151       <a href="../_sources/commands/log.txt"
152           rel="nofollow">Page source</a>
153     </div>
154
155     
156
157     
158   </body>
159 </html>