From 9f07a690c6cb6d773e9e4c4a37e46a3732c9668c Mon Sep 17 00:00:00 2001 From: Ryan Dahl Date: Mon, 28 Sep 2009 18:03:43 +0200 Subject: [PATCH] docs: Reference node.libraryPaths in helpers section. --- doc/api.html | 21 ++++++++++++++++++++- doc/api.txt | 7 +++++++ doc/api.xml | 23 +++++++++++++++++++++++ doc/node.1 | 13 +++++++++++++ 4 files changed, 63 insertions(+), 1 deletion(-) diff --git a/doc/api.html b/doc/api.html index fe985109fa..6ac33796ec 100644 --- a/doc/api.html +++ b/doc/api.html @@ -80,6 +80,25 @@ Returns the current working directory of the process. The filename of the script being executed.

+
+require(path) +
+
+include(path) +
+
+

+See the modules section. +

+
+
+node.libraryPaths +
+
+

+The search path for absolute path arguments to require() and include(). +

+

The process Object

process is the equivalent of window in browser-side javascript. It is @@ -1983,7 +2002,7 @@ init (Handle<Object> target)

diff --git a/doc/api.txt b/doc/api.txt index 38aef8e01a..e904ec9321 100644 --- a/doc/api.txt +++ b/doc/api.txt @@ -56,6 +56,13 @@ Returns the current working directory of the process. +__filename+ :: The filename of the script being executed. ++require(path)+ :: ++include(path)+ :: +See the modules section. + ++node.libraryPaths+ :: +The search path for absolute path arguments to +require()+ and +include()+. + === The +process+ Object +process+ is the equivalent of +window+ in browser-side javascript. It is diff --git a/doc/api.xml b/doc/api.xml index 02e0dab99b..e1677b2ea1 100644 --- a/doc/api.xml +++ b/doc/api.xml @@ -57,6 +57,29 @@ The filename of the script being executed. + + +require(path) + + +include(path) + + + +See the modules section. + + + + + +node.libraryPaths + + + +The search path for absolute path arguments to require() and include(). + + + diff --git a/doc/node.1 b/doc/node.1 index 3f5663a80a..5c6db437ad 100644 --- a/doc/node.1 +++ b/doc/node.1 @@ -54,6 +54,19 @@ __filename .RS 4 The filename of the script being executed\. .RE +.PP +require(path), include(path) +.RS 4 +See the modules section\. +.RE +.PP +node\.libraryPaths +.RS 4 +The search path for absolute path arguments to +require() +and +include()\. +.RE .SS "The process Object" process is the equivalent of window in browser\-side javascript\. It is the global scope\. process is an instance of node\.EventEmitter\. .sp