Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2010-08-23 05:44:53 +0400
committerisaacs <i@izs.me>2010-08-23 05:48:06 +0400
commitc5288e31d409b86d0324e8ebc3ef7e46dbe79003 (patch)
tree01f4cae9990f8568dfd1a951ecac706d385bd545 /man
parent6c3bf710da391f44c751449accf67c9251f6dbb2 (diff)
make doc
Diffstat (limited to 'man')
-rw-r--r--man/folders.110
-rw-r--r--man/json.121
-rw-r--r--man/npm.118
3 files changed, 31 insertions, 18 deletions
diff --git a/man/folders.1 b/man/folders.1
index 443d52f38..041560bd4 100644
--- a/man/folders.1
+++ b/man/folders.1
@@ -23,13 +23,17 @@ foo\. This is a shim, not a symbolic link, so that relative paths will work
appropriately\.
.
.P
-\fBroot/\.npm/foo/active\fR symlink to the active version\.
+\fBroot/foo\-1\.0\.0/{module\-name}\.js\fR Generated shim corresponding to a module
+defined in the modules option\. The module shim requires \fBroot/\.npm/foo/1\.0\.0/package/{module\-path}\.js\fR
+.
+.P
+The \fBmain\fR script is implemented by creating an \fBindex\.js\fR file in this folder\.
.
.P
-\fBroot/foo\-1\.0\.0\.js\fR shim to \fB\|\.npm/foo/1\.0\.0/main\.js\fR
+\fBroot/foo/\fR Symlink to the active version\'s module folder\.
.
.P
-\fBroot/foo\.js\fR shim to \fB\|\.npm/foo/active/main\.js\fR
+\fBroot/\.npm/foo/active\fR symlink to the active version\.
.
.P
\fBroot/\.npm/foo/1\.0\.0/dependencies\fR links to the modules that foo depends upon\.
diff --git a/man/json.1 b/man/json.1
index b296f53f0..f0cb2b2a5 100644
--- a/man/json.1
+++ b/man/json.1
@@ -77,22 +77,15 @@ This should be a module ID relative to the root of your package folder\.
.P
For most modules, it makes the most sense to have a main script\.
.
-.SH "directories"
-The "directories" member is an object hash of folders\.
-.
-.SS "directories\.lib"
-The only directory that npm cares about is the "lib" directory\. This is a folder
-that will be mapped to the package name\. So, if you had a package named \fBfoo\fR,
-and the package\.json contains \fB"directories":{"lib":"\./lib"}\fR, and there was
-a file called \fB\|\./lib/bar\.js\fR, then require("foo/bar") would include that module\.
-.
-.P
-This is handy if your package is a collection or library full of useful goodies\.
-However, dependency paths are not corrected for modules in the lib folder, so it\'s
-a bit more complicated\.
+.SH "modules"
+The "modules" member exposes CommonJS modules in the package\. So, if you had a
+package named \fBfoo\fR, and the package\.json contains \fB"modules":{"bar":"\./lib/baz"}\fR,
+and there was a file called \fB\|\./lib/baz\.js\fR, then require("foo/bar") would include
+the module defined in \fB\|\./lib/baz\.js\fR\|\.
.
.P
-Most of the time, delving into a package\'s folder is not as awesome\.
+Just like the \fBmain\fR script, the modules linked in this fashion will have their
+dependencies and paths set up properly by npm\.
.
.SH "scripts"
The "scripts" member is an object hash of script commands that are run
diff --git a/man/npm.1 b/man/npm.1
index b830a01c7..38059e9bc 100644
--- a/man/npm.1
+++ b/man/npm.1
@@ -341,7 +341,7 @@ Cascading configs: cli, env, user, global
First pass at \fBnpm view\fR command
.
.IP "\(bu" 4
-0\.1\.24:
+0\.1\.24, 0\.1\.25:
Fix a bunch of things
.
.br
@@ -350,5 +350,21 @@ Cleanup, etc\.
.br
help via \-\-help, \-h, or \-?
.
+.IP "\(bu" 4
+0\.1\.26:
+"modules" hash in package\.json (Alex K\. Wolfe)
+.
+.br
+Better "restart" command (Alex K Wolfe)
+.
+.br
+Work on Cygwin
+.
+.br
+Remove link packages properly
+.
+.br
+Make several commands more parallel
+.
.IP "" 0