path: root/lib/observer/doc/src/observer.xml

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

<erlref>
  <header>
    <copyright>
      <year>2011</year><year>2013</year>
      <holder>Ericsson AB, All Rights Reserved</holder>
    </copyright>
    <legalnotice>
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
 
      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  The Initial Developer of the Original Code is Ericsson AB.
    </legalnotice>

    <title>Observer</title>
    <prepared>Dan Gudmundsson</prepared>
    <responsible></responsible>
    <docno>1</docno>
    <approved></approved>
    <checked></checked>
    <date>2011-12-08</date>
    <rev>PA1</rev>
    <file>observer.xml</file>
  </header>
  <module>observer</module>
  <modulesummary>A GUI tool for observing an erlang system.</modulesummary>
  <description>
    <p>The observer is gui frontend containing various tools to
    inspect a system.  It displays system information, application
    structures, process information, ets or mnesia tables and a frontend
    for tracing with <seealso marker="ttb">ttb</seealso>.
    </p>

    <p>See the <seealso marker="observer_ug">user's guide</seealso>
    for more information about how to get started.</p>
  </description>
  <funcs>
    <func>
      <name>start() -> ok</name>
      <fsummary>Start the observer gui</fsummary>
      <desc>
        <p>This function starts the <c>observer</c> gui.
	Close the window to stop the application.
	</p>
      </desc>
    </func>
  </funcs>
</erlref>