summaryrefslogtreecommitdiff
path: root/deps/npm/man/man1/npm-link.1
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2013-07-12 08:56:59 -0700
committerisaacs <i@izs.me>2013-07-12 08:56:59 -0700
commit9da67fa5198f3c0839904ae05cbfe88c61b3ad09 (patch)
tree61c03f98b7c2ae549f67c01e1afe6dcbe84847d6 /deps/npm/man/man1/npm-link.1
parentf88b8dad84cd8f37000e55f0b5de7963cbb252cf (diff)
downloadnode-new-9da67fa5198f3c0839904ae05cbfe88c61b3ad09.tar.gz
npm: Upgrade to 1.3.3
Diffstat (limited to 'deps/npm/man/man1/npm-link.1')
-rw-r--r--deps/npm/man/man1/npm-link.1118
1 files changed, 118 insertions, 0 deletions
diff --git a/deps/npm/man/man1/npm-link.1 b/deps/npm/man/man1/npm-link.1
new file mode 100644
index 0000000000..d972d85480
--- /dev/null
+++ b/deps/npm/man/man1/npm-link.1
@@ -0,0 +1,118 @@
+.\" Generated with Ronnjs 0.3.8
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-LINK" "1" "July 2013" "" ""
+.
+.SH "NAME"
+\fBnpm-link\fR \-\- Symlink a package folder
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm link (in package folder)
+npm link <pkgname>
+.
+.fi
+.
+.SH "DESCRIPTION"
+Package linking is a two\-step process\.
+.
+.P
+First, \fBnpm link\fR in a package folder will create a globally\-installed
+symbolic link from \fBprefix/package\-name\fR to the current folder\.
+.
+.P
+Next, in some other location, \fBnpm link package\-name\fR will create a
+symlink from the local \fBnode_modules\fR folder to the global symlink\.
+.
+.P
+Note that \fBpackage\-name\fR is taken from \fBpackage\.json\fR ,
+not from directory name\.
+.
+.P
+When creating tarballs for \fBnpm publish\fR, the linked packages are
+"snapshotted" to their current state by resolving the symbolic links\.
+.
+.P
+This is
+handy for installing your own stuff, so that you can work on it and test it
+iteratively without having to continually rebuild\.
+.
+.P
+For example:
+.
+.IP "" 4
+.
+.nf
+cd ~/projects/node\-redis # go into the package directory
+npm link # creates global link
+cd ~/projects/node\-bloggy # go into some other package directory\.
+npm link redis # link\-install the package
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Now, any changes to ~/projects/node\-redis will be reflected in
+~/projects/node\-bloggy/node_modules/redis/
+.
+.P
+You may also shortcut the two steps in one\. For example, to do the
+above use\-case in a shorter way:
+.
+.IP "" 4
+.
+.nf
+cd ~/projects/node\-bloggy # go into the dir of your main project
+npm link \.\./node\-redis # link the dir of your dependency
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The second line is the equivalent of doing:
+.
+.IP "" 4
+.
+.nf
+(cd \.\./node\-redis; npm link)
+npm link redis
+.
+.fi
+.
+.IP "" 0
+.
+.P
+That is, it first creates a global link, and then links the global
+installation target into your project\'s \fBnode_modules\fR folder\.
+.
+.SH "SEE ALSO"
+.
+.IP "\(bu" 4
+npm help developers
+.
+.IP "\(bu" 4
+npm help faq
+.
+.IP "\(bu" 4
+npm help package\.json
+.
+.IP "\(bu" 4
+npm help install
+.
+.IP "\(bu" 4
+npm help folders
+.
+.IP "\(bu" 4
+npm help config
+.
+.IP "\(bu" 4
+npm help config
+.
+.IP "\(bu" 4
+npm help npmrc
+.
+.IP "" 0
+