From fda63b0568f052cf61b21e2a8e950b7dba1024e3 Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Thu, 24 Feb 2011 13:23:45 +0100
Subject: Document new cdv script and cdv.bat file for starting crashdump
 viewer

---
 lib/observer/doc/src/crashdump_ug.xml | 44 ++++++++++++++++++++++++-----------
 1 file changed, 30 insertions(+), 14 deletions(-)

(limited to 'lib/observer/doc/src/crashdump_ug.xml')

diff --git a/lib/observer/doc/src/crashdump_ug.xml b/lib/observer/doc/src/crashdump_ug.xml
index 9913b30e38..dc65fe5b39 100644
--- a/lib/observer/doc/src/crashdump_ug.xml
+++ b/lib/observer/doc/src/crashdump_ug.xml
@@ -4,7 +4,7 @@
 <chapter>
   <header>
     <copyright>
-      <year>2003</year><year>2009</year>
+      <year>2003</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -38,12 +38,31 @@
 
   <section>
     <title>Getting Started</title>
-    <p>From an erlang node, start Crashdump Viewer by calling
-      <c>crashdump_viewer:start()</c>. This will automatically start
-      WebTool and display the web address where WebTool can be
-      found. See the documentation for the WebTool application for
-      further information about how to use WebTool.
-      </p>
+
+    <p>The easiest way to start Crashdump Viewer is to use the
+    provided shell script named <c>cdv</c> with the full path to the
+    erlang crashdump as an argument. The script can be found in the
+    priv directory of the <c>observer</c> application. This starts
+    WebTool, Crashdump Viewer and a web browser, and loads the given
+    file. The browser should then display a page named General
+    Information which shows a short summary of the information in
+    the crashdump.</p>
+
+    <p>The default browser is Internet Explorer on Windows or else
+    Firefox. To use another browser, give the browser's start command
+    as the second argument to <c>cdv</c>. If the given browser name is
+    not known to Crashdump Viewer, the browser argument is executed as
+    a command with the start URL as the only argument.</p>
+
+    <p>Under Windows the batch file <c>cdv.bat</c> can be used.</p>
+
+    <p>It is also possible to start the Crashdump Viewer from within
+    an erlang node by calling <seealso
+    marker="crashdump_viewer#start/0">crashdump_viewer:start/0</seealso>. This
+    will automatically start WebTool and display the web address where
+    WebTool can be found. See the documentation for the WebTool
+    application for further information about how to use WebTool.</p>
+
     <p>Point your web browser to the address displayed, and you should
       now see the start page of WebTool. At the top of the page, you
       will see a link to "CrashDumpViewer". Click this link to get to
@@ -52,15 +71,12 @@
       connection to the internet, or you must set no proxy for
       localhost.)
       </p>
-    <p>You can also start WebTool, Crashdump Viewer and a browser in
-      one go by running the <c>start_webtool</c> script found in the
-      <c>priv</c> directory of the WebTool application, e.g.
-            <br></br>
-<c>>start_webtool crashdump_viewer</c></p>
     <p>From the start page of Crashdump Viewer, push the "Load
       Crashdump" button to load a crashdump into the tool. Then enter
-      the filename of the crashdump in the entry field and push the "Ok"
-      button.
+      the filename of the crashdump in the entry field and push the
+      "Ok" button. This will bring you to the General Information
+      page, i.e. the same page as the <c>cdv</c> script will open in
+      the browser.
       </p>
     <p>Crashdumps generated by OTP R9C and later are loaded directly
       into the Crashdump Viewer, while dumps from earlier releases first
-- 
cgit v1.2.3