aboutsummaryrefslogtreecommitdiffstats
path: root/lib/observer/doc/src/observer.xml
blob: 03830f2b1ceafee9cf725f9eccc542d15ecfc9c5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<erlref>
  <header>
    <copyright>
      <year>2011</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.

  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>