Change the way npm help works, so that it will work with man programs…

… that stubbornly refuse to take a troff file as an argument That is, make it work on Solaris.
npm · Sep 21, 2010 · dbee5c3 · dbee5c3
1 parent f9071cf
commit dbee5c3
Show file tree

Hide file tree

Showing 38 changed files with 19 additions and 11 deletions.
diff --git a/Makefile b/Makefile
@@ -1,10 +1,10 @@
 
 docs = $(shell find doc -name '*.md' \
 				|sed 's|.md|.1|g' \
-				|sed 's|doc/|man/|g' \
+				|sed 's|doc/|man1/|g' \
 				)
 doc_subfolders = $(shell find doc -type d \
-									|sed 's|doc/|man/|g' \
+									|sed 's|doc/|man1/|g' \
 									)
 
 install:
@@ -23,20 +23,23 @@ uninstall:
 	node cli.js cache clean
 	node cli.js rm npm
 
-man: $(doc_subfolders)
+man: man1
-	@if ! test -d man ; then mkdir -p man ; fi
+	@true
+
+man1: $(doc_subfolders)
+	@if ! test -d man1 ; then mkdir -p man1 ; fi
 
-doc: man $(docs)
+doc: man1 $(docs)
 	@true
 
 # use `npm install ronn` for this to work.
-man/%.1: doc/%.md
+man1/%.1: doc/%.md
 	ronn --roff $< > $@
 
-man/%/: doc/%/
+man1/%/: doc/%/
 	@if ! test -d $@ ; then mkdir -p $@ ; fi
 
 test:
 	./test/run.sh
 
-.PHONY: install install-dev link doc clean uninstall test
+.PHONY: install install-dev link doc clean uninstall test man
diff --git a/lib/help.js b/lib/help.js
@@ -7,8 +7,13 @@ module.exports = help
 
 function help (args, cb) {
   var section = args.shift() || "help"
-  fs.stat(path.join(__dirname, "../man/"+section+".1"), function (e, o) {
+  fs.stat(path.join(__dirname, "../man1/"+section+".1"), function (e, o) {
     if (e) return cb(new Error("Help section not found: "+section))
-    exec("man", [path.join(__dirname, "../man/"+section+".1")], cb)
+    // function exec (cmd, args, env, takeOver, cb) {
+    var manpath = path.join(__dirname, "..")
+      , env = {}
+    Object.keys(process.env).forEach(function (i) { env[i] = process.env[i] })
+    env.MANPATH = manpath
+    exec("man", [section], env, true, cb)
   })
 }
diff --git a/man/activate.1 → man1/activate.1 b/man/activate.1 → man1/activate.1
diff --git a/man/adduser.1 → man1/adduser.1 b/man/adduser.1 → man1/adduser.1
diff --git a/man/build.1 → man1/build.1 b/man/build.1 → man1/build.1
diff --git a/man/bundle.1 → man1/bundle.1 b/man/bundle.1 → man1/bundle.1
diff --git a/man/cache.1 → man1/cache.1 b/man/cache.1 → man1/cache.1
diff --git a/man/coding-style.1 → man1/coding-style.1 b/man/coding-style.1 → man1/coding-style.1
diff --git a/man/config.1 → man1/config.1 b/man/config.1 → man1/config.1
diff --git a/man/deactivate.1 → man1/deactivate.1 b/man/deactivate.1 → man1/deactivate.1
diff --git a/man/developers.1 → man1/developers.1 b/man/developers.1 → man1/developers.1
diff --git a/man/folders.1 → man1/folders.1 b/man/folders.1 → man1/folders.1
diff --git a/man/future-ideas/deploy.1 → man1/future-ideas/deploy.1 b/man/future-ideas/deploy.1 → man1/future-ideas/deploy.1
diff --git a/man/future-ideas/remote.1 → man1/future-ideas/remote.1 b/man/future-ideas/remote.1 → man1/future-ideas/remote.1
diff --git a/man/future-ideas/site.1 → man1/future-ideas/site.1 b/man/future-ideas/site.1 → man1/future-ideas/site.1
diff --git a/man/help.1 → man1/help.1 b/man/help.1 → man1/help.1
diff --git a/man/install.1 → man1/install.1 b/man/install.1 → man1/install.1
diff --git a/man/json.1 → man1/json.1 b/man/json.1 → man1/json.1
diff --git a/man/link.1 → man1/link.1 b/man/link.1 → man1/link.1
diff --git a/man/list.1 → man1/list.1 b/man/list.1 → man1/list.1
diff --git a/man/ln.1 → man1/ln.1 b/man/ln.1 → man1/ln.1
diff --git a/man/ls.1 → man1/ls.1 b/man/ls.1 → man1/ls.1
diff --git a/man/npm.1 → man1/npm.1 b/man/npm.1 → man1/npm.1
diff --git a/man/owner.1 → man1/owner.1 b/man/owner.1 → man1/owner.1
diff --git a/man/publish.1 → man1/publish.1 b/man/publish.1 → man1/publish.1
diff --git a/man/rebuild.1 → man1/rebuild.1 b/man/rebuild.1 → man1/rebuild.1
diff --git a/man/restart.1 → man1/restart.1 b/man/restart.1 → man1/restart.1
diff --git a/man/rm.1 → man1/rm.1 b/man/rm.1 → man1/rm.1
diff --git a/man/scripts.1 → man1/scripts.1 b/man/scripts.1 → man1/scripts.1
diff --git a/man/start.1 → man1/start.1 b/man/start.1 → man1/start.1
diff --git a/man/stop.1 → man1/stop.1 b/man/stop.1 → man1/stop.1
diff --git a/man/tag.1 → man1/tag.1 b/man/tag.1 → man1/tag.1
diff --git a/man/test.1 → man1/test.1 b/man/test.1 → man1/test.1
diff --git a/man/uninstall.1 → man1/uninstall.1 b/man/uninstall.1 → man1/uninstall.1
diff --git a/man/unpublish.1 → man1/unpublish.1 b/man/unpublish.1 → man1/unpublish.1
diff --git a/man/update.1 → man1/update.1 b/man/update.1 → man1/update.1
diff --git a/man/view.1 → man1/view.1 b/man/view.1 → man1/view.1
diff --git a/package.json b/package.json
@@ -27,7 +27,7 @@
   { "mail" : "npm-@googlegroups.com"
   , "web" : "http://github.com/isaacs/npm/issues"
   }
-, "directories" : { "doc" : "./doc", "man" : "./man", "lib" : "./lib" }
+, "directories" : { "doc" : "./doc", "man" : "./man1", "lib" : "./lib" }
 , "bin" : { "npm" : "./cli.js" }
 , "main" : "npm"
 , "engines" : { "node" : ">=0.2.0" }