From d3d35ec3ca63c8e39996c4a9b5f0e3a0d276dcd5 Mon Sep 17 00:00:00 2001
From: Ryan Dahl <ry@tinyclouds.org>
Date: Mon, 18 Apr 2011 16:52:53 -0700
Subject: [PATCH] add docs for console object

---
 doc/api/_toc.markdown    |  1 +
 doc/api/all.markdown     |  1 +
 doc/api/globals.markdown |  5 +++++
 doc/api/stdio.markdown   | 51 ++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 58 insertions(+)
 create mode 100644 doc/api/stdio.markdown

diff --git a/doc/api/_toc.markdown b/doc/api/_toc.markdown
index 23df879..5841966 100644
--- a/doc/api/_toc.markdown
+++ b/doc/api/_toc.markdown
@@ -2,6 +2,7 @@
 
 * [Synopsis](synopsis.html)
 * [Globals](globals.html)
+* [STDIO](stdio.html)
 * [Timers](timers.html)
 * [Modules](modules.html)
 * [C/C++ Addons](addons.html)
diff --git a/doc/api/all.markdown b/doc/api/all.markdown
index fe12ef7..5498d17 100644
--- a/doc/api/all.markdown
+++ b/doc/api/all.markdown
@@ -1,6 +1,7 @@
 
 @include synopsis
 @include globals
+@include stdio
 @include timers
 @include modules
 @include addons
diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown
index 364a703..8acecea 100644
--- a/doc/api/globals.markdown
+++ b/doc/api/globals.markdown
@@ -16,6 +16,11 @@ scope; `var something` inside a Node module will be local to that module.
 
 The process object. See the [process object](process.html#process) section.
 
+### console
+
+Used to print to stdout and stderr. See the [stdio](stdio.html) section.
+
+
 ### require()
 
 To require modules. See the [Modules](modules.html#modules) section.
diff --git a/doc/api/stdio.markdown b/doc/api/stdio.markdown
new file mode 100644
index 0000000..a24d057
--- /dev/null
+++ b/doc/api/stdio.markdown
@@ -0,0 +1,51 @@
+## console
+
+Browser-like object for printing to stdout and stderr.
+
+### console.log()
+
+Prints to stdout with newline. This function can take multiple arguments in a
+`printf()`-like way. Example:
+
+    console.log('count: %d', count);
+
+If formating elements are not found in the first string then `util.inspect`
+is used on each argument.
+
+### console.info()
+
+Same as `console.log`.
+
+### console.warn()
+### console.error()
+
+Same as `console.log` but prints to stderr.
+
+### console.dir(obj)
+
+Uses `util.inspect` on `obj` and prints resulting string to stderr.
+
+### console.time(label)
+
+Mark a time.
+
+
+### console.timeEnd(label)
+
+Finish timer, record output. Example
+
+    console.time('100-elements');
+    while (var i = 0; i < 100; i++) {
+      ;
+    }
+    console.timeEnd('100-elements');
+
+
+### console.trace()
+
+Print a stack trace to stderr of the current position.
+
+### console.assert()
+
+Same as `assert.ok()`.
+
-- 
2.7.4