Newer
Older
---
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="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>
<h2 class="subTitle">Compilation and installation</h2>
<p>Current and old releases of Frama-C are available on <a href="/html/get-frama-c.html">this page(</a>.
It contains the official installation instructions for supported systems.</p>
<p>Otherwise, the <a href="https://git.frama-c.com/pub/frama-c/blob/master/INSTALL.md">INSTALL.md</a>
file contains detailed installation instructions, for all supported OSes
(currently Linux, macOS and Windows via <a
href="https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux">WSL</a>.</p>
<h2 class="subTitle">Manuals</h2>
<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>
<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>
<h4 class="listItemTitle"><span>Plugin Development</span></h4>
<div class="docItem"><a href="/download/frama-c-plugin-development-guide.pdf">Developer Manual</a></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>
<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>
<div class="docItem"><a href="{{{plugin.repo_url}}">External repository</a></div>
<h2 class="subTitle">Works about Frama-C</h2>
<ul>
<li><a href="/dokuwiki/publications.html">List of publications</a></li>
<li><a href="/dokuwiki/exercises.html">Exercices</a></li>
<li><a href="/dokuwiki/teaching.html">Teaching</a></li>
<li><a href="/dokuwiki/tutorial.html">Tutorials</a></li>
</ul>
</div>
</div>
{% include footer.html %}
<div class="clear"></div>
</div>
</div>