README.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.5.3" />
   7 <title></title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.0em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.0em;
 126   margin-bottom: 2.0em;
 127   margin-right: 10%;
 128   color: #606060;
 129 }
 130
 131 div.content { /* Block element content. */
 132   padding: 0;
 133 }
 134
 135 /* Block element titles. */
 136 div.title, caption.title {
 137   color: #527bbd;
 138   font-family: sans-serif;
 139   font-weight: bold;
 140   text-align: left;
 141   margin-top: 1.0em;
 142   margin-bottom: 0.5em;
 143 }
 144 div.title + * {
 145   margin-top: 0;
 146 }
 147
 148 td div.title:first-child {
 149   margin-top: 0.0em;
 150 }
 151 div.content div.title:first-child {
 152   margin-top: 0.0em;
 153 }
 154 div.content + div.title {
 155   margin-top: 0.0em;
 156 }
 157
 158 div.sidebarblock > div.content {
 159   background: #ffffee;
 160   border: 1px solid silver;
 161   padding: 0.5em;
 162 }
 163
 164 div.listingblock > div.content {
 165   border: 1px solid silver;
 166   background: #f4f4f4;
 167   padding: 0.5em;
 168 }
 169
 170 div.quoteblock, div.verseblock {
 171   padding-left: 1.0em;
 172   margin-left: 1.0em;
 173   margin-right: 10%;
 174   border-left: 5px solid #dddddd;
 175   color: #777777;
 176 }
 177
 178 div.quoteblock > div.attribution {
 179   padding-top: 0.5em;
 180   text-align: right;
 181 }
 182
 183 div.verseblock > pre.content {
 184   font-family: inherit;
 185 }
 186 div.verseblock > div.attribution {
 187   padding-top: 0.75em;
 188   text-align: left;
 189 }
 190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 191 div.verseblock + div.attribution {
 192   text-align: left;
 193 }
 194
 195 div.admonitionblock .icon {
 196   vertical-align: top;
 197   font-size: 1.1em;
 198   font-weight: bold;
 199   text-decoration: underline;
 200   color: #527bbd;
 201   padding-right: 0.5em;
 202 }
 203 div.admonitionblock td.content {
 204   padding-left: 0.5em;
 205   border-left: 3px solid #dddddd;
 206 }
 207
 208 div.exampleblock > div.content {
 209   border-left: 3px solid #dddddd;
 210   padding-left: 0.5em;
 211 }
 212
 213 div.imageblock div.content { padding-left: 0; }
 214 span.image img { border-style: none; }
 215 a.image:visited { color: white; }
 216
 217 dl {
 218   margin-top: 0.8em;
 219   margin-bottom: 0.8em;
 220 }
 221 dt {
 222   margin-top: 0.5em;
 223   margin-bottom: 0;
 224   font-style: normal;
 225   color: navy;
 226 }
 227 dd > *:first-child {
 228   margin-top: 0.1em;
 229 }
 230
 231 ul, ol {
 232     list-style-position: outside;
 233 }
 234 ol.arabic {
 235   list-style-type: decimal;
 236 }
 237 ol.loweralpha {
 238   list-style-type: lower-alpha;
 239 }
 240 ol.upperalpha {
 241   list-style-type: upper-alpha;
 242 }
 243 ol.lowerroman {
 244   list-style-type: lower-roman;
 245 }
 246 ol.upperroman {
 247   list-style-type: upper-roman;
 248 }
 249
 250 div.compact ul, div.compact ol,
 251 div.compact p, div.compact p,
 252 div.compact div, div.compact div {
 253   margin-top: 0.1em;
 254   margin-bottom: 0.1em;
 255 }
 256
 257 div.tableblock > table {
 258   border: 3px solid #527bbd;
 259 }
 260 thead, p.table.header {
 261   font-family: sans-serif;
 262   font-weight: bold;
 263 }
 264 tfoot {
 265   font-weight: bold;
 266 }
 267 td > div.verse {
 268   white-space: pre;
 269 }
 270 p.table {
 271   margin-top: 0;
 272 }
 273 /* Because the table frame attribute is overriden by CSS in most browsers. */
 274 div.tableblock > table[frame="void"] {
 275   border-style: none;
 276 }
 277 div.tableblock > table[frame="hsides"] {
 278   border-left-style: none;
 279   border-right-style: none;
 280 }
 281 div.tableblock > table[frame="vsides"] {
 282   border-top-style: none;
 283   border-bottom-style: none;
 284 }
 285
 286
 287 div.hdlist {
 288   margin-top: 0.8em;
 289   margin-bottom: 0.8em;
 290 }
 291 div.hdlist tr {
 292   padding-bottom: 15px;
 293 }
 294 dt.hdlist1.strong, td.hdlist1.strong {
 295   font-weight: bold;
 296 }
 297 td.hdlist1 {
 298   vertical-align: top;
 299   font-style: normal;
 300   padding-right: 0.8em;
 301   color: navy;
 302 }
 303 td.hdlist2 {
 304   vertical-align: top;
 305 }
 306 div.hdlist.compact tr {
 307   margin: 0;
 308   padding-bottom: 0;
 309 }
 310
 311 .comment {
 312   background: yellow;
 313 }
 314
 315 .footnote, .footnoteref {
 316   font-size: 0.8em;
 317 }
 318
 319 span.footnote, span.footnoteref {
 320   vertical-align: super;
 321 }
 322
 323 #footnotes {
 324   margin: 20px 0 20px 0;
 325   padding: 7px 0 0 0;
 326 }
 327
 328 #footnotes div.footnote {
 329   margin: 0 0 5px 0;
 330 }
 331
 332 #footnotes hr {
 333   border: none;
 334   border-top: 1px solid silver;
 335   height: 1px;
 336   text-align: left;
 337   margin-left: 0;
 338   width: 20%;
 339   min-width: 100px;
 340 }
 341
 342
 343 @media print {
 344   div#footer-badges { display: none; }
 345 }
 346
 347 div#toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 div#toctitle {
 352   color: #527bbd;
 353   font-family: sans-serif;
 354   font-size: 1.1em;
 355   font-weight: bold;
 356   margin-top: 1.0em;
 357   margin-bottom: 0.1em;
 358 }
 359
 360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 361   margin-top: 0;
 362   margin-bottom: 0;
 363 }
 364 div.toclevel2 {
 365   margin-left: 2em;
 366   font-size: 0.9em;
 367 }
 368 div.toclevel3 {
 369   margin-left: 4em;
 370   font-size: 0.9em;
 371 }
 372 div.toclevel4 {
 373   margin-left: 6em;
 374   font-size: 0.9em;
 375 }
 376 /* Workarounds for IE6's broken and incomplete CSS2. */
 377
 378 div.sidebar-content {
 379   background: #ffffee;
 380   border: 1px solid silver;
 381   padding: 0.5em;
 382 }
 383 div.sidebar-title, div.image-title {
 384   color: #527bbd;
 385   font-family: sans-serif;
 386   font-weight: bold;
 387   margin-top: 0.0em;
 388   margin-bottom: 0.5em;
 389 }
 390
 391 div.listingblock div.content {
 392   border: 1px solid silver;
 393   background: #f4f4f4;
 394   padding: 0.5em;
 395 }
 396
 397 div.quoteblock-attribution {
 398   padding-top: 0.5em;
 399   text-align: right;
 400 }
 401
 402 pre.verseblock-content {
 403   font-family: inherit;
 404 }
 405 div.verseblock-attribution {
 406   padding-top: 0.75em;
 407   text-align: left;
 408 }
 409
 410 div.exampleblock-content {
 411   border-left: 3px solid #dddddd;
 412   padding-left: 0.5em;
 413 }
 414
 415 /* IE6 sets dynamically generated links as visited. */
 416 div#toc a:visited { color: blue; }
 417 </style>
 418 <script type="text/javascript">
 419 /*<![CDATA[*/
 420 window.onload = function(){asciidoc.footnotes(); asciidoc.toc(2);}
 421 var asciidoc = {  // Namespace.
 422
 423 /////////////////////////////////////////////////////////////////////
 424 // Table Of Contents generator
 425 /////////////////////////////////////////////////////////////////////
 426
 427 /* Author: Mihai Bazon, September 2002
 428  * http://students.infoiasi.ro/~mishoo
 429  *
 430  * Table Of Content generator
 431  * Version: 0.4
 432  *
 433  * Feel free to use this script under the terms of the GNU General Public
 434  * License, as long as you do not remove or alter this notice.
 435  */
 436
 437  /* modified by Troy D. Hanson, September 2006. License: GPL */
 438  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 439
 440 // toclevels = 1..4.
 441 toc: function (toclevels) {
 442
 443   function getText(el) {
 444     var text = "";
 445     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 446       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 447         text += i.data;
 448       else if (i.firstChild != null)
 449         text += getText(i);
 450     }
 451     return text;
 452   }
 453
 454   function TocEntry(el, text, toclevel) {
 455     this.element = el;
 456     this.text = text;
 457     this.toclevel = toclevel;
 458   }
 459
 460   function tocEntries(el, toclevels) {
 461     var result = new Array;
 462     var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
 463     // Function that scans the DOM tree for header elements (the DOM2
 464     // nodeIterator API would be a better technique but not supported by all
 465     // browsers).
 466     var iterate = function (el) {
 467       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 468         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 469           var mo = re.exec(i.tagName);
 470           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 471             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 472           }
 473           iterate(i);
 474         }
 475       }
 476     }
 477     iterate(el);
 478     return result;
 479   }
 480
 481   var toc = document.getElementById("toc");
 482   var entries = tocEntries(document.getElementById("content"), toclevels);
 483   for (var i = 0; i < entries.length; ++i) {
 484     var entry = entries[i];
 485     if (entry.element.id == "")
 486       entry.element.id = "_toc_" + i;
 487     var a = document.createElement("a");
 488     a.href = "#" + entry.element.id;
 489     a.appendChild(document.createTextNode(entry.text));
 490     var div = document.createElement("div");
 491     div.appendChild(a);
 492     div.className = "toclevel" + entry.toclevel;
 493     toc.appendChild(div);
 494   }
 495   if (entries.length == 0)
 496     toc.parentNode.removeChild(toc);
 497 },
 498
 499
 500 /////////////////////////////////////////////////////////////////////
 501 // Footnotes generator
 502 /////////////////////////////////////////////////////////////////////
 503
 504 /* Based on footnote generation code from:
 505  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 506  */
 507
 508 footnotes: function () {
 509   var cont = document.getElementById("content");
 510   var noteholder = document.getElementById("footnotes");
 511   var spans = cont.getElementsByTagName("span");
 512   var refs = {};
 513   var n = 0;
 514   for (i=0; i<spans.length; i++) {
 515     if (spans[i].className == "footnote") {
 516       n++;
 517       // Use [\s\S] in place of . so multi-line matches work.
 518       // Because JavaScript has no s (dotall) regex flag.
 519       note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 520       noteholder.innerHTML +=
 521         "<div class='footnote' id='_footnote_" + n + "'>" +
 522         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 523         n + "</a>. " + note + "</div>";
 524       spans[i].innerHTML =
 525         "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 526         "' title='View footnote' class='footnote'>" + n + "</a>]";
 527       var id =spans[i].getAttribute("id");
 528       if (id != null) refs["#"+id] = n;
 529     }
 530   }
 531   if (n == 0)
 532     noteholder.parentNode.removeChild(noteholder);
 533   else {
 534     // Process footnoterefs.
 535     for (i=0; i<spans.length; i++) {
 536       if (spans[i].className == "footnoteref") {
 537         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 538         href = href.match(/#.*/)[0];  // Because IE return full URL.
 539         n = refs[href];
 540         spans[i].innerHTML =
 541           "[<a href='#_footnote_" + n +
 542           "' title='View footnote' class='footnote'>" + n + "</a>]";
 543       }
 544     }
 545   }
 546 }
 547
 548 }
 549 /*]]>*/
 550 </script>
 551 </head>
 552 <body>
 553 <div id="header">
 554 <h1></h1>
 555 <span id="author">Michael Wild</span><br />
 556 <span id="email"><tt>&lt;<a href="mailto:themiwi@users.sourceforge.net">themiwi@users.sourceforge.net</a>&gt;</tt></span><br />
 557 <div id="toc">
 558   <div id="toctitle">Table of Contents</div>
 559   <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
 560 </div>
 561 </div>
 562 <div id="content">
 563 <div id="preamble">
 564 <div class="sectionbody">
 565 <div class="paragraph"><p><a href="http://freefoam.sourceforge.net">http://freefoam.sourceforge.net</a></p></div>
 566 </div>
 567 </div>
 568 <h2 id="_copyright">Copyright</h2>
 569 <div class="sectionbody">
 570 <div class="paragraph"><p>FreeFOAM is free software; you can redistribute it and/or modify it under the
 571 terms of the GNU General Public License as published by the Free Software
 572 Foundation; either version 2 of the License, or (at your option) any later
 573 version.  See the file COPYING in this directory, for a description of the GNU
 574 General Public License terms under which you can copy the files.</p></div>
 575 </div>
 576 <h2 id="_system_requirements">System requirements</h2>
 577 <div class="sectionbody">
 578 <div class="paragraph"><p>FreeFOAM is developed and tested on Linux, but should work with other Unix style
 579 systems, notably Mac OS X &#169;. The support for Microsoft Windows is a goal,
 580 which, however, is still far off.</p></div>
 581 <h3 id="_required_software_to_build_freefoam">Required software to build FreeFOAM</h3><div style="clear:left"></div>
 582 <div class="dlist"><dl>
 583 <dt class="hdlist1">
 584 <a id="cmake"></a>CMake
 585 </dt>
 586 <dd>
 587 <p>
 588   In order to build FreeFOAM you need to have CMake with version 2.8.0 or
 589   newer installed. <a href="http://cmake.org">http://cmake.org</a>
 590 </p>
 591 </dd>
 592 <dt class="hdlist1">
 593 <a id="build_system"></a>Build system
 594 </dt>
 595 <dd>
 596 <p>
 597   CMake requires a native build system. On Unix like platforms GNU Make is
 598   recommended. <a href="http://www.gnu.org/software/make">http://www.gnu.org/software/make</a>
 599 </p>
 600 </dd>
 601 <dt class="hdlist1">
 602 <a id="cxx_compiler"></a>C++ compiler
 603 </dt>
 604 <dd>
 605 <p>
 606   In order to build FreeFOAM you need a C++ compiler with good support for
 607   template expressions. The g++ compiler from GCC-4.3 and above will do
 608   fine. <a href="http://gcc.gnu.org">http://gcc.gnu.org</a>
 609 </p>
 610 </dd>
 611 <dt class="hdlist1">
 612 <a id="flex"></a>flex
 613 </dt>
 614 <dd>
 615 <p>
 616   The flex lexer generator. Version 2.5.33 is known to work. For more recent
 617   versions there have been reports of problems. <a href="http://flex.sourceforge.net">http://flex.sourceforge.net</a>
 618 </p>
 619 </dd>
 620 <dt class="hdlist1">
 621 <a id="zlib"></a>zlib
 622 </dt>
 623 <dd>
 624 <p>
 625   zlib compression library. <a href="http://www.zlib.net">http://www.zlib.net</a>
 626 </p>
 627 </dd>
 628 <dt class="hdlist1">
 629 <a id="metis"></a>METIS
 630 </dt>
 631 <dd>
 632 <p>
 633   The METIS graph partitioning library, version 5.0pre2. If your package manager
 634   doesn&#8217;t contain it, you can also have FreeFOAM build it automatically for you
 635   (see the <a href="#installation">installation section</a>).
 636   <a href="http://glaros.dtc.umn.edu/gkhome/metis/metis/overview">http://glaros.dtc.umn.edu/gkhome/metis/metis/overview</a>
 637 </p>
 638 </dd>
 639 <dt class="hdlist1">
 640 <a id="python"></a>Python
 641 </dt>
 642 <dd>
 643 <p>
 644   The Python interpreter. Version 2.6.1 is known to work, but care has been
 645   taken to make FreeFOAM work with versions from 2.4 on, including 3.x.
 646 </p>
 647 </dd>
 648 </dl></div>
 649 <h3 id="_optional_software">Optional software</h3><div style="clear:left"></div>
 650 <div class="dlist"><dl>
 651 <dt class="hdlist1">
 652 <a id="git"></a>git
 653 </dt>
 654 <dd>
 655 <p>
 656   To check out a current development version of FreeFOAM, git is required.
 657   <a href="http://git.or.cz">http://git.or.cz</a>
 658 </p>
 659 </dd>
 660 <dt class="hdlist1">
 661 <a id="parlib"></a>Parallel Communications Library
 662 </dt>
 663 <dd>
 664 <p>
 665   In order to run FreeFOAM in parallel, a communications library is required.
 666   The following list gives an overview of the available options:
 667 </p>
 668 <div class="ulist"><ul>
 669 <li>
 670 <p>
 671 MPI (<em>Message Passing Interface</em>): There are many implementations of the MPI
 672     standard. The one that has been tested and is known to work with FreeFOAM
 673     is <a href="http://www.open-mpi.org">OpenMPI</a>.
 674 </p>
 675 </li>
 676 <li>
 677 <p>
 678 GAMMA (<em>Genoa Active Message MAchine</em>) is available from
 679     <a href="http://www.disi.unige.it/project/gamma">http://www.disi.unige.it/project/gamma</a>.
 680 </p>
 681 </li>
 682 </ul></div>
 683 </dd>
 684 <dt class="hdlist1">
 685 <a id="parmetis"></a>ParMetis
 686 </dt>
 687 <dd>
 688 <p>
 689   If you use an MPI library, the ParMetis library is required. If your package
 690   manager doesn&#8217;t contain this library, FreeFOAM can build it automatically for
 691   you (refer to the <a href="#installation">installation notes</a> below).
 692   <a href="http://glaros.dtc.umn.edu/gkhome/metis/parmetis/overview">http://glaros.dtc.umn.edu/gkhome/metis/parmetis/overview</a>
 693 </p>
 694 </dd>
 695 <dt class="hdlist1">
 696 <a id="mgridgen"></a>MGRIDGEN
 697 </dt>
 698 <dd>
 699 <p>
 700 MGRIDGEN is a grid coarsening library for multi-grid
 701   solvers. FreeFOAM can build this automatically for you. Please refer to the
 702   <a href="INSTALL.html#enable-parmgridgen">INSTALL</a> file for license restrictions.
 703   <a href="http://glaros.dtc.umn.edu/gkhome/mgridgen/overview">http://glaros.dtc.umn.edu/gkhome/mgridgen/overview</a>
 704 </p>
 705 </dd>
 706 <dt class="hdlist1">
 707 <a id="libccmio"></a>libccmio
 708 </dt>
 709 <dd>
 710 <p>
 711   pro-STAR &#169; input/output library. FreeFOAM can build this automatically for
 712   you. Please refer to the <a href="INSTALL.html#enable-ccmio">INSTALL</a> file for
 713   license restrictions.
 714   <a href="https://wci.llnl.gov/codes/visit/3rd_party/libccmio-2.6.1.tar.gz">https://wci.llnl.gov/codes/visit/3rd_party/libccmio-2.6.1.tar.gz</a>
 715 </p>
 716 </dd>
 717 <dt class="hdlist1">
 718 <a id="paraview"></a>ParaView
 719 </dt>
 720 <dd>
 721 <p>
 722   If you want to build the <a href="http://paraview.org">ParaView</a> plug-ins, you need a
 723   ParaView with the development headers <strong>and</strong> the corresponding CMake configuration
 724   files (<em>ParaViewConfig.cmake</em>, <em>ParaViewUse.cmake</em>, <em>ParaViewLibraryDepends*.cmake</em>).
 725   Most likely this means that you have to build ParaView yourself.
 726   <a href="http://paraview.org">http://paraview.org</a>
 727 </p>
 728 </dd>
 729 <dt class="hdlist1">
 730 <a id="m4"></a>M4
 731 </dt>
 732 <dd>
 733 <p>
 734   Some of the provided tutorial cases require the M4 macro processor.
 735   <a href="http://www.gnu.org/software/m4/">http://www.gnu.org/software/m4/</a>
 736 </p>
 737 </dd>
 738 <dt class="hdlist1">
 739 <a id="doxygen"></a>Doxygen
 740 </dt>
 741 <dd>
 742 <p>
 743   Automatic API-documentation generator. Required to build the source
 744   documentation. <a href="http://www.doxygen.org">http://www.doxygen.org</a>
 745 </p>
 746 </dd>
 747 <dt class="hdlist1">
 748 <a id="asciidoc"></a>Asciidoc
 749 </dt>
 750 <dd>
 751 <p>
 752   In order to create the man-pages or the html-documentation you need to have a
 753   fully working Asciidoc toolchain installed. Versions newer than 8.5 are known
 754   to work. Asciidoc itself needs Python 2.4 or newer (but not 3.x), xsltproc,
 755   the DocBook XML DTD&#8217;s and the DocBook XSL stylesheets. Refer to the Asciidoc
 756   installation instructions for the details. <a href="http://www.methods.co.nz/asciidoc">http://www.methods.co.nz/asciidoc</a>
 757 </p>
 758 </dd>
 759 </dl></div>
 760 </div>
 761 <h2 id="_installation">Installation</h2>
 762 <div class="sectionbody">
 763 <div class="paragraph"><p>For installation and basic usage instructions, refer to the
 764 <a href="INSTALL.html">INSTALL</a> file.</p></div>
 765 </div>
 766 <h2 id="_documentation">Documentation</h2>
 767 <div class="sectionbody">
 768 <div class="paragraph"><p>All the applications and the frequently used script utilities come with a brief
 769 man-page. Unfortunately, most of them are little more than stubs and need more
 770 work. The man-pages <em>freefoam(7)</em> gives a short overview over all applications
 771 and utilities, and <em>freefoam-config(7)</em> documents the FreeFOAM configuration
 772 options.</p></div>
 773 <div class="paragraph"><p>API-documentation is available from
 774 <a href="http://freefoam.sourceforge.net/doc/Doxygen/html">http://freefoam.sourceforge.net/doc/Doxygen/html</a></p></div>
 775 <div class="paragraph"><p>Further, most FreeFOAM applications and utilities support the <em>-doc</em> and
 776 <em>-srcDoc</em> options, which will automatically display the API-documentation and
 777 the source code of the application, respectively.</p></div>
 778 </div>
 779 <h2 id="_help">Help</h2>
 780 <div class="sectionbody">
 781 <div class="ulist"><ul>
 782 <li>
 783 <p>
 784 <a href="http://freefoam.sourceforge.net">http://freefoam.sourceforge.net</a>
 785 </p>
 786 </li>
 787 <li>
 788 <p>
 789 <a href="https://freefoam.wiki.sourceforge.net/MailingLists">https://freefoam.wiki.sourceforge.net/MailingLists</a>
 790 </p>
 791 </li>
 792 <li>
 793 <p>
 794 <a href="http://www.cfd-online.com/Forums/openfoam/">http://www.cfd-online.com/Forums/openfoam/</a> <strong>please only ask questions related
 795   to <em>OpenFOAM</em> there</strong>.
 796 </p>
 797 </li>
 798 </ul></div>
 799 </div>
 800 <h2 id="_reporting_bugs_in_freefoam">Reporting Bugs in FreeFOAM</h2>
 801 <div class="sectionbody">
 802 <div class="paragraph"><p><a href="https://sourceforge.net/tracker/?group_id=215833">https://sourceforge.net/tracker/?group_id=215833</a></p></div>
 803 </div>
 804 </div>
 805 <div id="footnotes"><hr /></div>
 806 <div id="footer">
 807 <div id="footer-text">
 808 Last updated 2010-08-02 18:16:45 CEST
 809 </div>
 810 </div>
 811 </body>
 812 </html>