commit 50e990c64fa23ce94efa76b9e72df7f8ec3cee6a
author Scott Main <smain@google.com> Thu Jun 21 17:14:39 2012 -0700
committer Scott Main <smain@google.com> Thu Jun 21 21:27:30 2012 -0700
tree 52605cd25e01763596477956963fabcd087054b0
parent a2860267cad115659018d636bf9203a644c680a7

Massive clobber of all HTML files in developer docs for new site design

Change-Id: Idc55a0b368c1d2c1e7d4999601b739dd57f08eb3

docs/html/tools/help/logcat.jd

diff --git a/docs/html/tools/help/logcat.jd b/docs/html/tools/help/logcat.jd
new file mode 100644
index 0000000..d504b22
--- /dev/null
+++ b/docs/html/tools/help/logcat.jd
@@ -0,0 +1,106 @@
+page.title=logcat
+parent.title=Tools
+parent.link=index.html
+@jd:body
+
+  <p>The Android logging system provides a mechanism for collecting and viewing system debug
+  output. Logs from various applications and portions of the system are collected in a series of
+  circular buffers, which then can be viewed and filtered by the <code>logcat</code> command. You can use 
+  <code>logcat</code> from an ADB shell to view the log messages.</p>
+
+  <p>This document is a reference to the available command line options. For more information on <code>logcat</code>, see
+  <a href="{@docRoot}tools/debugging/debugging-log.html">Reading and Writing Logs</a>.
+For more
+  information on accessing <code>logcat</code> from DDMS, instead of the command line, see the documentation for the
+  <a href="{@docRoot}tools/debugging/ddms.html">Dalvik Debug Monitor Server</a>.
+  </p>
+
+  <h3>Syntax</h3>
+  <pre>
+[adb] logcat [&lt;option&gt;] ... [&lt;filter-spec&gt;] ...
+</pre>
+
+  <p>You can run <code>logcat</code> as an adb command or directly in a shell prompt
+  of your emulator or connected device. To view log output using adb, navigate to your SDK
+  <code>platform-tools/</code> directory and execute:</p>
+  <pre>
+$ adb logcat
+</pre>
+
+  <p>You can create a shell connection to a device and execute:</p>
+  <pre>
+$ adb shell
+# logcat
+</pre>
+
+  <h3>Options</h3>
+  <p>The following table describes the command line options of <code>logcat</code>.</p>
+  
+  <table>
+    <tr>
+      <th>Option</th>
+
+      <th>Description</th>
+    </tr>
+
+    <tr>
+      <td><code>-b&nbsp;&lt;buffer&gt;</code></td>
+
+      <td>Loads an alternate log buffer for viewing, such as <code>event</code> or
+      <code>radio</code>. The <code>main</code> buffer is used by default. See <a href= 
+      "#alternativebuffers">Viewing Alternative Log Buffers</a>.</td>
+    </tr>
+
+    <tr>
+      <td><code>-c</code></td>
+
+      <td>Clears (flushes) the entire log and exits.</td>
+    </tr>
+
+    <tr>
+      <td><code>-d</code></td>
+
+      <td>Dumps the log to the screen and exits.</td>
+    </tr>
+
+    <tr>
+      <td><code>-f&nbsp;&lt;filename&gt;</code></td>
+
+      <td>Writes log message output to <code>&lt;filename&gt;</code>. The default is
+      <code>stdout</code>.</td>
+    </tr>
+
+    <tr>
+      <td><code>-g</code></td>
+
+      <td>Prints the size of the specified log buffer and exits.</td>
+    </tr>
+
+    <tr>
+      <td><code>-n&nbsp;&lt;count&gt;</code></td>
+
+      <td>Sets the maximum number of rotated logs to <code>&lt;count&gt;</code>. The default value
+      is 4. Requires the <code>-r</code> option.</td>
+    </tr>
+
+    <tr>
+      <td><code>-r&nbsp;&lt;kbytes&gt;</code></td>
+
+      <td>Rotates the log file every <code>&lt;kbytes&gt;</code> of output. The default value is
+      16. Requires the <code>-f</code> option.</td>
+    </tr>
+
+    <tr>
+      <td><code>-s</code></td>
+
+      <td>Sets the default filter spec to silent.</td>
+    </tr>
+
+    <tr>
+      <td><code>-v&nbsp;&lt;format&gt;</code></td>
+
+      <td>Sets the output format for log messages. The default is <code>brief</code> format. For a
+      list of supported formats, see <a href="#outputformat">Controlling Log Output
+      Format</a>.</td>
+    </tr>
+  </table>