contents.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" />
    
    <title>Table of Contents &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="table-of-contents">
<h1>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h1>
<div class="section" id="software-manual">
<h2>Software Manual<a class="headerlink" href="#software-manual" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<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><ul>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#install-basis">Install BASIS</a><ul>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#get-a-copy-of-the-source-code">Get a copy of the source code</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#configure-the-build">Configure the build</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#build-and-install-basis">Build and install BASIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#set-up-the-environment">Set up the environment</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#create-an-example-project">Create an Example Project</a></li>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#install-your-project">Install Your Project</a></li>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#add-an-executable">Add an Executable</a><ul>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#change-target-properties">Change target properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#test-the-executable">Test the Executable</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#add-libraries">Add Libraries</a><ul>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#add-a-private-library">Add a private library</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#add-a-public-library">Add a public library</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#add-a-scripted-module">Add a scripted module</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#the-in-suffix">The .in suffix</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#install-the-libraries">Install the libraries</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#create-a-modularized-repository">Create a Modularized Repository</a><ul>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#create-a-top-level-project">Create a Top Level Project</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#create-a-sub-project-containing-a-library">Create a Sub-project Containing a Library</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#create-a-sub-project-that-uses-the-library">Create a Sub-project that uses the Library</a></li>
<li class="toctree-l4"><a class="reference internal" href="quickstart.html#install-the-projects">Install the Projects</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#next-steps">Next Steps</a></li>
</ul>
</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><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/create-and-modify-project.html#create-a-new-project">Create a New Project</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/create-and-modify-project.html#modify-an-existing-project">Modify an Existing Project</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/create-and-modify-project.html#general-notes">General Notes</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/create-and-modify-project.html#adding-features">Adding Features</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/create-and-modify-project.html#removing-features">Removing Features</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/create-and-modify-project.html#adding-dependencies">Adding Dependencies</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/create-and-modify-project.html#removing-dependencies">Removing Dependencies</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/create-and-modify-project.html#modularize-a-project">Modularize a Project</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/create-and-modify-project.html#create-the-top-level-project">Create the Top Level Project</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/create-and-modify-project.html#create-the-modules">Create the Modules</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/create-and-modify-project.html#configure-the-build">Configure the build</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/create-and-modify-project.html#build-the-top-level-project-and-its-modules">Build the Top Level Project and its Modules</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/create-and-modify-project.html#upgrade-a-project">Upgrade a Project</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/create-and-modify-project.html#resolving-merge-conflicts">Resolving Merge Conflicts</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="howto/use-and-customize-templates.html">Using and Customizing Templates</a><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/use-and-customize-templates.html#available-templates">Available Templates</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/use-and-customize-templates.html#use-a-template">Use a Template</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/use-and-customize-templates.html#change-the-default-template">Change the Default Template</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/use-and-customize-templates.html#create-a-custom-template">Create a Custom Template</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="howto/cmake-options.html">CMake Options</a><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/cmake-options.html#standard-cmake">Standard CMake</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/cmake-options.html#basis-options">BASIS Options</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/cmake-options.html#frequently-used">Frequently Used</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/cmake-options.html#advanced">Advanced</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="howto/configure-project.html">Configure a Project</a><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/configure-project.html#build-configuration">Build Configuration</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#basisproject-cmake">BasisProject.cmake</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#settings-cmake">Settings.cmake</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#depends-cmake">Depends.cmake</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#config-cmake-in">Config.cmake.in</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#version-cmake-in">Version.cmake.in</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#scriptconfig-cmake-in">ScriptConfig.cmake.in</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#package-cmake-and-components-cmake">Package.cmake and Components.cmake</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/configure-project.html#header-files">Header Files</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#public-interface">Public Interface</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#private-interface">Private Interface</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#search-path">Search Path</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/configure-project.html#custom-layout">Custom Layout</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/configure-project.html#superbuild">Superbuild</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#bootstrapping-basis">Bootstrapping BASIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#superbuild-of-other-dependencies">Superbuild of other Dependencies</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#nested-superbuild-of-basis-and-other-dependencies">Nested Superbuild of BASIS and other Dependencies</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/configure-project.html#test-configuration">Test Configuration</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#cdash">CDash</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#code-coverage">Code Coverage</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/configure-project.html#installation">Installation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#prefix">Prefix</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/configure-project.html#rpath">RPATH</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/configure-project.html#redistributable-files">Redistributable Files</a></li>
</ul>
</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><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/document.html#documentation-quick-start">Documentation Quick Start</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/document.html#writing-documentation">Writing Documentation</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/document.html#generating-documentation">Generating Documentation</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/document.html#serving-website-locally">Serving Website Locally</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/document.html#doxygen-documentation">Doxygen Documentation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/document.html#language-support">Language Support</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/document.html#doxygen-filters">Doxygen Filters</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/document.html#generating-doxygen">Generating Doxygen</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/document.html#sphinx-documentation">Sphinx Documentation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/document.html#output-formats">Output Formats</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/document.html#themes">Themes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/document.html#markdown">Markdown</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/document.html#creating-documentation">Creating Documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/document.html#software-manual">Software Manual</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/document.html#developer-s-guide">Developer&#8217;s Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/document.html#api-documentation">API Documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/document.html#software-web-site">Software Web Site</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="howto/branch-and-release.html">Branch and Release</a><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/branch-and-release.html#branching-and-merging">Branching and Merging</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/branch-and-release.html#releasing-software">Releasing Software</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="howto/package.html">Packaging Software</a><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/package.html#distribution-of-sources">Distribution of Sources</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="howto/install.html">Install any Software</a><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/install.html#build-steps-overview">Build Steps Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/install.html#build-steps">Build Steps</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/install.html#prerequisites">Prerequisites</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/install.html#required-packages">Required Packages</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/install.html#optional-packages">Optional Packages</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/install.html#build-and-installation">Build and Installation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/install.html#package-names">Package Names</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/install.html#binary-distribution-package">Binary Distribution Package</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/install.html#building-from-sources">Building From Sources</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/install.html#deinstallation">Deinstallation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/install.html#makefile-based-uninstall">Makefile-based Uninstall</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/install.html#uninstaller-script">Uninstaller Script</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="howto/run-automated-tests.html">Automated Testing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/run-automated-tests.html#the-basistest-family-of-scripts">The basistest family of scripts</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/run-automated-tests.html#basistest-cron">basistest-cron</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/run-automated-tests.html#basistest-master">basistest-master</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/run-automated-tests.html#basistest-slave">basistest-slave</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/run-automated-tests.html#basistest-svn">basistest-svn</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="howto/run-automated-tests.html#cdash-integration">CDash Integration</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/run-automated-tests.html#administration-of-software-testing">Administration of Software Testing</a><ul>
<li class="toctree-l4"><a class="reference internal" href="howto/run-automated-tests.html#initial-basis-installation">Initial BASIS Installation</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/run-automated-tests.html#updating-the-basis-installation">Updating the BASIS Installation</a></li>
<li class="toctree-l4"><a class="reference internal" href="howto/run-automated-tests.html#configuring-test-jobs">Configuring Test Jobs</a></li>
</ul>
</li>
</ul>
</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><ul>
<li class="toctree-l3"><a class="reference internal" href="standard/fhs.html#source-code-repository">Source Code Repository</a><ul>
<li class="toctree-l4"><a class="reference internal" href="standard/fhs.html#git">Git</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/fhs.html#mercurial">Mercurial</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/fhs.html#subversion">Subversion</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="standard/fhs.html#source-code-tree">Source Code Tree</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/fhs.html#build-tree">Build Tree</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/fhs.html#installation-tree">Installation Tree</a><ul>
<li class="toctree-l4"><a class="reference internal" href="standard/fhs.html#installation-schemes">Installation Schemes</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/fhs.html#possible-schemes">Possible Schemes</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/fhs.html#forcing-schemes">Forcing Schemes</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="standard/template.html">Project Template</a><ul>
<li class="toctree-l3"><a class="reference internal" href="standard/template.html#standard-project-files">Standard Project Files</a><ul>
<li class="toctree-l4"><a class="reference internal" href="standard/template.html#file-formats">File Formats</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/template.html#required-project-files">Required Project Files</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/template.html#common-project-files">Common Project Files</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/template.html#cmakelists-txt-build-files">CMakeLists.txt Build Files</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/template.html#documenation-files">Documenation Files</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/template.html#advanced-project-files">Advanced Project Files</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="standard/template.html#template-layout">Template Layout</a><ul>
<li class="toctree-l4"><a class="reference internal" href="standard/template.html#template-versions">Template Versions</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/template.html#custom-substitutions">Custom Substitutions</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="standard/modules.html">Project Modularization</a><ul>
<li class="toctree-l3"><a class="reference internal" href="standard/modules.html#filesystem-layout">Filesystem Layout</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/modules.html#dependency-requirements">Dependency Requirements</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/modules.html#module-cmake-variables">Module CMake Variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/modules.html#implementation">Implementation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="standard/modules.html#origin">Origin</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="standard/modules.html#reuse">Reuse</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/modules.html#superbuild">Superbuild</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="standard/scripttargets.html">Build of Script Targets</a><ul>
<li class="toctree-l3"><a class="reference internal" href="standard/scripttargets.html#prerequisites-and-build-steps">Prerequisites and Build Steps</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/scripttargets.html#script-configuration">Script Configuration</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="standard/cmdline.html">Command-line Parsing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="standard/cmdline/cxx.html">C++</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/cmdline/bash.html">Bash</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="standard/execution.html">Calling Conventions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="standard/execution.html#purpose">Purpose</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/execution.html#relative-vs-absolute-paths">Relative vs. Absolute Paths</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/execution.html#file-vs-target-name">File vs. Target Name</a></li>
<li class="toctree-l3"><a class="reference internal" href="standard/execution.html#search-paths">Search Paths</a><ul>
<li class="toctree-l4"><a class="reference internal" href="standard/execution.html#unix">Unix</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/execution.html#windows">Windows</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="standard/execution.html#implementation">Implementation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="standard/execution.html#c">C++</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/execution.html#java">Java</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/execution.html#python">Python</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/execution.html#perl">Perl</a></li>
<li class="toctree-l4"><a class="reference internal" href="standard/execution.html#bash">Bash</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="standard/execution.html#unsupported-languages">Unsupported Languages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="standard/execution.html#matlab">MATLAB</a></li>
</ul>
</li>
</ul>
</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>
</ul>
</div>
</div>
<div class="section" id="download-and-installation">
<h2>Download and Installation<a class="headerlink" href="#download-and-installation" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-3-3-1-feb-2-2017">Release 3.3.1 (Feb 2, 2017)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-3-3-0-apr-19-2016">Release 3.3.0 (Apr 19, 2016)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-3-2-0-oct-16-2015">Release 3.2.0 (Oct 16, 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-3-1-0-mar-28-2014">Release 3.1.0 (Mar 28, 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-3-0-0-jan-15-2014">Release 3.0.0 (Jan 15, 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-2-1-4-apr-20-2013">Release 2.1.4 (Apr 20, 2013)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-2-1-3-mar-1-2013">Release 2.1.3 (Mar 1, 2013)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-2-1-2-oct-31-2012">Release 2.1.2 (Oct 31, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-2-1-1-oct-25-2012">Release 2.1.1 (Oct 25, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-2-1-0-sep-20-2012">Release 2.1.0 (Sep 20, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-2-0-1-sep-17-2012">Release 2.0.1 (Sep 17, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-2-0-0-aug-28-2012">Release 2.0.0 (Aug 28, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-1-3-0-jun-5-2012">Release 1.3.0 (Jun 5, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-1-2-3-apr-12-2012">Release 1.2.3 (Apr 12, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-1-2-2-apr-4-2012">Release 1.2.2 (Apr 4, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-1-2-1-mar-21-2012">Release 1.2.1 (Mar 21, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-1-2-0-feb-29-2012">Release 1.2.0 (Feb 29, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-1-0-0-feb-18-2012">Release 1.0.0 (Feb 18, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-1-0-0rc1-dec-16-2011">Release 1.0.0rc1 (Dec 16, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-3-0-nov-22-2011">Pre-Release 0.3.0 (Nov 22, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-2-2-nov-4-2011">Pre-Release 0.2.2 (Nov 4, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-2-1-nov-3-2011">Pre-Release 0.2.1 (Nov 3, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-2-0-nov-2-2011">Pre-Release 0.2.0 (Nov 2, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-1-8-oct-31-2011">Pre-Release 0.1.8 (Oct 31, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-1-7-oct-31-2011">Pre-Release 0.1.7 (Oct 31, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-1-6-oct-31-2011">Pre-Release 0.1.6 (Oct 31, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-1-5-oct-18-2011">Pre-Release 0.1.5 (Oct 18, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-1-4-oct-14-2011">Pre-Release 0.1.4 (Oct 14, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-1-3-oct-13-2011">Pre-Release 0.1.3 (Oct 13, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-1-2-oct-13-2011">Pre-Release 0.1.2 (Oct 13, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-1-1-oct-12-2011">Pre-Release 0.1.1 (Oct 12, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#pre-release-0-1-0-oct-5-2011">Pre-Release 0.1.0 (Oct 5, 2011)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="download.html">Download</a><ul>
<li class="toctree-l2"><a class="reference internal" href="download.html#source-code">Source Code</a><ul>
<li class="toctree-l3"><a class="reference internal" href="download.html#system-requirements">System Requirements</a></li>
<li class="toctree-l3"><a class="reference internal" href="download.html#software-license">Software License</a></li>
<li class="toctree-l3"><a class="reference internal" href="download.html#package-content">Package Content</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="download.html#documentation">Documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#prerequisites">Prerequisites</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#required-packages">Required Packages</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#optional-packages">Optional Packages</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#build-and-installation">Build and Installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#build-steps">Build Steps</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#cmake-options">CMake Options</a><ul>
<li class="toctree-l4"><a class="reference internal" href="install.html#advanced-cmake-options">Advanced CMake Options</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#set-up-the-environment">Set up the Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#deinstallation">Deinstallation</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="support">
<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<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><ul>
<li class="toctree-l3"><a class="reference internal" href="help.html#standard-cmake-commands">Standard CMake Commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="help.html#cmake-package-configuration">CMake Package Configuration</a></li>
<li class="toctree-l3"><a class="reference internal" href="help.html#export-of-build-targets">Export of Build Targets</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about.html#history">History</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#purpose">Purpose</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#people">People</a></li>
</ul>
</li>
</ul>
</div>
</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="#">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>