path: root/lib/common_test/doc/src/install_chapter.xml

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">

<chapter>
  <header>
    <copyright>
      <year>2007</year><year>2013</year>
      <holder>Ericsson AB. All Rights Reserved.</holder>
    </copyright>
    <legalnotice>
      The contents of this file are subject to the Erlang Public License,
      Version 1.1, (the "License"); you may not use this file except in
      compliance with the License. You should have received a copy of the
      Erlang Public License along with this software. If not, it can be
      retrieved online at http://www.erlang.org/.

      Software distributed under the License is distributed on an "AS IS"
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
      the License for the specific language governing rights and limitations
      under the License.

    </legalnotice>

    <title>Installation</title>
    <prepared>Peter Andersson</prepared>
    <docno></docno>
    <date>2007-07-03</date>
    <rev></rev>
    <file>install_chapter.xml</file>
  </header>

  <section>
    <marker id="general"></marker>
    <title>General information</title>

    <p>The two main interfaces for running tests with Common Test
      are an executable program named <c>ct_run</c> and an
      erlang module named <c>ct</c>. The ct_run program
      is compiled for the underlying operating system (e.g. Unix/Linux
      or Windows) during the build of the Erlang/OTP system, and is
      installed automatically with other executable programs in
      the top level <c>bin</c> directory of Erlang/OTP.
      The <c>ct</c> interface functions can be called from the Erlang shell,
      or from any Erlang function, on any supported platform.</p>

    <p>The Common Test application is installed with the Erlang/OTP
      system and no additional installation step is required to start using
      Common Test by means of the <c>ct_run</c> executable program, and/or
      the interface functions in the <c>ct</c> module.</p>
    </section>
</chapter>