ruby-vpi 7.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (364) hide show
  1. data/HISTORY +398 -0
  2. data/LICENSE +340 -0
  3. data/MEMO +38 -0
  4. data/README +9 -0
  5. data/Rakefile +271 -0
  6. data/bin/generate_test.rb +258 -0
  7. data/bin/generate_test_tpl/bench.rb +31 -0
  8. data/bin/generate_test_tpl/bench.v +54 -0
  9. data/bin/generate_test_tpl/design.rb +26 -0
  10. data/bin/generate_test_tpl/proto.rb +8 -0
  11. data/bin/generate_test_tpl/runner.rake +28 -0
  12. data/bin/generate_test_tpl/spec.rb +46 -0
  13. data/bin/header_to_ruby.rb +70 -0
  14. data/doc/Rakefile +55 -0
  15. data/doc/src/LICENSE +397 -0
  16. data/doc/src/figures/organization.png +0 -0
  17. data/doc/src/figures/organization_detailed.png +0 -0
  18. data/doc/src/figures/ruby_init.png +0 -0
  19. data/doc/src/figures/ruby_relay.png +0 -0
  20. data/doc/src/figures.dia +0 -0
  21. data/doc/src/images/COPYING +67 -0
  22. data/doc/src/images/ChangeLog +27 -0
  23. data/doc/src/images/blank.png +0 -0
  24. data/doc/src/images/callouts/1.png +0 -0
  25. data/doc/src/images/callouts/10.png +0 -0
  26. data/doc/src/images/callouts/11.png +0 -0
  27. data/doc/src/images/callouts/12.png +0 -0
  28. data/doc/src/images/callouts/13.png +0 -0
  29. data/doc/src/images/callouts/14.png +0 -0
  30. data/doc/src/images/callouts/15.png +0 -0
  31. data/doc/src/images/callouts/2.png +0 -0
  32. data/doc/src/images/callouts/3.png +0 -0
  33. data/doc/src/images/callouts/4.png +0 -0
  34. data/doc/src/images/callouts/5.png +0 -0
  35. data/doc/src/images/callouts/6.png +0 -0
  36. data/doc/src/images/callouts/7.png +0 -0
  37. data/doc/src/images/callouts/8.png +0 -0
  38. data/doc/src/images/callouts/9.png +0 -0
  39. data/doc/src/images/callouts/ChangeLog +15 -0
  40. data/doc/src/images/caution.png +0 -0
  41. data/doc/src/images/caution.svg +290 -0
  42. data/doc/src/images/copyright +55 -0
  43. data/doc/src/images/draft.png +0 -0
  44. data/doc/src/images/home.png +0 -0
  45. data/doc/src/images/home.svg +386 -0
  46. data/doc/src/images/important.png +0 -0
  47. data/doc/src/images/important.svg +163 -0
  48. data/doc/src/images/next.png +0 -0
  49. data/doc/src/images/next.svg +191 -0
  50. data/doc/src/images/note.png +0 -0
  51. data/doc/src/images/note.svg +483 -0
  52. data/doc/src/images/prev.png +0 -0
  53. data/doc/src/images/prev.svg +852 -0
  54. data/doc/src/images/tip.png +0 -0
  55. data/doc/src/images/tip.svg +1145 -0
  56. data/doc/src/images/toc-blank.png +0 -0
  57. data/doc/src/images/toc-minus.png +0 -0
  58. data/doc/src/images/toc-plus.png +0 -0
  59. data/doc/src/images/up.png +0 -0
  60. data/doc/src/images/up.svg +195 -0
  61. data/doc/src/images/warning.png +0 -0
  62. data/doc/src/images/warning.svg +334 -0
  63. data/doc/src/license.xml +446 -0
  64. data/doc/src/manual.xml +1582 -0
  65. data/doc/src/manual.xsl +23 -0
  66. data/doc/src/shared.dtd +63 -0
  67. data/doc/src/styles/manual.css +87 -0
  68. data/doc/txt/manual.txt +1657 -0
  69. data/doc/xhtml/background.html +3 -0
  70. data/doc/xhtml/background.methodology.html +3 -0
  71. data/doc/xhtml/background.organization.html +10 -0
  72. data/doc/xhtml/background.running-tests.html +3 -0
  73. data/doc/xhtml/background.terminology.html +3 -0
  74. data/doc/xhtml/figures/organization.png +0 -0
  75. data/doc/xhtml/figures/organization_detailed.png +0 -0
  76. data/doc/xhtml/figures/ruby_init.png +0 -0
  77. data/doc/xhtml/figures/ruby_relay.png +0 -0
  78. data/doc/xhtml/gfdl-0.html +18 -0
  79. data/doc/xhtml/gfdl-1.html +70 -0
  80. data/doc/xhtml/gfdl-10.html +15 -0
  81. data/doc/xhtml/gfdl-2.html +13 -0
  82. data/doc/xhtml/gfdl-3.html +31 -0
  83. data/doc/xhtml/gfdl-4.html +75 -0
  84. data/doc/xhtml/gfdl-5.html +20 -0
  85. data/doc/xhtml/gfdl-6.html +12 -0
  86. data/doc/xhtml/gfdl-7.html +16 -0
  87. data/doc/xhtml/gfdl-8.html +17 -0
  88. data/doc/xhtml/gfdl-9.html +9 -0
  89. data/doc/xhtml/gfdl-addendum.html +25 -0
  90. data/doc/xhtml/gfdl.html +11 -0
  91. data/doc/xhtml/glossary.html +3 -0
  92. data/doc/xhtml/images/COPYING +67 -0
  93. data/doc/xhtml/images/ChangeLog +27 -0
  94. data/doc/xhtml/images/blank.png +0 -0
  95. data/doc/xhtml/images/callouts/1.png +0 -0
  96. data/doc/xhtml/images/callouts/10.png +0 -0
  97. data/doc/xhtml/images/callouts/11.png +0 -0
  98. data/doc/xhtml/images/callouts/12.png +0 -0
  99. data/doc/xhtml/images/callouts/13.png +0 -0
  100. data/doc/xhtml/images/callouts/14.png +0 -0
  101. data/doc/xhtml/images/callouts/15.png +0 -0
  102. data/doc/xhtml/images/callouts/2.png +0 -0
  103. data/doc/xhtml/images/callouts/3.png +0 -0
  104. data/doc/xhtml/images/callouts/4.png +0 -0
  105. data/doc/xhtml/images/callouts/5.png +0 -0
  106. data/doc/xhtml/images/callouts/6.png +0 -0
  107. data/doc/xhtml/images/callouts/7.png +0 -0
  108. data/doc/xhtml/images/callouts/8.png +0 -0
  109. data/doc/xhtml/images/callouts/9.png +0 -0
  110. data/doc/xhtml/images/callouts/ChangeLog +15 -0
  111. data/doc/xhtml/images/caution.png +0 -0
  112. data/doc/xhtml/images/caution.svg +290 -0
  113. data/doc/xhtml/images/copyright +55 -0
  114. data/doc/xhtml/images/draft.png +0 -0
  115. data/doc/xhtml/images/home.png +0 -0
  116. data/doc/xhtml/images/home.svg +386 -0
  117. data/doc/xhtml/images/important.png +0 -0
  118. data/doc/xhtml/images/important.svg +163 -0
  119. data/doc/xhtml/images/next.png +0 -0
  120. data/doc/xhtml/images/next.svg +191 -0
  121. data/doc/xhtml/images/note.png +0 -0
  122. data/doc/xhtml/images/note.svg +483 -0
  123. data/doc/xhtml/images/prev.png +0 -0
  124. data/doc/xhtml/images/prev.svg +852 -0
  125. data/doc/xhtml/images/tip.png +0 -0
  126. data/doc/xhtml/images/tip.svg +1145 -0
  127. data/doc/xhtml/images/toc-blank.png +0 -0
  128. data/doc/xhtml/images/toc-minus.png +0 -0
  129. data/doc/xhtml/images/toc-plus.png +0 -0
  130. data/doc/xhtml/images/up.png +0 -0
  131. data/doc/xhtml/images/up.svg +195 -0
  132. data/doc/xhtml/images/warning.png +0 -0
  133. data/doc/xhtml/images/warning.svg +334 -0
  134. data/doc/xhtml/index.html +4 -0
  135. data/doc/xhtml/introduction.html +3 -0
  136. data/doc/xhtml/introduction.license.html +3 -0
  137. data/doc/xhtml/introduction.manifest.html +3 -0
  138. data/doc/xhtml/introduction.related-works.html +3 -0
  139. data/doc/xhtml/introduction.resources.html +3 -0
  140. data/doc/xhtml/problem.ivl.html +18 -0
  141. data/doc/xhtml/problems.html +3 -0
  142. data/doc/xhtml/problems.ruby.html +3 -0
  143. data/doc/xhtml/problems.vsim.html +3 -0
  144. data/doc/xhtml/styles/manual.css +87 -0
  145. data/doc/xhtml/usage.examples.html +3 -0
  146. data/doc/xhtml/usage.html +3 -0
  147. data/doc/xhtml/usage.installation.html +3 -0
  148. data/doc/xhtml/usage.requirements.html +3 -0
  149. data/doc/xhtml/usage.tools.html +3 -0
  150. data/doc/xhtml/usage.tutorial.html +199 -0
  151. data/ext/Doxyfile +272 -0
  152. data/ext/README +124 -0
  153. data/ext/Rakefile +65 -0
  154. data/ext/common.h +56 -0
  155. data/ext/extconf.rb +4 -0
  156. data/ext/relay.cin +146 -0
  157. data/ext/relay.hin +48 -0
  158. data/ext/ruby-vpi.c +36 -0
  159. data/ext/swig.cin +38 -0
  160. data/ext/swig.hin +39 -0
  161. data/ext/swig_vpi.h +924 -0
  162. data/ext/swig_vpi.i +8 -0
  163. data/ext/swig_wrap.cin +4613 -0
  164. data/ext/verilog.h +59 -0
  165. data/ext/vlog.cin +92 -0
  166. data/ext/vlog.hin +57 -0
  167. data/ext/vpi_user.h +924 -0
  168. data/gem_extconf.rb +8 -0
  169. data/history.html +809 -0
  170. data/lib/ruby-vpi/erb.rb +41 -0
  171. data/lib/ruby-vpi/rake.rb +35 -0
  172. data/lib/ruby-vpi/rdoc.rb +51 -0
  173. data/lib/ruby-vpi/rspec.rb +32 -0
  174. data/lib/ruby-vpi/runner.rb +22 -0
  175. data/lib/ruby-vpi/vpi_util.rb +310 -0
  176. data/lib/ruby-vpi.rb +58 -0
  177. data/memo.html +86 -0
  178. data/readme.html +19 -0
  179. data/ref/c/annotated.html +36 -0
  180. data/ref/c/common_8h.html +178 -0
  181. data/ref/c/doxygen.css +310 -0
  182. data/ref/c/doxygen.png +0 -0
  183. data/ref/c/files.html +35 -0
  184. data/ref/c/functions.html +135 -0
  185. data/ref/c/functions_vars.html +135 -0
  186. data/ref/c/globals.html +55 -0
  187. data/ref/c/globals_0x63.html +86 -0
  188. data/ref/c/globals_0x65.html +55 -0
  189. data/ref/c/globals_0x66.html +55 -0
  190. data/ref/c/globals_0x70.html +71 -0
  191. data/ref/c/globals_0x72.html +62 -0
  192. data/ref/c/globals_0x73.html +65 -0
  193. data/ref/c/globals_0x74.html +55 -0
  194. data/ref/c/globals_0x76.html +472 -0
  195. data/ref/c/globals_0x78.html +55 -0
  196. data/ref/c/globals_defs.html +81 -0
  197. data/ref/c/globals_defs_0x65.html +50 -0
  198. data/ref/c/globals_defs_0x70.html +51 -0
  199. data/ref/c/globals_defs_0x76.html +463 -0
  200. data/ref/c/globals_defs_0x78.html +50 -0
  201. data/ref/c/globals_enum.html +39 -0
  202. data/ref/c/globals_eval.html +40 -0
  203. data/ref/c/globals_func.html +49 -0
  204. data/ref/c/globals_type.html +63 -0
  205. data/ref/c/globals_vars.html +42 -0
  206. data/ref/c/hierarchy.html +36 -0
  207. data/ref/c/index.html +20 -0
  208. data/ref/c/relay_8cin.html +268 -0
  209. data/ref/c/relay_8hin.html +161 -0
  210. data/ref/c/ruby-vpi_8c.html +34 -0
  211. data/ref/c/structrelay____RubyOptions____def.html +84 -0
  212. data/ref/c/structt__cb__data.html +208 -0
  213. data/ref/c/structt__vpi__delay.html +183 -0
  214. data/ref/c/structt__vpi__error__info.html +208 -0
  215. data/ref/c/structt__vpi__strengthval.html +108 -0
  216. data/ref/c/structt__vpi__systf__data.html +208 -0
  217. data/ref/c/structt__vpi__time.html +133 -0
  218. data/ref/c/structt__vpi__value.html +285 -0
  219. data/ref/c/structt__vpi__vecval.html +83 -0
  220. data/ref/c/structt__vpi__vlog__info.html +133 -0
  221. data/ref/c/swig_8cin.html +91 -0
  222. data/ref/c/swig_8hin.html +99 -0
  223. data/ref/c/tab_b.gif +0 -0
  224. data/ref/c/tab_l.gif +0 -0
  225. data/ref/c/tab_r.gif +0 -0
  226. data/ref/c/tabs.css +102 -0
  227. data/ref/c/verilog_8h.html +149 -0
  228. data/ref/c/vlog_8cin.html +199 -0
  229. data/ref/c/vlog_8hin.html +152 -0
  230. data/ref/c/vpi__user_8h.html +12747 -0
  231. data/ref/ruby/classes/Counter.html +258 -0
  232. data/ref/ruby/classes/Counter.src/M000037.html +20 -0
  233. data/ref/ruby/classes/Counter.src/M000038.html +22 -0
  234. data/ref/ruby/classes/Counter.src/M000039.html +20 -0
  235. data/ref/ruby/classes/Counter.src/M000040.html +22 -0
  236. data/ref/ruby/classes/CounterProto.html +164 -0
  237. data/ref/ruby/classes/CounterProto.src/M000004.html +22 -0
  238. data/ref/ruby/classes/CounterProto.src/M000005.html +22 -0
  239. data/ref/ruby/classes/ERB.html +158 -0
  240. data/ref/ruby/classes/ERB.src/M000034.html +29 -0
  241. data/ref/ruby/classes/FileUtils.html +165 -0
  242. data/ref/ruby/classes/FileUtils.src/M000047.html +18 -0
  243. data/ref/ruby/classes/FileUtils.src/M000048.html +18 -0
  244. data/ref/ruby/classes/Hw5UnitModel/Operation.html +216 -0
  245. data/ref/ruby/classes/Hw5UnitModel/Operation.src/M000011.html +25 -0
  246. data/ref/ruby/classes/Hw5UnitModel/Operation.src/M000012.html +33 -0
  247. data/ref/ruby/classes/Hw5UnitModel/Operation.src/M000013.html +18 -0
  248. data/ref/ruby/classes/Hw5UnitModel.html +256 -0
  249. data/ref/ruby/classes/Hw5UnitModel.src/M000006.html +24 -0
  250. data/ref/ruby/classes/Hw5UnitModel.src/M000008.html +20 -0
  251. data/ref/ruby/classes/Hw5UnitModel.src/M000009.html +38 -0
  252. data/ref/ruby/classes/Hw5UnitModel.src/M000010.html +22 -0
  253. data/ref/ruby/classes/Hw5_unit.html +196 -0
  254. data/ref/ruby/classes/Hw5_unit.src/M000003.html +27 -0
  255. data/ref/ruby/classes/Hw5_unit_spec.html +237 -0
  256. data/ref/ruby/classes/Hw5_unit_spec.src/M000023.html +21 -0
  257. data/ref/ruby/classes/Hw5_unit_spec.src/M000024.html +21 -0
  258. data/ref/ruby/classes/Hw5_unit_spec.src/M000025.html +67 -0
  259. data/ref/ruby/classes/InputGenerator.html +260 -0
  260. data/ref/ruby/classes/InputGenerator.src/M000027.html +18 -0
  261. data/ref/ruby/classes/InputGenerator.src/M000028.html +18 -0
  262. data/ref/ruby/classes/InputGenerator.src/M000029.html +19 -0
  263. data/ref/ruby/classes/InputGenerator.src/M000030.html +38 -0
  264. data/ref/ruby/classes/InputGenerator.src/M000031.html +19 -0
  265. data/ref/ruby/classes/InputGenerator.src/M000032.html +19 -0
  266. data/ref/ruby/classes/MaximumCounterValue.html +159 -0
  267. data/ref/ruby/classes/MaximumCounterValue.src/M000035.html +23 -0
  268. data/ref/ruby/classes/MaximumCounterValue.src/M000036.html +21 -0
  269. data/ref/ruby/classes/ModuleInfo.html +199 -0
  270. data/ref/ruby/classes/ModuleInfo.src/M000018.html +44 -0
  271. data/ref/ruby/classes/ModuleInfo.src/M000019.html +26 -0
  272. data/ref/ruby/classes/OutputInfo.html +304 -0
  273. data/ref/ruby/classes/OutputInfo.src/M000017.html +51 -0
  274. data/ref/ruby/classes/RDoc.html +135 -0
  275. data/ref/ruby/classes/RDoc.src/M000051.html +40 -0
  276. data/ref/ruby/classes/ResettedCounterValue.html +174 -0
  277. data/ref/ruby/classes/ResettedCounterValue.src/M000014.html +19 -0
  278. data/ref/ruby/classes/ResettedCounterValue.src/M000015.html +18 -0
  279. data/ref/ruby/classes/ResettedCounterValue.src/M000016.html +23 -0
  280. data/ref/ruby/classes/RubyVPI.html +186 -0
  281. data/ref/ruby/classes/RubyVPI.src/M000049.html +18 -0
  282. data/ref/ruby/classes/RubyVPI.src/M000050.html +39 -0
  283. data/ref/ruby/classes/SWIG/TYPE_p_unsigned_int.html +370 -0
  284. data/ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000041.html +22 -0
  285. data/ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000042.html +44 -0
  286. data/ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000043.html +82 -0
  287. data/ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000044.html +127 -0
  288. data/ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000045.html +26 -0
  289. data/ref/ruby/classes/SWIG/TYPE_p_unsigned_int.src/M000046.html +18 -0
  290. data/ref/ruby/classes/SWIG.html +111 -0
  291. data/ref/ruby/classes/String.html +140 -0
  292. data/ref/ruby/classes/String.src/M000033.html +37 -0
  293. data/ref/ruby/classes/Template.html +158 -0
  294. data/ref/ruby/classes/Template.src/M000026.html +18 -0
  295. data/ref/ruby/classes/TestHw5UnitModel.html +180 -0
  296. data/ref/ruby/classes/TestHw5UnitModel.src/M000020.html +19 -0
  297. data/ref/ruby/classes/TestHw5UnitModel.src/M000021.html +19 -0
  298. data/ref/ruby/classes/TestHw5UnitModel.src/M000022.html +64 -0
  299. data/ref/ruby/created.rid +1 -0
  300. data/ref/ruby/files/bin/generate_test_rb.html +236 -0
  301. data/ref/ruby/files/bin/generate_test_rb.src/M000001.html +29 -0
  302. data/ref/ruby/files/bin/generate_test_tpl/bench_rb.html +115 -0
  303. data/ref/ruby/files/bin/generate_test_tpl/design_rb.html +107 -0
  304. data/ref/ruby/files/bin/generate_test_tpl/proto_rb.html +107 -0
  305. data/ref/ruby/files/bin/generate_test_tpl/spec_rb.html +140 -0
  306. data/ref/ruby/files/bin/generate_test_tpl/spec_rb.src/M000002.html +22 -0
  307. data/ref/ruby/files/bin/header_to_ruby_rb.html +116 -0
  308. data/ref/ruby/files/ext/extconf_rb.html +108 -0
  309. data/ref/ruby/files/gem_extconf_rb.html +114 -0
  310. data/ref/ruby/files/lib/ruby-vpi/erb_rb.html +108 -0
  311. data/ref/ruby/files/lib/ruby-vpi/rake_rb.html +108 -0
  312. data/ref/ruby/files/lib/ruby-vpi/rdoc_rb.html +108 -0
  313. data/ref/ruby/files/lib/ruby-vpi/rspec_rb.html +115 -0
  314. data/ref/ruby/files/lib/ruby-vpi/runner_rb.html +108 -0
  315. data/ref/ruby/files/lib/ruby-vpi/vpi_util_rb.html +108 -0
  316. data/ref/ruby/files/lib/ruby-vpi_rb.html +108 -0
  317. data/ref/ruby/files/samp/counter/counter_rspecTest_bench_rb.html +115 -0
  318. data/ref/ruby/files/samp/counter/counter_rspecTest_design_rb.html +107 -0
  319. data/ref/ruby/files/samp/counter/counter_rspecTest_proto_rb.html +107 -0
  320. data/ref/ruby/files/samp/counter/counter_rspecTest_spec_rb.html +142 -0
  321. data/ref/ruby/files/samp/counter/counter_unitTest_bench_rb.html +115 -0
  322. data/ref/ruby/files/samp/counter/counter_unitTest_design_rb.html +107 -0
  323. data/ref/ruby/files/samp/counter/counter_unitTest_proto_rb.html +107 -0
  324. data/ref/ruby/files/samp/counter/counter_unitTest_spec_rb.html +135 -0
  325. data/ref/ruby/files/samp/pipelined_alu/Hw5UnitModel_rb.html +101 -0
  326. data/ref/ruby/files/samp/pipelined_alu/InputGenerator_rb.html +101 -0
  327. data/ref/ruby/files/samp/pipelined_alu/TestHw5UnitModel_rb.html +111 -0
  328. data/ref/ruby/files/samp/pipelined_alu/hw5_unit_bench_rb.html +108 -0
  329. data/ref/ruby/files/samp/pipelined_alu/hw5_unit_design_rb.html +107 -0
  330. data/ref/ruby/files/samp/pipelined_alu/hw5_unit_spec_rb.html +112 -0
  331. data/ref/ruby/fr_class_index.html +46 -0
  332. data/ref/ruby/fr_file_index.html +55 -0
  333. data/ref/ruby/fr_method_index.html +77 -0
  334. data/ref/ruby/index.html +24 -0
  335. data/ref/ruby/rdoc-style.css +208 -0
  336. data/samp/counter/Rakefile +1 -0
  337. data/samp/counter/counter.v +20 -0
  338. data/samp/counter/counter_rspecTest_bench.rb +9 -0
  339. data/samp/counter/counter_rspecTest_bench.v +28 -0
  340. data/samp/counter/counter_rspecTest_design.rb +22 -0
  341. data/samp/counter/counter_rspecTest_proto.rb +10 -0
  342. data/samp/counter/counter_rspecTest_runner.rake +28 -0
  343. data/samp/counter/counter_rspecTest_spec.rb +47 -0
  344. data/samp/counter/counter_unitTest_bench.rb +9 -0
  345. data/samp/counter/counter_unitTest_bench.v +28 -0
  346. data/samp/counter/counter_unitTest_design.rb +22 -0
  347. data/samp/counter/counter_unitTest_proto.rb +10 -0
  348. data/samp/counter/counter_unitTest_runner.rake +28 -0
  349. data/samp/counter/counter_unitTest_spec.rb +49 -0
  350. data/samp/pipelined_alu/Hw5UnitModel.rb +134 -0
  351. data/samp/pipelined_alu/InputGenerator.rb +94 -0
  352. data/samp/pipelined_alu/README +127 -0
  353. data/samp/pipelined_alu/Rakefile +1 -0
  354. data/samp/pipelined_alu/TestHw5UnitModel.rb +88 -0
  355. data/samp/pipelined_alu/hw5_unit.v +186 -0
  356. data/samp/pipelined_alu/hw5_unit_bench.rb +8 -0
  357. data/samp/pipelined_alu/hw5_unit_bench.v +45 -0
  358. data/samp/pipelined_alu/hw5_unit_design.rb +18 -0
  359. data/samp/pipelined_alu/hw5_unit_runner.rake +10 -0
  360. data/samp/pipelined_alu/hw5_unit_spec.rb +123 -0
  361. data/tpl/launcher.rake +30 -0
  362. data/tpl/runner.rake +96 -0
  363. data/tpl/synopsys_vcs.tab +2 -0
  364. metadata +484 -0
@@ -0,0 +1,446 @@
1
+ <appendix id="gfdl">
2
+ <appendixinfo>
3
+ <title>GNU Free Documentation License</title>
4
+
5
+ <pubdate>Version 1.2, November 2002</pubdate>
6
+ <copyright><year>2000,2001,2002</year>
7
+ <holder>Free Software Foundation, Inc.</holder></copyright>
8
+ <legalnotice id="gfdl-legalnotice">
9
+ <para><address>Free Software Foundation, Inc.
10
+ <street>51 Franklin St, Fifth Floor</street>,
11
+ <city>Boston</city>,
12
+ <state>MA</state>
13
+ <postcode>02110-1301</postcode>
14
+ <country>USA</country>
15
+ </address></para>
16
+ <para>Everyone is permitted to copy and distribute verbatim copies
17
+ of this license document, but changing it is not allowed.</para>
18
+ </legalnotice>
19
+ <releaseinfo>Version 1.2, November 2002</releaseinfo>
20
+ </appendixinfo>
21
+
22
+ <title>GNU Free Documentation License</title>
23
+ <section id="gfdl-0"><title>PREAMBLE</title>
24
+
25
+ <para>The purpose of this License is to make a manual, textbook, or
26
+ other functional and useful document "free" in the sense of freedom: to
27
+ assure everyone the effective freedom to copy and redistribute it, with
28
+ or without modifying it, either commercially or noncommercially.
29
+ Secondarily, this License preserves for the author and publisher a way
30
+ to get credit for their work, while not being considered responsible for
31
+ modifications made by others.</para>
32
+
33
+ <para>This License is a kind of "copyleft", which means that derivative
34
+ works of the document must themselves be free in the same sense. It
35
+ complements the GNU General Public License, which is a copyleft license
36
+ designed for free software.</para>
37
+
38
+ <para>We have designed this License in order to use it for manuals for
39
+ free software, because free software needs free documentation: a free
40
+ program should come with manuals providing the same freedoms that the
41
+ software does. But this License is not limited to software manuals; it
42
+ can be used for any textual work, regardless of subject matter or
43
+ whether it is published as a printed book. We recommend this License
44
+ principally for works whose purpose is instruction or reference.</para>
45
+ </section>
46
+
47
+ <section id="gfdl-1"><title>APPLICABILITY AND DEFINITIONS</title>
48
+
49
+ <para id="gfdl-doc">This License applies to any manual or other work, in
50
+ any medium, that contains a notice placed by the copyright holder saying
51
+ it can be distributed under the terms of this License. Such a notice
52
+ grants a world-wide, royalty-free license, unlimited in duration, to use
53
+ that work under the conditions stated herein. The "Document", below,
54
+ refers to any such manual or work. Any member of the public is a
55
+ licensee, and is addressed as "you". You accept the license if you
56
+ copy, modify or distribute the work in a way requiring permission under
57
+ copyright law.</para>
58
+
59
+ <para id="gfdl-mod-ver">A "Modified Version" of the Document means any
60
+ work containing the Document or a portion of it, either copied verbatim,
61
+ or with modifications and/or translated into another language.</para>
62
+
63
+ <para id="gfdl-secnd-sect">A "Secondary Section" is a named appendix or
64
+ a front-matter section of the Document that deals exclusively with the
65
+ relationship of the publishers or authors of the Document to the
66
+ Document's overall subject (or to related matters) and contains nothing
67
+ that could fall directly within that overall subject. (Thus, if the
68
+ Document is in part a textbook of mathematics, a Secondary Section may
69
+ not explain any mathematics.) The relationship could be a matter of
70
+ historical connection with the subject or with related matters, or of
71
+ legal, commercial, philosophical, ethical or political position
72
+ regarding them.</para>
73
+
74
+ <para id="gfdl-inv-sect">The "Invariant Sections" are certain Secondary
75
+ Sections whose titles are designated, as being those of Invariant
76
+ Sections, in the notice that says that the Document is released under
77
+ this License. If a section does not fit the above definition of
78
+ Secondary then it is not allowed to be designated as Invariant. The
79
+ Document may contain zero Invariant Sections. If the Document does not
80
+ identify any Invariant Sections then there are none.</para>
81
+
82
+ <para id="gfdl-cov-text">The "Cover Texts" are certain short passages of
83
+ text that are listed, as Front-Cover Texts or Back-Cover Texts, in the
84
+ notice that says that the Document is released under this License. A
85
+ Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at
86
+ most 25 words.</para>
87
+
88
+ <para id="gfdl-transparent">A "Transparent" copy of the Document means a
89
+ machine-readable copy, represented in a format whose specification is
90
+ available to the general public, that is suitable for revising the
91
+ document straightforwardly with generic text editors or (for images
92
+ composed of pixels) generic paint programs or (for drawings) some widely
93
+ available drawing editor, and that is suitable for input to text
94
+ formatters or for automatic translation to a variety of formats suitable
95
+ for input to text formatters. A copy made in an otherwise Transparent
96
+ file format whose markup, or absence of markup, has been arranged to
97
+ thwart or discourage subsequent modification by readers is not
98
+ Transparent. An image format is not Transparent if used for any
99
+ substantial amount of text. A copy that is not "Transparent" is called
100
+ "Opaque".</para>
101
+
102
+ <para>Examples of suitable formats for Transparent copies include plain
103
+ ASCII without markup, Texinfo input format, LaTeX input format, SGML or
104
+ XML using a publicly available DTD, and standard-conforming simple HTML,
105
+ PostScript or PDF designed for human modification. Examples of
106
+ transparent image formats include PNG, XCF and JPG. Opaque formats
107
+ include proprietary formats that can be read and edited only by
108
+ proprietary word processors, SGML or XML for which the DTD and/or
109
+ processing tools are not generally available, and the machine-generated
110
+ HTML, PostScript or PDF produced by some word processors for output
111
+ purposes only.</para>
112
+
113
+ <para id="gfdl-title-page">The "Title Page" means, for a printed book,
114
+ the title page itself, plus such following pages as are needed to hold,
115
+ legibly, the material this License requires to appear in the title page.
116
+ For works in formats which do not have any title page as such, "Title
117
+ Page" means the text near the most prominent appearance of the work's
118
+ title, preceding the beginning of the body of the text.</para>
119
+
120
+ <para id="gfdl-entitled">A section "Entitled XYZ" means a named subunit
121
+ of the Document whose title either is precisely XYZ or contains XYZ in
122
+ parentheses following text that translates XYZ in another language.
123
+ (Here XYZ stands for a specific section name mentioned below, such as
124
+ "Acknowledgements", "Dedications", "Endorsements", or "History".) To
125
+ "Preserve the Title" of such a section when you modify the Document
126
+ means that it remains a section "Entitled XYZ" according to this
127
+ definition.</para>
128
+
129
+ <para>The Document may include Warranty Disclaimers next to the notice
130
+ which states that this License applies to the Document. These Warranty
131
+ Disclaimers are considered to be included by reference in this License,
132
+ but only as regards disclaiming warranties: any other implication that
133
+ these Warranty Disclaimers may have is void and has no effect on the
134
+ meaning of this License.</para>
135
+ </section>
136
+
137
+ <section id="gfdl-2"><title>VERBATIM COPYING</title>
138
+
139
+ <para>You may copy and distribute the Document in any medium, either
140
+ commercially or noncommercially, provided that this License, the
141
+ copyright notices, and the license notice saying this License applies to
142
+ the Document are reproduced in all copies, and that you add no other
143
+ conditions whatsoever to those of this License. You may not use
144
+ technical measures to obstruct or control the reading or further copying
145
+ of the copies you make or distribute. However, you may accept
146
+ compensation in exchange for copies. If you distribute a large enough
147
+ number of copies you must also follow the conditions in section 3.
148
+ </para>
149
+
150
+ <para>You may also lend copies, under the same conditions stated above,
151
+ and you may publicly display copies.</para>
152
+ </section>
153
+
154
+ <section id="gfdl-3"><title>COPYING IN QUANTITY</title>
155
+
156
+ <para>If you publish printed copies (or copies in media that commonly
157
+ have printed covers) of the Document, numbering more than 100, and the
158
+ Document's license notice requires Cover Texts, you must enclose the
159
+ copies in covers that carry, clearly and legibly, all these Cover Texts:
160
+ Front-Cover Texts on the front cover, and Back-Cover Texts on the back
161
+ cover. Both covers must also clearly and legibly identify you as the
162
+ publisher of these copies. The front cover must present the full title
163
+ with all words of the title equally prominent and visible. You may add
164
+ other material on the covers in addition. Copying with changes limited
165
+ to the covers, as long as they preserve the title of the Document and
166
+ satisfy these conditions, can be treated as verbatim copying in other
167
+ respects.</para>
168
+
169
+ <para>If the required texts for either cover are too voluminous to fit
170
+ legibly, you should put the first ones listed (as many as fit
171
+ reasonably) on the actual cover, and continue the rest onto adjacent
172
+ pages.</para>
173
+
174
+ <para>If you publish or distribute Opaque copies of the Document
175
+ numbering more than 100, you must either include a machine-readable
176
+ Transparent copy along with each Opaque copy, or state in or with each
177
+ Opaque copy a computer-network location from which the general
178
+ network-using public has access to download using public-standard
179
+ network protocols a complete Transparent copy of the Document, free of
180
+ added material. If you use the latter option, you must take reasonably
181
+ prudent steps, when you begin distribution of Opaque copies in quantity,
182
+ to ensure that this Transparent copy will remain thus accessible at the
183
+ stated location until at least one year after the last time you
184
+ distribute an Opaque copy (directly or through your agents or retailers)
185
+ of that edition to the public.</para>
186
+
187
+ <para>It is requested, but not required, that you contact the authors of
188
+ the Document well before redistributing any large number of copies, to
189
+ give them a chance to provide you with an updated version of the
190
+ Document.</para>
191
+ </section>
192
+
193
+ <section id="gfdl-4"><title>MODIFICATIONS</title>
194
+
195
+ <para>You may copy and distribute a Modified Version of the Document
196
+ under the conditions of sections 2 and 3 above, provided that you
197
+ release the Modified Version under precisely this License, with the
198
+ Modified Version filling the role of the Document, thus licensing
199
+ distribution and modification of the Modified Version to whoever
200
+ possesses a copy of it. In addition, you must do these things in the
201
+ Modified Version:</para>
202
+
203
+ <orderedlist id="gfdl-modif-cond" numeration="upperalpha">
204
+ <title>GNU FDL Modification Conditions</title>
205
+ <listitem><simpara>Use in the Title Page (and on the covers, if any) a
206
+ title distinct from that of the Document, and from those of previous
207
+ versions (which should, if there were any, be listed in the History
208
+ section of the Document). You may use the same title as a previous
209
+ version if the original publisher of that version gives permission.
210
+ </simpara></listitem>
211
+ <listitem><simpara>List on the Title Page, as authors, one or more
212
+ persons or entities responsible for authorship of the modifications in
213
+ the Modified Version, together with at least five of the principal
214
+ authors of the Document (all of its principal authors, if it has fewer
215
+ than five), unless they release you from this requirement.
216
+ </simpara></listitem>
217
+ <listitem><simpara>State on the Title page the name of the publisher of
218
+ the Modified Version, as the publisher.</simpara></listitem>
219
+ <listitem><simpara>Preserve all the copyright notices of the Document.
220
+ </simpara></listitem>
221
+ <listitem><simpara>Add an appropriate copyright notice for your
222
+ modifications adjacent to the other copyright notices.
223
+ </simpara></listitem>
224
+ <listitem><simpara>Include, immediately after the copyright notices, a
225
+ license notice giving the public permission to use the Modified
226
+ Version under the terms of this License, in the form shown in the
227
+ <link linkend="gfdl-addendum">Addendum</link> below.
228
+ </simpara></listitem>
229
+ <listitem><simpara>Preserve in that license notice the full lists of
230
+ Invariant Sections and required Cover Texts given in the Document's
231
+ license notice.</simpara></listitem>
232
+ <listitem><simpara>Include an unaltered copy of this License.
233
+ </simpara></listitem>
234
+ <listitem><simpara>Preserve the section Entitled "History", Preserve its
235
+ Title, and add to it an item stating at least the title, year, new
236
+ authors, and publisher of the Modified Version as given on the Title
237
+ Page. If there is no section Entitled "History" in the Document,
238
+ create one stating the title, year, authors, and publisher of the
239
+ Document as given on its Title Page, then add an item describing the
240
+ Modified Version as stated in the previous sentence.
241
+ </simpara></listitem>
242
+ <listitem><simpara>Preserve the network location, if any, given in the
243
+ Document for public access to a Transparent copy of the Document, and
244
+ likewise the network locations given in the Document for previous
245
+ versions it was based on. These may be placed in the "History"
246
+ section. You may omit a network location for a work that was
247
+ published at least four years before the Document itself, or if the
248
+ original publisher of the version it refers to gives permission.
249
+ </simpara></listitem>
250
+ <listitem><simpara>For any section Entitled "Acknowledgements" or
251
+ "Dedications", Preserve the Title of the section, and preserve in the
252
+ section all the substance and tone of each of the contributor
253
+ acknowledgements and/or dedications given therein.
254
+ </simpara></listitem>
255
+ <listitem><simpara>Preserve all the Invariant Sections of the Document,
256
+ unaltered in their text and in their titles. Section numbers or the
257
+ equivalent are not considered part of the section titles.
258
+ </simpara></listitem>
259
+ <listitem><simpara>Delete any section Entitled "Endorsements".
260
+ Such a section may not be included in the Modified Version.
261
+ </simpara></listitem>
262
+ <listitem><simpara>Do not retitle any existing section to be Entitled
263
+ "Endorsements" or to conflict in title with any Invariant Section.
264
+ </simpara></listitem>
265
+ <listitem><simpara>Preserve any Warranty Disclaimers.
266
+ </simpara></listitem>
267
+ </orderedlist>
268
+
269
+ <para>If the Modified Version includes new front-matter sections or
270
+ appendices that qualify as Secondary Sections and contain no material
271
+ copied from the Document, you may at your option designate some or all
272
+ of these sections as invariant. To do this, add their titles to the
273
+ list of Invariant Sections in the Modified Version's license notice.
274
+ These titles must be distinct from any other section titles.</para>
275
+
276
+ <para>You may add a section Entitled "Endorsements", provided it
277
+ contains nothing but endorsements of your Modified Version by various
278
+ parties--for example, statements of peer review or that the text has
279
+ been approved by an organization as the authoritative definition of a
280
+ standard.</para>
281
+
282
+ <para>You may add a passage of up to five words as a Front-Cover Text,
283
+ and a passage of up to 25 words as a Back-Cover Text, to the end of the
284
+ list of Cover Texts in the Modified Version. Only one passage of
285
+ Front-Cover Text and one of Back-Cover Text may be added by (or through
286
+ arrangements made by) any one entity. If the Document already includes
287
+ a cover text for the same cover, previously added by you or by
288
+ arrangement made by the same entity you are acting on behalf of, you may
289
+ not add another; but you may replace the old one, on explicit permission
290
+ from the previous publisher that added the old one.</para>
291
+
292
+ <para>The author(s) and publisher(s) of the Document do not by this
293
+ License give permission to use their names for publicity for or to
294
+ assert or imply endorsement of any Modified Version.</para>
295
+ </section>
296
+
297
+ <section id="gfdl-5"><title>COMBINING DOCUMENTS</title>
298
+
299
+ <para>You may combine the Document with other documents released under
300
+ this License, under the terms defined in <link linkend="gfdl-4">section
301
+ 4</link> above for modified versions, provided that you include in the
302
+ combination all of the Invariant Sections of all of the original
303
+ documents, unmodified, and list them all as Invariant Sections of your
304
+ combined work in its license notice, and that you preserve all their
305
+ Warranty Disclaimers.</para>
306
+
307
+ <para>The combined work need only contain one copy of this License, and
308
+ multiple identical Invariant Sections may be replaced with a single
309
+ copy. If there are multiple Invariant Sections with the same name but
310
+ different contents, make the title of each such section unique by adding
311
+ at the end of it, in parentheses, the name of the original author or
312
+ publisher of that section if known, or else a unique number. Make the
313
+ same adjustment to the section titles in the list of Invariant Sections
314
+ in the license notice of the combined work.</para>
315
+
316
+ <para>In the combination, you must combine any sections Entitled
317
+ "History" in the various original documents, forming one section
318
+ Entitled "History"; likewise combine any sections Entitled
319
+ "Acknowledgements", and any sections Entitled "Dedications". You must
320
+ delete all sections Entitled "Endorsements".</para>
321
+ </section>
322
+
323
+ <section id="gfdl-6"><title>COLLECTIONS OF DOCUMENTS</title>
324
+
325
+ <para>You may make a collection consisting of the Document and other
326
+ documents released under this License, and replace the individual copies
327
+ of this License in the various documents with a single copy that is
328
+ included in the collection, provided that you follow the rules of this
329
+ License for verbatim copying of each of the documents in all other
330
+ respects.</para>
331
+
332
+ <para>You may extract a single document from such a collection, and
333
+ distribute it individually under this License, provided you insert a
334
+ copy of this License into the extracted document, and follow this
335
+ License in all other respects regarding verbatim copying of that
336
+ document.</para>
337
+ </section>
338
+
339
+ <section id="gfdl-7"><title>AGGREGATION WITH INDEPENDENT WORKS</title>
340
+
341
+ <para>A compilation of the Document or its derivatives with other
342
+ separate and independent documents or works, in or on a volume of a
343
+ storage or distribution medium, is called an "aggregate" if the
344
+ copyright resulting from the compilation is not used to limit the legal
345
+ rights of the compilation's users beyond what the individual works
346
+ permit. When the Document is included in an aggregate, this License does
347
+ not apply to the other works in the aggregate which are not themselves
348
+ derivative works of the Document.</para>
349
+
350
+ <para>If the Cover Text requirement of section 3 is applicable to these
351
+ copies of the Document, then if the Document is less than one half of
352
+ the entire aggregate, the Document's Cover Texts may be placed on covers
353
+ that bracket the Document within the aggregate, or the electronic
354
+ equivalent of covers if the Document is in electronic form. Otherwise
355
+ they must appear on printed covers that bracket the whole
356
+ aggregate.</para>
357
+ </section>
358
+
359
+ <section id="gfdl-8"><title>TRANSLATION</title>
360
+
361
+ <para>Translation is considered a kind of modification, so you may
362
+ distribute translations of the Document under the terms of section 4.
363
+ Replacing Invariant Sections with translations requires special
364
+ permission from their copyright holders, but you may include
365
+ translations of some or all Invariant Sections in addition to the
366
+ original versions of these Invariant Sections. You may include a
367
+ translation of this License, and all the license notices in the
368
+ Document, and any Warranty Disclaimers, provided that you also include
369
+ the original English version of this License and the original versions
370
+ of those notices and disclaimers. In case of a disagreement between the
371
+ translation and the original version of this License or a notice or
372
+ disclaimer, the original version will prevail.</para>
373
+
374
+ <para>If a section in the Document is Entitled "Acknowledgements",
375
+ "Dedications", or "History", the requirement (section 4) to Preserve its
376
+ Title (section 1) will typically require changing the actual
377
+ title.</para>
378
+ </section>
379
+
380
+ <section id="gfdl-9"><title>TERMINATION</title>
381
+
382
+ <para>You may not copy, modify, sublicense, or distribute the Document
383
+ except as expressly provided for under this License. Any other attempt
384
+ to copy, modify, sublicense or distribute the Document is void, and will
385
+ automatically terminate your rights under this License. However,
386
+ parties who have received copies, or rights, from you under this License
387
+ will not have their licenses terminated so long as such parties remain
388
+ in full compliance.</para>
389
+ </section>
390
+
391
+ <section id="gfdl-10"><title>FUTURE REVISIONS OF THIS LICENSE</title>
392
+
393
+ <para>The Free Software Foundation may publish new, revised versions of
394
+ the GNU Free Documentation License from time to time. Such new versions
395
+ will be similar in spirit to the present version, but may differ in
396
+ detail to address new problems or concerns. See
397
+ http://www.gnu.org/copyleft/.</para>
398
+
399
+ <para>Each version of the License is given a distinguishing version
400
+ number. If the Document specifies that a particular numbered version of
401
+ this License "or any later version" applies to it, you have the option
402
+ of following the terms and conditions either of that specified version
403
+ or of any later version that has been published (not as a draft) by the
404
+ Free Software Foundation. If the Document does not specify a version
405
+ number of this License, you may choose any version ever published (not
406
+ as a draft) by the Free Software Foundation.</para>
407
+ </section>
408
+
409
+ <section id="gfdl-addendum"><title>ADDENDUM: How to use this License for
410
+ your documents</title>
411
+
412
+ <para>To use this License in a document you have written, include a copy
413
+ of the License in the document and put the following copyright and
414
+ license notices just after the title page:</para>
415
+
416
+ <blockquote id="copyright-sample">
417
+ <title>Sample Invariant Sections list</title><para>
418
+ Copyright (c) YEAR YOUR NAME.
419
+ Permission is granted to copy, distribute and/or modify this document
420
+ under the terms of the GNU Free Documentation License, Version 1.2
421
+ or any later version published by the Free Software Foundation;
422
+ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
423
+ A copy of the license is included in the section entitled "GNU
424
+ Free Documentation License".
425
+ </para></blockquote>
426
+
427
+ <para>If you have Invariant Sections, Front-Cover Texts and Back-Cover
428
+ Texts, replace the "with...Texts." line with this:</para>
429
+
430
+ <blockquote id="inv-cover-sample">
431
+ <title>Sample Invariant Sections list</title>
432
+ <para>
433
+ with the Invariant Sections being LIST THEIR TITLES, with the
434
+ Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
435
+ </para></blockquote>
436
+
437
+ <para>If you have Invariant Sections without Cover Texts, or some other
438
+ combination of the three, merge those two alternatives to suit the
439
+ situation.</para>
440
+
441
+ <para>If your document contains nontrivial examples of program code, we
442
+ recommend releasing these examples in parallel under your choice of free
443
+ software license, such as the GNU General Public License, to permit
444
+ their use in free software.</para>
445
+ </section>
446
+ </appendix>