ruby-vpi 9.0.0 → 10.0.0

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-vpi
 version: !ruby/object:Gem::Version 
-  version: 9.0.0
-date: 2006-10-28 00:00:00 -07:00
+  version: 10.0.0
+date: 2006-11-05 00:00:00 -08:00
 summary: Ruby interface to Verilog VPI.
 require_paths: 
 - lib
@@ -42,7 +42,6 @@ files:
 - samp
 - style.css
 - gem_extconf.rb
-- ref
 - header.html
 - header.part.html
 - readme.html
@@ -122,20 +121,21 @@ files:
 - doc/problems.html
 - doc/problems.ruby.html
 - doc/problems.vsim.html
+- doc/setup.html
+- doc/setup.installation.html
+- doc/setup.maintenance.html
+- doc/setup.reqs.html
 - doc/usage.examples.html
 - doc/usage.html
-- doc/usage.installation.html
-- doc/usage.recommendations.html
-- doc/usage.requirements.html
 - doc/usage.tools.html
 - doc/usage.tutorial.html
 - doc/manual.txt
 - doc/src/license.xml
 - doc/src/LICENSE
+- doc/src/manual.xml
 - doc/src/shared.dtd
 - doc/src/figures.dia
 - doc/src/manual.xsl
-- doc/src/manual.xml
 - doc/figures/ruby_init.png
 - doc/figures/ruby_relay.png
 - doc/figures/organization.png
@@ -209,243 +209,9 @@ files:
 - samp/counter/counter_xunit_spec.rb
 - samp/counter/counter_rspec_bench.rb
 - samp/counter/counter_xunit_proto.rb
-- samp/counter/counter_rspec_bench.v
 - samp/counter/counter_rspec_design.rb
+- samp/counter/counter_rspec_bench.v
 - samp/counter/counter_rspec_runner.rake
-- ref/c
-- ref/ruby
-- ref/c/doxygen.png
-- ref/c/tab_b.gif
-- ref/c/tab_l.gif
-- ref/c/tab_r.gif
-- ref/c/tabs.css
-- ref/c/doxygen.css
-- ref/c/index.html
-- ref/c/common_8h.html
-- ref/c/relay_8c.html
-- ref/c/relay_8h.html
-- ref/c/swig_8c.html
-- ref/c/swig_8h.html
-- ref/c/verilog_8h.html
-- ref/c/vlog_8c.html
-- ref/c/vlog_8h.html
-- ref/c/vpi__user_8h.html
-- ref/c/annotated.html
-- ref/c/functions.html
-- ref/c/functions_vars.html
-- ref/c/structrelay____RubyOptions____def.html
-- ref/c/structt__cb__data.html
-- ref/c/structt__vpi__delay.html
-- ref/c/structt__vpi__error__info.html
-- ref/c/structt__vpi__strengthval.html
-- ref/c/structt__vpi__systf__data.html
-- ref/c/structt__vpi__time.html
-- ref/c/structt__vpi__value.html
-- ref/c/structt__vpi__vecval.html
-- ref/c/structt__vpi__vlog__info.html
-- ref/c/files.html
-- ref/c/globals.html
-- ref/c/globals_0x63.html
-- ref/c/globals_0x65.html
-- ref/c/globals_0x66.html
-- ref/c/globals_0x70.html
-- ref/c/globals_0x72.html
-- ref/c/globals_0x73.html
-- ref/c/globals_0x74.html
-- ref/c/globals_0x76.html
-- ref/c/globals_0x78.html
-- ref/c/globals_func.html
-- ref/c/globals_vars.html
-- ref/c/globals_type.html
-- ref/c/globals_enum.html
-- ref/c/globals_eval.html
-- ref/c/globals_defs.html
-- ref/c/globals_defs_0x65.html
-- ref/c/globals_defs_0x70.html
-- ref/c/globals_defs_0x76.html
-- ref/c/globals_defs_0x78.html
-- ref/ruby/created.rid
-- ref/ruby/rdoc-style.css
-- ref/ruby/files
-- ref/ruby/classes
-- ref/ruby/fr_file_index.html
-- ref/ruby/fr_class_index.html
-- ref/ruby/fr_method_index.html
-- ref/ruby/index.html
-- ref/ruby/files/bin
-- ref/ruby/files/lib
-- ref/ruby/files/bin/generate_test_rb.src
-- ref/ruby/files/bin/generate_test_rb.html
-- ref/ruby/files/bin/header_to_ruby_rb.html
-- ref/ruby/files/bin/generate_test_rb.src/M000001.html
-- ref/ruby/files/bin/generate_test_rb.src/M000002.html
-- ref/ruby/files/lib/ruby-vpi
-- ref/ruby/files/lib/ruby-vpi_rb.html
-- ref/ruby/files/lib/ruby-vpi/runner_rb.src
-- ref/ruby/files/lib/ruby-vpi/erb_rb.html
-- ref/ruby/files/lib/ruby-vpi/rake_rb.html
-- ref/ruby/files/lib/ruby-vpi/rspec_rb.html
-- ref/ruby/files/lib/ruby-vpi/runner_rb.html
-- ref/ruby/files/lib/ruby-vpi/integer_rb.html
-- ref/ruby/files/lib/ruby-vpi/rdoc_rb.html
-- ref/ruby/files/lib/ruby-vpi/runner_proxy_rb.html
-- ref/ruby/files/lib/ruby-vpi/rcov_rb.html
-- ref/ruby/files/lib/ruby-vpi/xx_rb.html
-- ref/ruby/files/lib/ruby-vpi/vpi_rb.html
-- ref/ruby/files/lib/ruby-vpi/verilog_parser_rb.html
-- ref/ruby/files/lib/ruby-vpi/runner_rb.src/M000003.html
-- ref/ruby/files/lib/ruby-vpi/runner_rb.src/M000004.html
-- ref/ruby/classes/VerilogParser.src
-- ref/ruby/classes/VerilogParser
-- ref/ruby/classes/Integer.src
-- ref/ruby/classes/Table.src
-- ref/ruby/classes/OutputInfo.src
-- ref/ruby/classes/Template.src
-- ref/ruby/classes/String.src
-- ref/ruby/classes/ERB.src
-- ref/ruby/classes/XX
-- ref/ruby/classes/SWIG
-- ref/ruby/classes/FileUtils.src
-- ref/ruby/classes/RubyVpi.src
-- ref/ruby/classes/RDoc.src
-- ref/ruby/classes/VerilogParser.html
-- ref/ruby/classes/Integer.html
-- ref/ruby/classes/Table.html
-- ref/ruby/classes/OutputInfo.html
-- ref/ruby/classes/Template.html
-- ref/ruby/classes/String.html
-- ref/ruby/classes/ERB.html
-- ref/ruby/classes/XX.html
-- ref/ruby/classes/SWIG.html
-- ref/ruby/classes/FileUtils.html
-- ref/ruby/classes/RubyVpi.html
-- ref/ruby/classes/RubyVpi
-- ref/ruby/classes/RDoc.html
-- ref/ruby/classes/VerilogParser.src/M000005.html
-- ref/ruby/classes/VerilogParser/Module.src
-- ref/ruby/classes/VerilogParser/Module
-- ref/ruby/classes/VerilogParser/Module.html
-- ref/ruby/classes/VerilogParser/Module.src/M000006.html
-- ref/ruby/classes/VerilogParser/Module/Port.src
-- ref/ruby/classes/VerilogParser/Module/Parameter.src
-- ref/ruby/classes/VerilogParser/Module/Port.html
-- ref/ruby/classes/VerilogParser/Module/Parameter.html
-- ref/ruby/classes/VerilogParser/Module/Port.src/M000007.html
-- ref/ruby/classes/VerilogParser/Module/Port.src/M000008.html
-- ref/ruby/classes/VerilogParser/Module/Port.src/M000009.html
-- ref/ruby/classes/VerilogParser/Module/Port.src/M000010.html
-- ref/ruby/classes/VerilogParser/Module/Parameter.src/M000011.html
-- ref/ruby/classes/Integer.src/M000012.html
-- ref/ruby/classes/Integer.src/M000013.html
-- ref/ruby/classes/Integer.src/M000014.html
-- ref/ruby/classes/Integer.src/M000015.html
-- ref/ruby/classes/Integer.src/M000016.html
-- ref/ruby/classes/Integer.src/M000017.html
-- ref/ruby/classes/Integer.src/M000020.html
-- ref/ruby/classes/Integer.src/M000021.html
-- ref/ruby/classes/Integer.src/M000022.html
-- ref/ruby/classes/Integer.src/M000023.html
-- ref/ruby/classes/Integer.src/M000024.html
-- ref/ruby/classes/Integer.src/M000025.html
-- ref/ruby/classes/Table.src/M000026.html
-- ref/ruby/classes/Table.src/M000027.html
-- ref/ruby/classes/Table.src/M000028.html
-- ref/ruby/classes/Table.src/M000029.html
-- ref/ruby/classes/OutputInfo.src/M000030.html
-- ref/ruby/classes/Template.src/M000031.html
-- ref/ruby/classes/String.src/M000032.html
-- ref/ruby/classes/String.src/M000033.html
-- ref/ruby/classes/ERB.src/M000034.html
-- ref/ruby/classes/XX/XML.src
-- ref/ruby/classes/XX/HTML4.src
-- ref/ruby/classes/XX/HTML4
-- ref/ruby/classes/XX/XHTML.src
-- ref/ruby/classes/XX/XHTML
-- ref/ruby/classes/XX/XMLish.src
-- ref/ruby/classes/XX/Markup.src
-- ref/ruby/classes/XX/Markup
-- ref/ruby/classes/XX/Document.src
-- ref/ruby/classes/XX/XML.html
-- ref/ruby/classes/XX/HTML4.html
-- ref/ruby/classes/XX/XHTML.html
-- ref/ruby/classes/XX/XMLish.html
-- ref/ruby/classes/XX/Markup.html
-- ref/ruby/classes/XX/Document.html
-- ref/ruby/classes/XX/XML.src/M000035.html
-- ref/ruby/classes/XX/HTML4.src/M000036.html
-- ref/ruby/classes/XX/HTML4/Transitional.src
-- ref/ruby/classes/XX/HTML4/Strict.src
-- ref/ruby/classes/XX/HTML4/Transitional.html
-- ref/ruby/classes/XX/HTML4/Strict.html
-- ref/ruby/classes/XX/HTML4/Transitional.src/M000037.html
-- ref/ruby/classes/XX/HTML4/Strict.src/M000038.html
-- ref/ruby/classes/XX/XHTML.src/M000039.html
-- ref/ruby/classes/XX/XHTML/Transitional.src
-- ref/ruby/classes/XX/XHTML/Strict.src
-- ref/ruby/classes/XX/XHTML/Transitional.html
-- ref/ruby/classes/XX/XHTML/Strict.html
-- ref/ruby/classes/XX/XHTML/Transitional.src/M000040.html
-- ref/ruby/classes/XX/XHTML/Strict.src/M000041.html
-- ref/ruby/classes/XX/XMLish.src/M000042.html
-- ref/ruby/classes/XX/Markup.src/M000043.html
-- ref/ruby/classes/XX/Markup/ClassMethods.src
-- ref/ruby/classes/XX/Markup/InstanceMethods.src
-- ref/ruby/classes/XX/Markup/ClassMethods.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.html
-- ref/ruby/classes/XX/Markup/Error.html
-- ref/ruby/classes/XX/Markup/ClassMethods.src/M000044.html
-- ref/ruby/classes/XX/Markup/ClassMethods.src/M000045.html
-- ref/ruby/classes/XX/Markup/ClassMethods.src/M000046.html
-- ref/ruby/classes/XX/Markup/ClassMethods.src/M000047.html
-- ref/ruby/classes/XX/Markup/ClassMethods.src/M000048.html
-- ref/ruby/classes/XX/Markup/ClassMethods.src/M000049.html
-- ref/ruby/classes/XX/Markup/ClassMethods.src/M000050.html
-- ref/ruby/classes/XX/Markup/ClassMethods.src/M000051.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000052.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000053.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000054.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000055.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000056.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000057.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000058.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000059.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000060.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000061.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000062.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000063.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000064.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000065.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000066.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000067.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000068.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000069.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000070.html
-- ref/ruby/classes/XX/Markup/InstanceMethods.src/M000071.html
-- ref/ruby/classes/XX/Document.src/M000072.html
-- ref/ruby/classes/XX/Document.src/M000073.html
-- ref/ruby/classes/XX/Document.src/M000074.html
-- ref/ruby/classes/XX/Document.src/M000075.html
-- ref/ruby/classes/XX/Document.src/M000076.html
-- ref/ruby/classes/XX/Document.src/M000077.html
-- ref/ruby/classes/XX/Document.src/M000078.html
-- ref/ruby/classes/XX/Document.src/M000079.html
-- ref/ruby/classes/XX/Document.src/M000080.html
-- ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src
-- ref/ruby/classes/SWIG/TYPE_p_unsigned_int.html
-- ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000081.html
-- ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000082.html
-- ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000083.html
-- ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000084.html
-- ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000085.html
-- ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000086.html
-- ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000087.html
-- ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000088.html
-- ref/ruby/classes/FileUtils.src/M000089.html
-- ref/ruby/classes/FileUtils.src/M000090.html
-- ref/ruby/classes/RubyVpi.src/M000091.html
-- ref/ruby/classes/RubyVpi.src/M000092.html
-- ref/ruby/classes/RDoc.src/M000093.html
-- ref/ruby/classes/RubyVpi/Config.html
 test_files: []
 
 rdoc_options: []

data/doc/usage.installation.html

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!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>Installation and maintenance</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="usage.html" title="Chapter 3. Usage" /><link rel="prev" href="usage.recommendations.html" title="Recommendations" /><link rel="next" href="usage.tools.html" title="Tools" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Installation and maintenance</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="usage.recommendations.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 3. Usage</th><td width="20%" align="right"> <a accesskey="n" href="usage.tools.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="usage.installation"></a>Installation and maintenance</h2></div></div></div><p>Once you have satisfied the <a href="usage.requirements.html" title="Requirements">necessary requirements</a>, you can install <span class="application">Ruby-VPI</span> by running the command <span><strong class="command">gem <span class="action">install</span> <em class="replaceable"><code>ruby-vpi</code></em></strong></span>. RubyGems will install <span class="application">Ruby-VPI</span> into the system gem directory, whose path can be determined by running the command <span><strong class="command">gem <span class="action">env</span> <em class="replaceable"><code>gemdir</code></em></strong></span>. Within this directory, there is a "gems" subdirectory which contains the <span class="application">Ruby-VPI</span> installation, as illustrated below.</p><pre class="screen">
-<code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">gem <span class="action">env</span> <em class="replaceable"><code>gemdir</code></em></strong></span></code></strong>
-<code class="computeroutput">/usr/lib/ruby/gems/1.8</code>
-
-<code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">ls <code class="option">-d</code> <em class="replaceable"><code>/usr/lib/ruby/gems/1.8</code></em>/gems/ruby-vpi-*</strong></span></code></strong>
-<code class="computeroutput">/usr/lib/ruby/gems/1.8/gems/ruby-vpi-7.0.0/</code>
-</pre><p>You can uninstall <span class="application">Ruby-VPI</span> by running the command <span><strong class="command">gem <span class="action">uninstall</span> <em class="replaceable"><code>ruby-vpi</code></em></strong></span>. Furthermore, you can upgrade to the latest release of <span class="application">Ruby-VPI</span> by running the command <span><strong class="command">gem <span class="action">update</span> <em class="replaceable"><code>ruby-vpi</code></em></strong></span>. Finally, you can learn more about using and manipulating RubyGems in <a href="http://www.rubygems.org" target="_top">the RubyGems user manual</a>.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="usage.installation.windows"></a>Installing on Windows</h3></div></div></div><div class="procedure"><ol type="1"><li><p>Install <a href="http://www.cygwin.com" target="_top">Cygwin</a>, the Linux-like environment for Windows.</p></li><li><p>Search for object files whose names end with <code class="filename">.so</code>, <code class="filename">.o</code>, or <code class="filename">.dll</code> in your Verilog simulator's installation directory.</p></li><li><p>Determine which object files, among those found in the previous step, contain symbols whose names begin with <span class="symbol">_vpi</span><sup>[<a id="id2528184" href="#ftn.id2528184">1</a>]</sup> by running the command <span><strong class="command">for x in *.{o,so,dll}; do nm $x | grep -q '[Tt] _vpi' &gt; /dev/null &amp;&amp; echo $x; done</strong></span> in Cygwin.</p><p>If you are using Mentor Modelsim, the desired object file can be found at a path similar to <code class="filename">C:\Modeltech\win32\libvsim.dll</code>.</p><p>If you are using GPL Cver, the desired object file can be found at a path similar to <code class="filename">C:\gplcver\objs\v_vpi.o</code>.</p></li><li><p>Assign the path of the object file (determined in the previous step) to the <code class="varname">LDFLAGS</code> environment variable. For example, if the object file's path is <em class="replaceable"><code>/life/long/journey</code></em>, then you would run the command <span><strong class="command">export <code class="varname">LDFLAGS</code>=<em class="replaceable"><code>/life/long/journey</code></em></strong></span> in Cygwin.</p></li><li><p>You may now install <span class="application">Ruby-VPI</span> by running the command <span><strong class="command">gem <span class="action">install</span> <em class="replaceable"><code>ruby-vpi</code></em></strong></span> in Cygwin.</p></li></ol></div></div><div class="footnotes"><br /><hr width="100" align="left" /><div class="footnote"><p><sup>[<a id="ftn.id2528184" href="#id2528184">1</a>] </sup>Because <span class="application">Ruby-VPI</span> makes use of the Verilog <span class="acronym">VPI</span> C-language interface, it links to symbols whose names begin with <span class="symbol">_vpi</span>. It is possible for these symbols to be undefined when <span class="application">Ruby-VPI</span> is compiled under GNU/Linux and similar operating systems. In contrast, one <a href="http://sourceware.org/ml/cygwin/2001-12/msg01292.html" target="_top">cannot compile a shared object file with references to undefined symbols under Windows</a>. Thus, we must find a Verilog simulator's shared object file, which contains definitions of all <span class="acronym">VPI</span> symbols, and give this file to the linker when compiling <span class="application">Ruby-VPI</span>.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="usage.recommendations.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="usage.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="usage.tools.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Recommendations </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Tools</td></tr></table></div></body></html>

data/doc/usage.recommendations.html

@@ -1,3 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!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>Recommendations</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="usage.html" title="Chapter 3. Usage" /><link rel="prev" href="usage.requirements.html" title="Requirements" /><link rel="next" href="usage.installation.html" title="Installation and maintenance" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Recommendations</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="usage.requirements.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 3. Usage</th><td width="20%" align="right"> <a accesskey="n" href="usage.installation.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="usage.recommendations"></a>Recommendations</h2></div></div></div><p>The following software may make your interactions with <span class="application">Ruby-VPI</span> more pleasant.</p><div class="variablelist"><dl><dt><span class="term">Text merging tool</span></dt><dd><p>An <span class="emphasis"><em>interactive</em></span> text merging tool can greatly simplify the process of transferring wanted changes from one file to another. In particular, such tools are especially beneficial when using the <a href="usage.tools.html#usage.tools.generate-test" title="Automated test generation">automated test generator</a>. Below are a list of popular text merging tools.</p><div class="variablelist"><dl><dt><span class="term"><a href="http://elonen.iki.fi/code/imediff/" target="_top">imediff2</a></span></dt><dd><p>A textual, fullscreen two-way merging tool, which works in a terminal. Useful when working remotely via SSH.</p></dd><dt><span class="term"><a href="http://kdiff3.sourceforge.net/" target="_top">kdiff3</a></span></dt><dd><p>A graphical, three-way merging tool for KDE.</p></dd><dt><span class="term"><a href="http://meld.sourceforge.net/" target="_top">meld</a></span></dt><dd><p>A graphical, three-way merging tool for GNOME.</p></dd><dt><span class="term"><a href="http://tkdiff.sourceforge.net/" target="_top">tkdiff</a></span></dt><dd><p>A graphical, two-way merging tool that uses the cross-platform Tk windowing toolkit.</p></dd><dt><span class="term"><a href="http://furius.ca/xxdiff/" target="_top">xxdiff</a></span></dt><dd><p>A graphical, three-way merging tool.</p></dd></dl></div></dd></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="usage.requirements.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="usage.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="usage.installation.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Requirements </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Installation and maintenance</td></tr></table></div></body></html>

data/doc/usage.requirements.html

@@ -1,3 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!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>Requirements</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="usage.html" title="Chapter 3. Usage" /><link rel="prev" href="usage.html" title="Chapter 3. Usage" /><link rel="next" href="usage.recommendations.html" title="Recommendations" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Requirements</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="usage.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 3. Usage</th><td width="20%" align="right"> <a accesskey="n" href="usage.recommendations.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="usage.requirements"></a>Requirements</h2></div></div></div><p>The following software is necessary in order to use <span class="application">Ruby-VPI</span>.</p><div class="variablelist"><dl><dt><span class="term">Verilog simulator</span></dt><dd><p><span class="application">Ruby-VPI</span> is known to work with the following simulators. Nevertheless, you should be able to use it with any Verilog simulator that supports <span class="acronym">VPI</span>.</p><div class="variablelist"><dl><dt><span class="term"><a href="http://www.icarus.com/eda/Verilog/" target="_top">Icarus Verilog</a></span></dt><dd><p>Version 0.8 or newer is acceptable.</p></dd><dt><span class="term"><a href="http://www.pragmatic-c.com/gpl-cver/" target="_top">GPL Cver</a></span></dt><dd><p>Version 2.11a or newer is acceptable.</p></dd><dt><span class="term"><a href="http://www.synopsys.com/products/simulation/simulation.html" target="_top">Synopsys VCS</a></span></dt><dd><p>Any version that supports the <code class="option">-load</code> option is acceptable.</p></dd><dt><span class="term"><a href="http://www.model.com" target="_top">Mentor Modelsim</a></span></dt><dd><p>Any version that supports the <code class="option">-pli</code> option is acceptable.</p></dd></dl></div></dd><dt><span class="term"><span><strong class="command">make</strong></span></span></dt><dd><p><a href="http://www.gnu.org/software/make/" target="_top"><span class="acronym">GNU</span> make</a> is preferred but any distribution of <span><strong class="command">make</strong></span> should be acceptable.</p></dd><dt><span class="term">C compiler</span></dt><dd><p><a href="http://www.gnu.org/software/gcc/" target="_top"><span class="acronym">GNU</span> Compiler Collection (<span class="acronym">GCC</span>)</a> is preferred but any C compiler should be acceptable.</p></dd><dt><span class="term"><a href="http://en.wikipedia.org/wiki/Pthreads" target="_top"><span class="acronym">POSIX</span> threads (pthreads)</a></span></dt><dd><p>Header and linkable object files, and operating system support for this library are necessary.</p></dd><dt><span class="term"><a href="http://www.ruby-lang.org" target="_top">Ruby</a></span></dt><dd><p>Version 1.8 or newer, including header and linkable object files for building extensions, is necessary. You can install Ruby by following <a href="http://www.rubygarden.org/faq/section/show/3" target="_top">these instructions</a>.</p></dd><dt><span class="term"><a href="http://rubyforge.org/frs/?group_id=126" target="_top">RubyGems</a></span></dt><dd><p>Any recent version should be acceptable. You can install RubyGems by following <a href="http://www.rubygems.org/read/chapter/3" target="_top">these instructions</a>.</p></dd></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="usage.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="usage.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="usage.recommendations.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 3. Usage </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Recommendations</td></tr></table></div></body></html>

data/ref/c/annotated.html

@@ -1,35 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>Ruby-VPI: Data Structures</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-<link href="tabs.css" rel="stylesheet" type="text/css">
-</head><body>
-<!-- Generated by Doxygen 1.4.7 -->
-<div class="tabs">
-  <ul>
-    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
-    <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
-    <li><a href="files.html"><span>Files</span></a></li>
-  </ul></div>
-<div class="tabs">
-  <ul>
-    <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
-    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
-  </ul></div>
-<h1>Ruby-VPI Data Structures</h1>Here are the data structures with brief descriptions:<table>
-  <tr><td class="indexkey"><a class="el" href="structrelay____RubyOptions____def.html">relay__RubyOptions__def</a></td><td class="indexvalue"></td></tr>
-  <tr><td class="indexkey"><a class="el" href="structt__cb__data.html">t_cb_data</a></td><td class="indexvalue"></td></tr>
-  <tr><td class="indexkey"><a class="el" href="structt__vpi__delay.html">t_vpi_delay</a></td><td class="indexvalue"></td></tr>
-  <tr><td class="indexkey"><a class="el" href="structt__vpi__error__info.html">t_vpi_error_info</a></td><td class="indexvalue"></td></tr>
-  <tr><td class="indexkey"><a class="el" href="structt__vpi__strengthval.html">t_vpi_strengthval</a></td><td class="indexvalue"></td></tr>
-  <tr><td class="indexkey"><a class="el" href="structt__vpi__systf__data.html">t_vpi_systf_data</a></td><td class="indexvalue"></td></tr>
-  <tr><td class="indexkey"><a class="el" href="structt__vpi__time.html">t_vpi_time</a></td><td class="indexvalue"></td></tr>
-  <tr><td class="indexkey"><a class="el" href="structt__vpi__value.html">t_vpi_value</a></td><td class="indexvalue"></td></tr>
-  <tr><td class="indexkey"><a class="el" href="structt__vpi__vecval.html">t_vpi_vecval</a></td><td class="indexvalue"></td></tr>
-  <tr><td class="indexkey"><a class="el" href="structt__vpi__vlog__info.html">t_vpi_vlog_info</a></td><td class="indexvalue"></td></tr>
-</table>
-<hr size="1"><address style="align: right;"><small>Generated on Sat Oct 28 02:24:01 2006 for Ruby-VPI by&nbsp;
-<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
-</body>
-</html>

data/ref/c/common_8h.html

@@ -1,146 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>Ruby-VPI: common.h File Reference</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-<link href="tabs.css" rel="stylesheet" type="text/css">
-</head><body>
-<!-- Generated by Doxygen 1.4.7 -->
-<div class="tabs">
-  <ul>
-    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
-    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
-    <li id="current"><a href="files.html"><span>Files</span></a></li>
-  </ul></div>
-<div class="tabs">
-  <ul>
-    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
-    <li><a href="globals.html"><span>Globals</span></a></li>
-  </ul></div>
-<h1>common.h File Reference</h1>Things common to all Ruby-VPI code. <a href="#_details">More...</a>
-<p>
-<code>#include &quot;<a class="el" href="verilog_8h.html">verilog.h</a>&quot;</code><br>
-<table border="0" cellpadding="0" cellspacing="0">
-<tr><td></td></tr>
-<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#88235e5f8aab82571d68045e9f73fe81">common_printf</a>()&nbsp;&nbsp;&nbsp;vpi_printf(&quot;Ruby-VPI: &quot;); vpi_printf(__VA_ARGS__); vpi_printf(&quot;\n&quot;);</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A wrapper for vpi_printf() which marks the given message as being emitted from Ruby-VPI and ends the message with a new line.  <a href="#88235e5f8aab82571d68045e9f73fe81"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#fcdad79cb06a5c61737b2f434218dc95">common_debug</a>()</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A wrapper for <a class="el" href="common_8h.html#88235e5f8aab82571d68045e9f73fe81">common_printf()</a> which marks the given message as being debugging output.  <a href="#fcdad79cb06a5c61737b2f434218dc95"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#f30d3fc89fbb3ed2aab2f5904ab76815">common_boolToStr</a>(aBoolExpr)&nbsp;&nbsp;&nbsp;( (aBoolExpr) ? &quot;true&quot; : &quot;false&quot; )</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the string "true" if the given boolean expression is true.  <a href="#f30d3fc89fbb3ed2aab2f5904ab76815"></a><br></td></tr>
-<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b1">bool</a> { <a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b1e9de385ef6fe9bf3360d1038396b884c">false</a> =  0, 
-<a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b108f175a5505a10b9ed657defeb050e4b">true</a> =  1
- }</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A boolean variable with two possible values: true and false.  <a href="common_8h.html#f6a258d8f3ee5206d682d799316314b1">More...</a><br></td></tr>
-</table>
-<hr><a name="_details"></a><h2>Detailed Description</h2>
-Things common to all Ruby-VPI code. 
-<p>
-<hr><h2>Define Documentation</h2>
-<a class="anchor" name="f30d3fc89fbb3ed2aab2f5904ab76815"></a><!-- doxytag: member="common.h::common_boolToStr" ref="f30d3fc89fbb3ed2aab2f5904ab76815" args="(aBoolExpr)" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">#define common_boolToStr          </td>
-          <td>(</td>
-          <td class="paramtype">aBoolExpr&nbsp;</td>
-          <td class="paramname">          </td>
-          <td>&nbsp;)&nbsp;</td>
-          <td width="100%">&nbsp;&nbsp;&nbsp;( (aBoolExpr) ? &quot;true&quot; : &quot;false&quot; )</td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-
-<p>
-Returns the string "true" if the given boolean expression is true. 
-<p>
-Otherwise returns the string "false". 
-</div>
-</div><p>
-<a class="anchor" name="fcdad79cb06a5c61737b2f434218dc95"></a><!-- doxytag: member="common.h::common_debug" ref="fcdad79cb06a5c61737b2f434218dc95" args="()" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">#define common_debug          </td>
-          <td>(</td>
-&nbsp;</td>
-          <td class="paramname">          </td>
-          <td>&nbsp;)&nbsp;</td>
-          <td width="100%"></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-
-<p>
-A wrapper for <a class="el" href="common_8h.html#88235e5f8aab82571d68045e9f73fe81">common_printf()</a> which marks the given message as being debugging output. 
-<p>
-
-</div>
-</div><p>
-<a class="anchor" name="88235e5f8aab82571d68045e9f73fe81"></a><!-- doxytag: member="common.h::common_printf" ref="88235e5f8aab82571d68045e9f73fe81" args="()" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">#define common_printf          </td>
-          <td>(</td>
-&nbsp;</td>
-          <td class="paramname">          </td>
-          <td>&nbsp;)&nbsp;</td>
-          <td width="100%">&nbsp;&nbsp;&nbsp;vpi_printf(&quot;Ruby-VPI: &quot;); vpi_printf(__VA_ARGS__); vpi_printf(&quot;\n&quot;);</td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-
-<p>
-A wrapper for vpi_printf() which marks the given message as being emitted from Ruby-VPI and ends the message with a new line. 
-<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>...</em>&nbsp;</td><td>Arguments to vpi_printf() </td></tr>
-  </table>
-</dl>
-
-</div>
-</div><p>
-<hr><h2>Enumeration Type Documentation</h2>
-<a class="anchor" name="f6a258d8f3ee5206d682d799316314b1"></a><!-- doxytag: member="common.h::bool" ref="f6a258d8f3ee5206d682d799316314b1" args="" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">enum <a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b1">bool</a>          </td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-
-<p>
-A boolean variable with two possible values: true and false. 
-<p>
-Pass aroung this value instead of zero and non-zero integers. <dl compact><dt><b>Enumerator: </b></dt><dd>
-<table border="0" cellspacing="2" cellpadding="0">
-<tr><td valign="top"><em><a class="anchor" name="f6a258d8f3ee5206d682d799316314b1e9de385ef6fe9bf3360d1038396b884c"></a><!-- doxytag: member="false" ref="f6a258d8f3ee5206d682d799316314b1e9de385ef6fe9bf3360d1038396b884c" args="" -->false</em>&nbsp;</td><td>
-</td></tr>
-<tr><td valign="top"><em><a class="anchor" name="f6a258d8f3ee5206d682d799316314b108f175a5505a10b9ed657defeb050e4b"></a><!-- doxytag: member="true" ref="f6a258d8f3ee5206d682d799316314b108f175a5505a10b9ed657defeb050e4b" args="" -->true</em>&nbsp;</td><td>
-</td></tr>
-</table>
-</dl>
-
-</div>
-</div><p>
-<hr size="1"><address style="align: right;"><small>Generated on Sat Oct 28 02:24:01 2006 for Ruby-VPI by&nbsp;
-<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
-</body>
-</html>