manual.html

<!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" />
    <meta content="BASIS makes it easy to create sharable software and libraries that work together. This is accomplished by combining and documenting some of the best practices, utilities, and open source projects available. More importantly, BASIS supplies a fully integrated suite of functionality to make the whole process seamless!" name="description" />
<meta content="FEpJ4EO1PvGXLyfXp-Q6EJsypA0xGqYctXtmoP3pLJw" name="google-site-verification" />

    <title>CMake BASIS &mdash; BASIS</title>
    
    <link rel="stylesheet" href="_static/cmake-basis.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     'v3.3 (fb18c98)',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="shortcut icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="top" title="BASIS" href="index.html" />
   
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">

  </head>
  <body>
  
  
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li><a href="sidebar.html">BASIS</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="cmake-basis">
<h1>CMake BASIS<a class="headerlink" href="#cmake-basis" title="Permalink to this headline">¶</a></h1>
<p>The <strong>CMake Build system And Software Implementation Standard (BASIS)</strong> makes it
easy to create sharable software and libraries that work together. This is
accomplished by combining and documenting some of the best practices, utilities,
and open source projects available. More importantly, BASIS supplies a fully
integrated suite of functionality to make the whole process seamless!</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="features_manual.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#first-steps">First Steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="howto.html">How-to Guides</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/create-and-modify-project.html">Create/Modify a Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/use-and-customize-templates.html">Using and Customizing Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/cmake-options.html">CMake Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/configure-project.html">Configure a Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/manage-data.html">Managing Test Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html">Documenting Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/branch-and-release.html">Branch and Release</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/package.html">Packaging Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/install.html">Install any Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/run-automated-tests.html">Automated Testing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="standard.html">Standards</a><ul>
<li class="toctree-l2"><a class="reference internal" href="standard/fhs.html">Filesystem Layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="standard/template.html">Project Template</a></li>
<li class="toctree-l2"><a class="reference internal" href="standard/modules.html">Project Modularization</a></li>
<li class="toctree-l2"><a class="reference internal" href="standard/scripttargets.html">Build of Script Targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="standard/cmdline.html">Command-line Parsing</a></li>
<li class="toctree-l2"><a class="reference internal" href="standard/execution.html">Calling Conventions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guideline.html">Guidelines</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guideline/plain-text-format.html">Plain Text Format</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference.html#basic-tools">Basic Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#cmake-modules">CMake Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#utilities">Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#project-layout">Project Layout</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="help.html">Support</a><ul>
<li class="toctree-l2"><a class="reference internal" href="help.html#report-issue">Report Issue</a></li>
<li class="toctree-l2"><a class="reference internal" href="help.html#frequently-asked-questions">Frequently Asked Questions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="people.html">People</a></li>
</ul>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <p class="logo"><a href="index.html">
    <img class="logo" src="_static/logo_title.svg" alt="Logo"/>
  </a></p>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="contents.html">Table Of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto.html">How-to Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="standard.html">Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="guideline.html">Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="apidoc.html">API</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">News</a></li>
<li class="toctree-l1"><a class="reference internal" href="download.html">Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="help.html">Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
</ul>

<h3>External Links</h3>
<ul>
  <li><a href="https://github.com/cmake-basis/BASIS">Repository</a></ li>
  <li><a href="https://github.com/cmake-basis/BASIS/issues">Issues</a></ li>
</ul>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
  <div class="footer">
    &copy; Copyright 2011-12 University of Pennsylvania, 2013-14 Carnegie Mellon University, 2013-16 Andreas Schuh.
    Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.1.
  </div>
  
  </body>
</html>