Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 60 lines (59 sloc) 1.842 kB
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
1 .\" Generated with Ronnjs/v0.1
2 .\" http://github.com/kapouer/ronnjs/
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't requi…
isaacs authored
3 .
1787b66 @isaacs make doc
isaacs authored
4 .TH "NPM\-FOLDERS" "1" "January 2011" "" ""
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't requi…
isaacs authored
5 .
6 .SH "NAME"
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
7 \fBnpm-folders\fR \-\- Folder Structures Used by npm
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't requi…
isaacs authored
8 .
9 .SH "DESCRIPTION"
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
10 Everything lives in the \fBroot\fR setting\. Check \fBnpm help config\fR for more
11 on configuration options\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't requi…
isaacs authored
12 .
13 .P
e937a72 @isaacs Update all man pages using new version of ronn
isaacs authored
14 \fBroot/\.npm/foo\fR is where the stuff for package \fBfoo\fR would go\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't requi…
isaacs authored
15 .
16 .P
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
17 \fBroot/\.npm/foo/1\.0\.0/package\fR the contents of the tarball containing foo
18 version 1\.0\.0
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't requi…
isaacs authored
19 .
20 .P
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
21 \fBroot/\.npm/foo/1\.0\.0/main\.js\fR Generated file that exports the \fBmain\fR module in
22 foo\. This is a shim, not a symbolic link, so that relative paths will work
23 appropriately\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't requi…
isaacs authored
24 .
25 .P
c5288e3 @isaacs make doc
isaacs authored
26 \fBroot/foo\-1\.0\.0/{module\-name}\.js\fR Generated shim corresponding to a module
27 defined in the modules option\. The module shim requires \fBroot/\.npm/foo/1\.0\.0/package/{module\-path}\.js\fR
28 .
29 .P
30 The \fBmain\fR script is implemented by creating an \fBindex\.js\fR file in this folder\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't requi…
isaacs authored
31 .
32 .P
c5288e3 @isaacs make doc
isaacs authored
33 \fBroot/foo/\fR Symlink to the active version\'s module folder\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't requi…
isaacs authored
34 .
35 .P
c5288e3 @isaacs make doc
isaacs authored
36 \fBroot/\.npm/foo/active\fR symlink to the active version\.
319b63a @isaacs update folders doc
isaacs authored
37 .
38 .P
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
39 \fBroot/\.npm/foo/1\.0\.0/dependencies\fR links to the modules that foo depends upon\.
40 This is loaded into the require path first in the foo shims\.
319b63a @isaacs update folders doc
isaacs authored
41 .
42 .P
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
43 \fBroot/\.npm/foo/1\.0\.0/dependson\fR links to the package folders that foo depends
44 on\. This is here so that npm can access those packages programmatically\.
319b63a @isaacs update folders doc
isaacs authored
45 .
46 .P
47 \fBroot/\.npm/foo/1\.0\.0/dependents\fR links to the packages that depend upon foo\.
48 .
49 .P
50 \fBroot/\.npm/\.cache\fR the cache folder\.
51 .
52 .P
53 \fBroot/\.npm/\.cache/foo/1\.0\.0/package\.json\fR the parsed package\.json for foo@1\.0\.0
54 .
55 .P
56 \fBroot/\.npm/\.cache/foo/1\.0\.0/package\.tgz\fR the tarball of foo@1\.0\.0
57 .
58 .P
59 \fBroot/\.npm/\.cache/foo/1\.0\.0/package\fR the untouched pristine copy of foo@1\.0\.0
Something went wrong with that request. Please try again.