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

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

<comref>
  <header>
    <copyright>
      <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>The cdv program</title>
    <prepared>Siri Hansen</prepared>
    <responsible>Siri Hansen</responsible>
    <docno></docno>
    <approved></approved>
    <checked></checked>
    <date>2013-10-015</date>
    <rev>PA1</rev>
    <file>cdv.xml</file>
  </header>
  <com>cdv</com>
  <comsummary>Script used for starting the Crashdump Viewer from the
  OS command line.
  </comsummary>

  <description>
    <p>The <c>cdv</c> shell script can be found under the <c>priv</c>
    directory of the <c>observer</c> application. The script is used
    for starting the Crashdump Viewer tool from the OS command
    line.</p>
    <p>For Windows users, <c>cdv.bat</c> can be found in the same
    location.</p>
  </description>

  <funcs>
    <func>
      <name>cdv [file]</name>
      <fsummary>Start the Crashdump Viewer and load the given file.</fsummary>
      <desc>
	<p>The <c>file</c> arguments is optional. If not given, a file
	dialog will pop up allowing the user to select a crashdump
	from the file system.</p>
      </desc>
    </func>
  </funcs>

</comref>