aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'docs/build/html/man.html')
-rw-r--r--docs/build/html/man.html251
1 files changed, 251 insertions, 0 deletions
diff --git a/docs/build/html/man.html b/docs/build/html/man.html
new file mode 100644
index 0000000..f2b221a
--- /dev/null
+++ b/docs/build/html/man.html
@@ -0,0 +1,251 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>USER COMMANDS &mdash; Autodep documentation</title>
+ <link rel="stylesheet" href="_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '0.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <link rel="top" title="Autodep documentation" href="index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="index.html">Autodep</a> &raquo;</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="user-commands">
+<h1>USER COMMANDS<a class="headerlink" href="#user-commands" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="synopsis">
+<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
+<p><strong>showfsevents.py</strong> [options] &lt;command&gt;</p>
+</div>
+<div class="section" id="description">
+<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>Auto dependency builder is a tool for analysis files accessed during
+building a package. It also can be used for runtime dependencies analysis.</p>
+<p>The tool can block an access to files of defined packages.</p>
+</div>
+<div class="section" id="options">
+<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
+<dl class="cmdoption">
+<dt id="cmdoption-showfsevents.py--help">
+<tt class="descname">--help</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">-h</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-showfsevents.py--help" title="Permalink to this definition">¶</a></dt>
+<dd><p>show this help message and exit</p>
+</dd></dl>
+
+<dl class="cmdoption">
+<dt id="cmdoption-showfsevents.py-b">
+<tt class="descname">-b</tt><tt class="descclassname"> PACKAGES</tt><tt class="descclassname">, </tt><tt class="descname">--block</tt><tt class="descclassname">=PACKAGES</tt><a class="headerlink" href="#cmdoption-showfsevents.py-b" title="Permalink to this definition">¶</a></dt>
+<dd><p>block an access to files from this packages</p>
+</dd></dl>
+
+<dl class="cmdoption">
+<dt id="cmdoption-showfsevents.py-f">
+<tt class="descname">-f</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--files</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-showfsevents.py-f" title="Permalink to this definition">¶</a></dt>
+<dd><p>show accessed files and not founded files</p>
+</dd></dl>
+
+<dl class="cmdoption">
+<dt id="cmdoption-showfsevents.py-v">
+<tt class="descname">-v</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--verbose</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-showfsevents.py-v" title="Permalink to this definition">¶</a></dt>
+<dd><p>show non-important packages, show unknown package and unknown stage</p>
+</dd></dl>
+
+<dl class="cmdoption">
+<dt id="cmdoption-showfsevents.py--nocolor">
+<tt class="descname">--nocolor</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">-C</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-showfsevents.py--nocolor" title="Permalink to this definition">¶</a></dt>
+<dd><p>don&#8217;t output color</p>
+</dd></dl>
+
+<dl class="cmdoption">
+<dt id="cmdoption-showfsevents.py--hooklib">
+<tt class="descname">--hooklib</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-showfsevents.py--hooklib" title="Permalink to this definition">¶</a></dt>
+<dd><p>use ld_preload logging approach(default)</p>
+</dd></dl>
+
+<dl class="cmdoption">
+<dt id="cmdoption-showfsevents.py--fusefs">
+<tt class="descname">--fusefs</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-showfsevents.py--fusefs" title="Permalink to this definition">¶</a></dt>
+<dd><p>use fuse logging approach(slow, but reliable)</p>
+</dd></dl>
+
+</div>
+<div class="section" id="hooklib-vs-fusefs">
+<h2>HOOKLIB VS FUSEFS<a class="headerlink" href="#hooklib-vs-fusefs" title="Permalink to this headline">¶</a></h2>
+<table border="1" class="docutils">
+<colgroup>
+<col width="63%" />
+<col width="17%" />
+<col width="20%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">&nbsp;</th>
+<th class="head">Hooklib</th>
+<th class="head">Fusefs</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>Who can use this approach?</td>
+<td><strong>Any user</strong></td>
+<td>Only root</td>
+</tr>
+<tr><td>Is approach allows blocking an access to files?</td>
+<td><strong>YES</strong></td>
+<td><strong>YES</strong></td>
+</tr>
+<tr><td>Is overhead in performance big?</td>
+<td><strong>NO</strong></td>
+<td>YES <a class="footnote-reference" href="#f1" id="id1">[1]</a></td>
+</tr>
+<tr><td>What events are logged?</td>
+<td>Most <a class="footnote-reference" href="#f2" id="id2">[2]</a></td>
+<td><strong>ALL</strong></td>
+</tr>
+<tr><td>When is it recomended to use an approach?</td>
+<td>For analysis
+of
+<em>buildtime</em>
+dependencies</td>
+<td>For analysis
+of <em>runtime</em>
+dependencies</td>
+</tr>
+<tr><td>Is any pre-requirements for using an approach?</td>
+<td><strong>NO</strong></td>
+<td>FUSE must be
+enabled in
+kernel</td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Notes</p>
+<table class="docutils footnote" frame="void" id="f1" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>Fuse file system is slower than normal one. Program reads many files
+while launching, so this will take more time than usual.</td></tr>
+</tbody>
+</table>
+<table class="docutils footnote" frame="void" id="f2" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>Loading of dynamic libraries and direct syscalls will not be logged.</td></tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="examples">
+<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="get-the-potential-dependencies-of-a-xchat-package">
+<h3>Get the potential dependencies of a xchat package:<a class="headerlink" href="#get-the-potential-dependencies-of-a-xchat-package" title="Permalink to this headline">¶</a></h3>
+<p>showfsevents.py emerge xchat</p>
+</div>
+<div class="section" id="get-the-potential-dependencies-of-a-xchat-package-blocking-x11-misc-util-macros-package">
+<h3>Get the potential dependencies of a xchat package, blocking x11-misc/util-macros package:<a class="headerlink" href="#get-the-potential-dependencies-of-a-xchat-package-blocking-x11-misc-util-macros-package" title="Permalink to this headline">¶</a></h3>
+<p>showfsevents.py emerge &#8211;block x11-misc/util-macros emerge xchat</p>
+</div>
+<div class="section" id="get-the-potential-dependencies-of-a-xchat-package-and-show-files-accessed">
+<h3>Get the potential dependencies of a xchat package, and show files accessed:<a class="headerlink" href="#get-the-potential-dependencies-of-a-xchat-package-and-show-files-accessed" title="Permalink to this headline">¶</a></h3>
+<p>showfsevents.py &#8211;files emerge xchat</p>
+</div>
+<div class="section" id="get-the-runtime-dependencies-of-a-xchat-and-show-files-accessed">
+<h3>Get the runtime dependencies of a xchat and show files accessed:<a class="headerlink" href="#get-the-runtime-dependencies-of-a-xchat-and-show-files-accessed" title="Permalink to this headline">¶</a></h3>
+<p>showfsevents.py &#8211;fusefs &#8211;files xchat</p>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">USER COMMANDS</a><ul>
+<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
+<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
+<li><a class="reference internal" href="#options">OPTIONS</a></li>
+<li><a class="reference internal" href="#hooklib-vs-fusefs">HOOKLIB VS FUSEFS</a></li>
+<li><a class="reference internal" href="#examples">Examples</a><ul>
+<li><a class="reference internal" href="#get-the-potential-dependencies-of-a-xchat-package">Get the potential dependencies of a xchat package:</a></li>
+<li><a class="reference internal" href="#get-the-potential-dependencies-of-a-xchat-package-blocking-x11-misc-util-macros-package">Get the potential dependencies of a xchat package, blocking x11-misc/util-macros package:</a></li>
+<li><a class="reference internal" href="#get-the-potential-dependencies-of-a-xchat-package-and-show-files-accessed">Get the potential dependencies of a xchat package, and show files accessed:</a></li>
+<li><a class="reference internal" href="#get-the-runtime-dependencies-of-a-xchat-and-show-files-accessed">Get the runtime dependencies of a xchat and show files accessed:</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/man.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="index.html">Autodep</a> &raquo;</li>
+ </ul>
+ </div>
+ <div class="footer">
+ &copy; Copyright 2011, Alexander Bersenev.
+ Last updated on Jul 25, 2011.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
+ </div>
+ </body>
+</html> \ No newline at end of file