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/man1
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2011-04-13 22:56:28 +0400
committerisaacs <i@izs.me>2011-04-13 22:56:28 +0400
commit8d77a8a2935e0150d670d7dda59168a41d54d584 (patch)
tree5d48b3edadbf1c8811e4a825afe6782ffcb179e8 /man1
parenta1c7cb48f3ce641872434c13950decb975cdb1b8 (diff)
Update docs about new linking behavior
Diffstat (limited to 'man1')
-rw-r--r--man1/link.133
-rw-r--r--man1/ln.133
2 files changed, 64 insertions, 2 deletions
diff --git a/man1/link.1 b/man1/link.1
index f3fbfab35..89e3d35ce 100644
--- a/man1/link.1
+++ b/man1/link.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-LINK" "1" "March 2011" "" ""
+.TH "NPM\-LINK" "1" "April 2011" "" ""
.
.SH "NAME"
\fBnpm-link\fR \-\- Symlink a package folder
@@ -52,3 +52,34 @@ npm link redis # link\-install the package
.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\.
diff --git a/man1/ln.1 b/man1/ln.1
index f3fbfab35..89e3d35ce 100644
--- a/man1/ln.1
+++ b/man1/ln.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-LINK" "1" "March 2011" "" ""
+.TH "NPM\-LINK" "1" "April 2011" "" ""
.
.SH "NAME"
\fBnpm-link\fR \-\- Symlink a package folder
@@ -52,3 +52,34 @@ npm link redis # link\-install the package
.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\.