diff options
author | Alexander Bersenev <bay@hackerdom.ru> | 2011-08-21 15:59:46 +0000 |
---|---|---|
committer | Alexander Bersenev <bay@hackerdom.ru> | 2011-08-21 15:59:46 +0000 |
commit | 1626259059a7b2da817fe6a32126c2eddd14406c (patch) | |
tree | 9a18e84fcec9656cf11baf85abb7ce27f5d4f2ff /docs/build/html/intro.html | |
parent | big code commit in the last day before pencils down date (diff) | |
download | autodep-1626259059a7b2da817fe6a32126c2eddd14406c.tar.gz autodep-1626259059a7b2da817fe6a32126c2eddd14406c.tar.bz2 autodep-1626259059a7b2da817fe6a32126c2eddd14406c.zip |
documentation changes and args parsing fixed
Diffstat (limited to 'docs/build/html/intro.html')
-rw-r--r-- | docs/build/html/intro.html | 65 |
1 files changed, 32 insertions, 33 deletions
diff --git a/docs/build/html/intro.html b/docs/build/html/intro.html index 18e7294..9c2790b 100644 --- a/docs/build/html/intro.html +++ b/docs/build/html/intro.html @@ -55,10 +55,9 @@ <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1> <div class="section" id="overview"> <h2>Overview<a class="headerlink" href="#overview" 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 buildtime and runtime dependency -analysis.</p> -<p>The tool can block an access to files of defined packages.</p> +<p>Auto dependency (autodep) builder is a tool for the analysis of accessed files during +the build of a package. It also can be used for runtime dependencies analysis.</p> +<p>The tool can trace, log and block access to files of given packages.</p> <p>It is released under GNU GPL license.</p> </div> <div class="section" id="status"> @@ -80,49 +79,49 @@ analysis.</p> <dl class="cmdoption"> <dt id="cmdoption-autodep--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-autodep--help" title="Permalink to this definition">¶</a></dt> -<dd><p>show this help message and exit</p> +<dd><p>Show this help message and exit.</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-autodep-b"> <tt class="descname">-b</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--block</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep-b" title="Permalink to this definition">¶</a></dt> -<dd><p>strict mode: deny all access to non-dependency packages</p> +<dd><p>strict mode: Deny all access to files from non-dependency packages.</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-autodep--blockpkgs"> <tt class="descname">--blockpkgs</tt><tt class="descclassname">=PACKAGES</tt><a class="headerlink" href="#cmdoption-autodep--blockpkgs" title="Permalink to this definition">¶</a></dt> -<dd><p>block an access to files from this packages</p> +<dd><p>Block access to files from this packages.</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-autodep-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-autodep-f" title="Permalink to this definition">¶</a></dt> -<dd><p>show accessed files and not founded files</p> +<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-autodep-f" title="Permalink to this definition">¶</a></dt> +<dd><p>Show all files, accessed and missing (not found).</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-autodep-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-autodep-v" title="Permalink to this definition">¶</a></dt> -<dd><p>show non-important packages, show unknown package and unknown stage</p> +<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-autodep-v" title="Permalink to this definition">¶</a></dt> +<dd><p>Show non-important packages, unknown packages and unknown building stages.</p> </dd></dl> <dl class="cmdoption"> -<dt id="cmdoption-autodep-C"> -<tt class="descname">-C</tt><tt class="descclassname"> </tt><tt class="descclassname">, </tt><tt class="descname">--nocolor</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep-C" title="Permalink to this definition">¶</a></dt> -<dd><p>don’t output color</p> +<dt id="cmdoption-autodep--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-autodep--nocolor" title="Permalink to this definition">¶</a></dt> +<dd><p>Don’t colorize output</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-autodep--hooklib"> <tt class="descname">--hooklib</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep--hooklib" title="Permalink to this definition">¶</a></dt> -<dd><p>use ld_preload logging approach(default)</p> +<dd><p>Use LD_PRELOAD logging approach (default).</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-autodep--fusefs"> <tt class="descname">--fusefs</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep--fusefs" title="Permalink to this definition">¶</a></dt> -<dd><p>use fuse logging approach(slow, but reliable)</p> +<dd><p>Use FUSE logging approach (slow, but reliable).</p> </dd></dl> <p>Example: showfsevents.py -b lsof,cowsay emerge bash</p> @@ -138,7 +137,7 @@ analysis.</p> <thead valign="bottom"> <tr><th class="head"> </th> <th class="head">Hooklib</th> -<th class="head">Fusefs</th> +<th class="head">FuseFS</th> </tr> </thead> <tbody valign="top"> @@ -146,11 +145,11 @@ analysis.</p> <td><strong>Any user</strong></td> <td>Only root</td> </tr> -<tr><td>Is approach allows blocking an access to files?</td> +<tr><td>Does approach allows to block access to files?</td> <td><strong>YES</strong></td> <td><strong>YES</strong></td> </tr> -<tr><td>Is overhead in performance big?</td> +<tr><td>Is the overhead in performance noticeable?</td> <td><strong>NO</strong></td> <td>YES <a class="footnote-reference" href="#f1" id="id1">[1]</a></td> </tr> @@ -159,15 +158,16 @@ analysis.</p> <td><strong>ALL</strong></td> </tr> <tr><td>When is it recomended to use an approach?</td> -<td>For analysis +<td>Analysis of <em>buildtime</em> dependencies</td> -<td>For analysis +<td>Analysis of <em>runtime</em> dependencies</td> </tr> -<tr><td>Is any pre-requirements for using an approach?</td> +<tr><td>Are there any pre-requirements +for using an approach?</td> <td><strong>NO</strong></td> <td>FUSE must be enabled in @@ -179,35 +179,34 @@ kernel</td> <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 +<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>FUSE filesystems are slower than a normal one. A Program accesses 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> +<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> -<p class="rubric">1. Get the potential dependencies of a xchat package:</p> -<div class="highlight-none"><div class="highlight"><pre>autodep emerge xchat +<p class="rubric">1. Get the potential dependencies for net-irc/xchat:</p> +<div class="highlight-none"><div class="highlight"><pre>autodep emerge net-irc/xchat </pre></div> </div> -<p class="rubric">2. Get the potential dependencies of a xchat package, blocking +<p class="rubric">2. Get the potential dependencies for net-irc/xchat, blocking x11-misc/util-macros package:</p> -<div class="highlight-none"><div class="highlight"><pre>autodep emerge --block x11-misc/util-macros emerge xchat +<div class="highlight-none"><div class="highlight"><pre>autodep emerge --blockpkgs x11-misc/util-macros emerge net-irc/xchat </pre></div> </div> -<p class="rubric">3. Get the potential dependencies of a xchat package, and show files +<p class="rubric">3. Get the potential dependencies for net-irc/xchat, and show files accessed:</p> -<div class="highlight-none"><div class="highlight"><pre>autodep --files emerge xchat +<div class="highlight-none"><div class="highlight"><pre>autodep --files emerge net-irc/xchat </pre></div> </div> -<p class="rubric">4. Get the runtime dependencies of a xchat and show files -accessed:</p> +<p class="rubric">4. Get the runtime dependencies of a xchat and show accessed files:</p> <div class="highlight-none"><div class="highlight"><pre>autodep --fusefs --files xchat </pre></div> </div> @@ -290,7 +289,7 @@ accessed:</p> </div> <div class="footer"> © Copyright 2011, Alexander Bersenev. - Last updated on Aug 03, 2011. + Last updated on Aug 21, 2011. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. </div> </body> |