Skip to content
Snippets Groups Projects
documentation.html 4.97 KiB
---
css: documentation
layout: default
title: Documentation - Frama-C
---

<body
  class="page-template page-template-page-documentation page-template-page-documentation-php page page-id-20 nonTouch">

  <div id="wrapper" class="hfeed">

    {% include headers.html header=3 %}

    <div id="container" class="mainContainer">
      <div class="pageDocumentation pages">
        <div class="wrap">
          <h1 class="pageTitle">Documentation</h1>

          <p>Modifications to this documentation can be made via merge requests to the
            <a href="https://git.frama-c.com/pub/frama-c.frama-c.com">Frama-C website git repository</a>.
          </p>
          <p>The Frama-C kernel and plug-ins have <a href="/html/kernel-plugin.html">a detailed documentation page</a>.
          </p>

          <div class="docListwrap">
            <section>
              <div class="docListTitle">
                <span>Frama-C and ACSL</span>
              </div>
              <div class="listItem">
                <h4 class="listItemTitle"><span>ACSL</span></h4>
                <div class="docItem"><a href="/html/acsl.html">Description page</a></div>
                <div class="docItem"><a href="/download/acsl.pdf">Language Reference</a></div>
                <div class="docItem"><a href="/download/frama-c-acsl-implementation.pdf">Language Implementation</a></div>
                <div class="docItem"><a href="https://github.com/acsl-language/acsl">Official ACSL Git Repository</a></div>
                <div class="docItem"><a href="https://github.com/fraunhoferfokus/acsl-by-example">ACSL by Example</a></div>
              </div>
              <div class="listItem">
                <h4 class="listItemTitle"><span>Frama-C</span></h4>
                <div class="docItem"><a href="/html/kernel.html">Description page</a></div>
                <div class="docItem"><a href="/download/frama-c-user-manual.pdf">User Manual</a></div>
                <div class="docItem"><a href="https://git.frama-c.com/pub/frama-c/blob/master/INSTALL.md">Installation</a></div>
                <div class="docItem"><a href="/html/get-frama-c.html">Releases</a></div>
              </div>
              <div class="listItem">
                <h4 class="listItemTitle"><span>Contributing</span></h4>
                <div class="docItem"><a href="https://git.frama-c.com/pub/frama-c/">GitLab Repository</a></div>
                <div class="docItem"><a href="https://git.frama-c.com/pub/frama-c/CONTRIBUTING.md">Contributer guide</a></div>
                <div class="docItem"><a href="https://git.frama-c.com/pub/frama-c/-/issues">Known issues</a></div>
                <div class="docItem"><a href="/dokuwiki/bug_reporting_guidelines.html">bug reporting guide</a></div>
              </div>
              <div class="listItem">
                <h4 class="listItemTitle"><span>About Frama-C</span></h4>
                <div class="docItem"><a href="/dokuwiki/publications.html">List of publications</a></div>
                <div class="docItem"><a href="/dokuwiki/exercises.html">Exercices</a></div>
                <div class="docItem"><a href="/dokuwiki/teaching.html">Teaching</a></div>
                <div class="docItem"><a href="/dokuwiki/tutorial.html">Tutorials</a></div>
              </div>
            </section>
          </div>

          <div class="docListwrap">
            <section>
              <div class="docListTitle">
                <span>Plug-ins Manuals</span>
              </div>
              <div class="listItem">
                <h4 class="listItemTitle"><span>Plugin Development</span></h4>
                <div class="docItem"><a href="/download/frama-c-plugin-development-guide.pdf">Developer Manual</a></div>
              </div>
              {% for plugin in site.fc-plugins %}
              <div class="listItem">
                <h4 class="listItemTitle">
                  <span>
                    {% if plugin.short %}
                    {{ plugin.short }}
                    {% else %}
                    {{ plugin.title }}
                    {% endif %}
                  </span>
                </h4>
                <div class="docItem"><a href="{{plugin.url}}">Description page</a></div>
                {% if plugin.manual_pdf %}
                <div class="docItem"><a href="{{plugin.manual_pdf}}">User Manual</a></div>
                {% endif %}
                {% for add in plugin.additional %}
                <div class="docItem"><a href="{{add.link}}">{% if add.short %}{{add.short}}{% else %}{{add.name}}{% endif %}</a></div>
                {% endfor %}
                {% if plugin.repo_url %}
                <div class="docItem"><a href="{{plugin.repo_url}}">External repository</a></div>
                  {% endif %}
              	</div>
			        {% endfor %}
            </section>
          </div>
        </div>
      </div>

      {% include footer.html %}

      <div class="clear"></div>
    </div>
  </div>
</body>