man1/folders.1


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-FOLDERS" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-folders\fR \-\- Folder Structures Used by npm
.
.SH "DESCRIPTION"
Node modules and metadata live
in the \fBroot\fR setting\.  Check \fBnpm help config\fR for more
on configuration options\.
.
.P
\fBroot/foo\fR Symlink to the active version\'s module folder\.
.
.P
\fBroot/foo@1\.0\.0/\fR Node modules for the foo package\.
.
.P
\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/\.npm/foo\fR is where the stuff for package \fBfoo\fR would go\.
.
.P
\fBroot/\.npm/foo/1\.0\.0/package\fR the contents of the tarball containing foo
version 1\.0\.0
.
.P
\fBroot/\.npm/foo/1\.0\.0/main\.js\fR Generated file that exports the \fBmain\fR module in
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\.
.
.P
\fBroot/\.npm/foo/1\.0\.0/node_modules\fR links to the modules that foo depends upon\.
This is loaded into the require path first in the foo shims\.
.
.P
\fBroot/\.npm/foo/1\.0\.0/dependson\fR links to the package folders that foo depends
on\.  This is here so that npm can access those packages programmatically\.
.
.P
\fBroot/\.npm/foo/1\.0\.0/dependents\fR links to the packages that depend upon foo\.
.
.P
\fBroot/\.npm/\.cache\fR the cache folder\.
.
.P
\fBroot/\.npm/\.cache/foo/1\.0\.0/package\.json\fR the parsed package\.json for foo@1\.0\.0
.
.P
\fBroot/\.npm/\.cache/foo/1\.0\.0/package\.tgz\fR the tarball of foo@1\.0\.0
.
.P
\fBroot/\.npm/\.cache/foo/1\.0\.0/package\fR the untouched pristine copy of foo@1\.0\.0
.
.P
Executables are installed to the folder specified by the \fBbinroot\fR config\.
.
.P
\fBbinroot/foo\fR Symlink to the active version of the "foo" executable\.
.
.P
\fBbinroot/foo@1\.0\.0\fR An executable for foo at version 1\.0\.0\.  Either a
symbolic link or a shim to a file in the foo package\.
.
.P
Man pages are installed to the folder specified by the \fBmanroot\fR config\.
Man pages named something other than the package name are prefixed with
the package name\.
.
.P
\fBmanroot/man1/foo\.1\fR Symlink to the section 1 manpage for the active
version of foo\.
.
.P
\fBmanroot/man1/foo@1\.0\.0\.1\fR Section 1 man page for foo version 1\.0\.0
.
.P
\fBmanroot/man8/foo\-bar\.8\fR Symlink to a section 8 manpage for the active
version of foo\.
.
.P
\fBmanroot/man8/foo\-bar@1\.0\.0\.8\fR A section 8 manpage for foo version
1\.0\.0\.
.
.SH "CONFIGURATION"
.
.SS "root"
Default: \fB$INSTALL_PREFIX/lib/node\fR
.
.P
The root folder where packages are installed and npm keeps its data\.
.
.SS "binroot"
Default: \fB$INSTALL_PREFIX/bin\fR
.
.P
The folder where executable programs are installed\.
.
.P
Set to "false" to not install executables
.
.SS "manroot"
Default: $INSTALL_PREFIX/share/man
.
.P
The folder where man pages are installed\.
.
.P
Set to "false" to not install man pages\.