diff --git a/Makefile b/Makefile index ade54f565d5..ea6eeca3762 100644 --- a/Makefile +++ b/Makefile @@ -1,12 +1,12 @@ SHELL = bash -cli_docs = $(shell find doc -name '*.md' \ +cli_docs = $(shell find doc/cli -name '*.md' \ |sed 's|.md|.1|g' \ - |sed 's|doc/|man1/|g' ) + |sed 's|doc/cli/|man/man1/|g' ) -api_docs = $(shell find api-doc -name '*.md' \ +api_docs = $(shell find doc/api -name '*.md' \ |sed 's|.md|.3|g' \ - |sed 's|api-doc/|man3/|g' ) + |sed 's|doc/api/|man/man3/|g' ) cli_doc_subfolders = $(shell find doc -type d \ |sed 's|doc/|man1/|g' ) @@ -41,31 +41,25 @@ clean: uninstall uninstall: submodules node cli.js rm npm -g -f -man: man1 man3 +doc: man -man1: $(cli_doc_subfolders) - [ -d man1 ] || mkdir -p man1 +man: man/man1 man/man3 -man3: $(api_doc_subfolders) - [ -d man3 ] || mkdir -p man3 +man/man1: $(cli_docs) + [ -d man/man1 ] || mkdir -p man/man1 -doc: man1 $(cli_docs) man3 $(api_docs) +man/man3: $(api_docs) + [ -d man/man3 ] || mkdir -p man/man3 # use `npm install ronn` for this to work. -man1/%.1: doc/%.md +man/man1/%.1: doc/cli/%.md @[ -x ./node_modules/.bin/ronn ] || node cli.js install ronn ./node_modules/.bin/ronn --roff $< > $@ -man1/%/: doc/%/ - @[ -d $@ ] || mkdir -p $@ - -man3/%.3: api-doc/%.md +man/man3/%.3: doc/api/%.md @[ -x ./node_modules/.bin/ronn ] || node cli.js install ronn ./node_modules/.bin/ronn --roff $< > $@ -man3/%/: api-doc/%/ - @[ -d $@ ] || mkdir -p $@ - test: submodules node cli.js test diff --git a/api-doc/author.md b/doc/api/author.md similarity index 100% rename from api-doc/author.md rename to doc/api/author.md diff --git a/api-doc/bin.md b/doc/api/bin.md similarity index 100% rename from api-doc/bin.md rename to doc/api/bin.md diff --git a/api-doc/commands.md b/doc/api/commands.md similarity index 100% rename from api-doc/commands.md rename to doc/api/commands.md diff --git a/api-doc/config.md b/doc/api/config.md similarity index 100% rename from api-doc/config.md rename to doc/api/config.md diff --git a/api-doc/deprecate.md b/doc/api/deprecate.md similarity index 100% rename from api-doc/deprecate.md rename to doc/api/deprecate.md diff --git a/api-doc/docs.md b/doc/api/docs.md similarity index 100% rename from api-doc/docs.md rename to doc/api/docs.md diff --git a/api-doc/edit.md b/doc/api/edit.md similarity index 100% rename from api-doc/edit.md rename to doc/api/edit.md diff --git a/api-doc/explore.md b/doc/api/explore.md similarity index 100% rename from api-doc/explore.md rename to doc/api/explore.md diff --git a/api-doc/find.md b/doc/api/find.md similarity index 100% rename from api-doc/find.md rename to doc/api/find.md diff --git a/api-doc/get.md b/doc/api/get.md similarity index 100% rename from api-doc/get.md rename to doc/api/get.md diff --git a/api-doc/help-search.md b/doc/api/help-search.md similarity index 100% rename from api-doc/help-search.md rename to doc/api/help-search.md diff --git a/api-doc/home.md b/doc/api/home.md similarity index 100% rename from api-doc/home.md rename to doc/api/home.md diff --git a/api-doc/init.md b/doc/api/init.md similarity index 100% rename from api-doc/init.md rename to doc/api/init.md diff --git a/api-doc/install.md b/doc/api/install.md similarity index 100% rename from api-doc/install.md rename to doc/api/install.md diff --git a/api-doc/link.md b/doc/api/link.md similarity index 100% rename from api-doc/link.md rename to doc/api/link.md diff --git a/api-doc/list.md b/doc/api/list.md similarity index 100% rename from api-doc/list.md rename to doc/api/list.md diff --git a/api-doc/ln.md b/doc/api/ln.md similarity index 100% rename from api-doc/ln.md rename to doc/api/ln.md diff --git a/api-doc/load.md b/doc/api/load.md similarity index 100% rename from api-doc/load.md rename to doc/api/load.md diff --git a/api-doc/ls.md b/doc/api/ls.md similarity index 100% rename from api-doc/ls.md rename to doc/api/ls.md diff --git a/api-doc/npm.md b/doc/api/npm.md similarity index 100% rename from api-doc/npm.md rename to doc/api/npm.md diff --git a/api-doc/outdated.md b/doc/api/outdated.md similarity index 100% rename from api-doc/outdated.md rename to doc/api/outdated.md diff --git a/api-doc/owner.md b/doc/api/owner.md similarity index 100% rename from api-doc/owner.md rename to doc/api/owner.md diff --git a/api-doc/pack.md b/doc/api/pack.md similarity index 100% rename from api-doc/pack.md rename to doc/api/pack.md diff --git a/api-doc/prefix.md b/doc/api/prefix.md similarity index 100% rename from api-doc/prefix.md rename to doc/api/prefix.md diff --git a/api-doc/prune.md b/doc/api/prune.md similarity index 100% rename from api-doc/prune.md rename to doc/api/prune.md diff --git a/api-doc/publish.md b/doc/api/publish.md similarity index 100% rename from api-doc/publish.md rename to doc/api/publish.md diff --git a/api-doc/rebuild.md b/doc/api/rebuild.md similarity index 100% rename from api-doc/rebuild.md rename to doc/api/rebuild.md diff --git a/api-doc/restart.md b/doc/api/restart.md similarity index 100% rename from api-doc/restart.md rename to doc/api/restart.md diff --git a/api-doc/rm.md b/doc/api/rm.md similarity index 100% rename from api-doc/rm.md rename to doc/api/rm.md diff --git a/api-doc/root.md b/doc/api/root.md similarity index 100% rename from api-doc/root.md rename to doc/api/root.md diff --git a/api-doc/run-script.md b/doc/api/run-script.md similarity index 100% rename from api-doc/run-script.md rename to doc/api/run-script.md diff --git a/api-doc/search.md b/doc/api/search.md similarity index 100% rename from api-doc/search.md rename to doc/api/search.md diff --git a/api-doc/set.md b/doc/api/set.md similarity index 100% rename from api-doc/set.md rename to doc/api/set.md diff --git a/api-doc/start.md b/doc/api/start.md similarity index 100% rename from api-doc/start.md rename to doc/api/start.md diff --git a/api-doc/stop.md b/doc/api/stop.md similarity index 100% rename from api-doc/stop.md rename to doc/api/stop.md diff --git a/api-doc/submodule.md b/doc/api/submodule.md similarity index 100% rename from api-doc/submodule.md rename to doc/api/submodule.md diff --git a/api-doc/tag.md b/doc/api/tag.md similarity index 100% rename from api-doc/tag.md rename to doc/api/tag.md diff --git a/api-doc/test.md b/doc/api/test.md similarity index 100% rename from api-doc/test.md rename to doc/api/test.md diff --git a/api-doc/uninstall.md b/doc/api/uninstall.md similarity index 100% rename from api-doc/uninstall.md rename to doc/api/uninstall.md diff --git a/api-doc/unpublish.md b/doc/api/unpublish.md similarity index 100% rename from api-doc/unpublish.md rename to doc/api/unpublish.md diff --git a/api-doc/update.md b/doc/api/update.md similarity index 100% rename from api-doc/update.md rename to doc/api/update.md diff --git a/api-doc/version.md b/doc/api/version.md similarity index 100% rename from api-doc/version.md rename to doc/api/version.md diff --git a/api-doc/view.md b/doc/api/view.md similarity index 100% rename from api-doc/view.md rename to doc/api/view.md diff --git a/api-doc/whoami.md b/doc/api/whoami.md similarity index 100% rename from api-doc/whoami.md rename to doc/api/whoami.md diff --git a/doc/adduser.md b/doc/cli/adduser.md similarity index 100% rename from doc/adduser.md rename to doc/cli/adduser.md diff --git a/doc/author.md b/doc/cli/author.md similarity index 100% rename from doc/author.md rename to doc/cli/author.md diff --git a/doc/bin.md b/doc/cli/bin.md similarity index 100% rename from doc/bin.md rename to doc/cli/bin.md diff --git a/doc/build.md b/doc/cli/build.md similarity index 100% rename from doc/build.md rename to doc/cli/build.md diff --git a/doc/bundle.md b/doc/cli/bundle.md similarity index 100% rename from doc/bundle.md rename to doc/cli/bundle.md diff --git a/doc/cache.md b/doc/cli/cache.md similarity index 100% rename from doc/cache.md rename to doc/cli/cache.md diff --git a/doc/changelog.md b/doc/cli/changelog.md similarity index 100% rename from doc/changelog.md rename to doc/cli/changelog.md diff --git a/doc/coding-style.md b/doc/cli/coding-style.md similarity index 100% rename from doc/coding-style.md rename to doc/cli/coding-style.md diff --git a/doc/completion.md b/doc/cli/completion.md similarity index 100% rename from doc/completion.md rename to doc/cli/completion.md diff --git a/doc/config.md b/doc/cli/config.md similarity index 100% rename from doc/config.md rename to doc/cli/config.md diff --git a/doc/deprecate.md b/doc/cli/deprecate.md similarity index 100% rename from doc/deprecate.md rename to doc/cli/deprecate.md diff --git a/doc/developers.md b/doc/cli/developers.md similarity index 100% rename from doc/developers.md rename to doc/cli/developers.md diff --git a/doc/docs.md b/doc/cli/docs.md similarity index 100% rename from doc/docs.md rename to doc/cli/docs.md diff --git a/doc/edit.md b/doc/cli/edit.md similarity index 100% rename from doc/edit.md rename to doc/cli/edit.md diff --git a/doc/explore.md b/doc/cli/explore.md similarity index 100% rename from doc/explore.md rename to doc/cli/explore.md diff --git a/doc/faq.md b/doc/cli/faq.md similarity index 100% rename from doc/faq.md rename to doc/cli/faq.md diff --git a/doc/find.md b/doc/cli/find.md similarity index 100% rename from doc/find.md rename to doc/cli/find.md diff --git a/doc/folders.md b/doc/cli/folders.md similarity index 100% rename from doc/folders.md rename to doc/cli/folders.md diff --git a/doc/get.md b/doc/cli/get.md similarity index 100% rename from doc/get.md rename to doc/cli/get.md diff --git a/doc/global.md b/doc/cli/global.md similarity index 100% rename from doc/global.md rename to doc/cli/global.md diff --git a/doc/help-search.md b/doc/cli/help-search.md similarity index 100% rename from doc/help-search.md rename to doc/cli/help-search.md diff --git a/doc/home.md b/doc/cli/home.md similarity index 100% rename from doc/home.md rename to doc/cli/home.md diff --git a/doc/init.md b/doc/cli/init.md similarity index 100% rename from doc/init.md rename to doc/cli/init.md diff --git a/doc/install.md b/doc/cli/install.md similarity index 100% rename from doc/install.md rename to doc/cli/install.md diff --git a/doc/json.md b/doc/cli/json.md similarity index 100% rename from doc/json.md rename to doc/cli/json.md diff --git a/doc/link.md b/doc/cli/link.md similarity index 100% rename from doc/link.md rename to doc/cli/link.md diff --git a/doc/list.md b/doc/cli/list.md similarity index 100% rename from doc/list.md rename to doc/cli/list.md diff --git a/doc/ln.md b/doc/cli/ln.md similarity index 100% rename from doc/ln.md rename to doc/cli/ln.md diff --git a/doc/ls.md b/doc/cli/ls.md similarity index 100% rename from doc/ls.md rename to doc/cli/ls.md diff --git a/doc/npm.md b/doc/cli/npm.md similarity index 100% rename from doc/npm.md rename to doc/cli/npm.md diff --git a/doc/outdated.md b/doc/cli/outdated.md similarity index 100% rename from doc/outdated.md rename to doc/cli/outdated.md diff --git a/doc/owner.md b/doc/cli/owner.md similarity index 100% rename from doc/owner.md rename to doc/cli/owner.md diff --git a/doc/pack.md b/doc/cli/pack.md similarity index 100% rename from doc/pack.md rename to doc/cli/pack.md diff --git a/doc/prefix.md b/doc/cli/prefix.md similarity index 100% rename from doc/prefix.md rename to doc/cli/prefix.md diff --git a/doc/prune.md b/doc/cli/prune.md similarity index 100% rename from doc/prune.md rename to doc/cli/prune.md diff --git a/doc/publish.md b/doc/cli/publish.md similarity index 100% rename from doc/publish.md rename to doc/cli/publish.md diff --git a/doc/rebuild.md b/doc/cli/rebuild.md similarity index 100% rename from doc/rebuild.md rename to doc/cli/rebuild.md diff --git a/doc/registry.md b/doc/cli/registry.md similarity index 100% rename from doc/registry.md rename to doc/cli/registry.md diff --git a/doc/removing-npm.md b/doc/cli/removing-npm.md similarity index 100% rename from doc/removing-npm.md rename to doc/cli/removing-npm.md diff --git a/doc/restart.md b/doc/cli/restart.md similarity index 100% rename from doc/restart.md rename to doc/cli/restart.md diff --git a/doc/rm.md b/doc/cli/rm.md similarity index 100% rename from doc/rm.md rename to doc/cli/rm.md diff --git a/doc/root.md b/doc/cli/root.md similarity index 100% rename from doc/root.md rename to doc/cli/root.md diff --git a/doc/run-script.md b/doc/cli/run-script.md similarity index 100% rename from doc/run-script.md rename to doc/cli/run-script.md diff --git a/doc/scripts.md b/doc/cli/scripts.md similarity index 100% rename from doc/scripts.md rename to doc/cli/scripts.md diff --git a/doc/search.md b/doc/cli/search.md similarity index 100% rename from doc/search.md rename to doc/cli/search.md diff --git a/doc/semver.md b/doc/cli/semver.md similarity index 100% rename from doc/semver.md rename to doc/cli/semver.md diff --git a/doc/set.md b/doc/cli/set.md similarity index 100% rename from doc/set.md rename to doc/cli/set.md diff --git a/doc/start.md b/doc/cli/start.md similarity index 100% rename from doc/start.md rename to doc/cli/start.md diff --git a/doc/stop.md b/doc/cli/stop.md similarity index 100% rename from doc/stop.md rename to doc/cli/stop.md diff --git a/doc/submodule.md b/doc/cli/submodule.md similarity index 100% rename from doc/submodule.md rename to doc/cli/submodule.md diff --git a/doc/tag.md b/doc/cli/tag.md similarity index 100% rename from doc/tag.md rename to doc/cli/tag.md diff --git a/doc/test.md b/doc/cli/test.md similarity index 100% rename from doc/test.md rename to doc/cli/test.md diff --git a/doc/uninstall.md b/doc/cli/uninstall.md similarity index 100% rename from doc/uninstall.md rename to doc/cli/uninstall.md diff --git a/doc/unpublish.md b/doc/cli/unpublish.md similarity index 100% rename from doc/unpublish.md rename to doc/cli/unpublish.md diff --git a/doc/update.md b/doc/cli/update.md similarity index 100% rename from doc/update.md rename to doc/cli/update.md diff --git a/doc/version.md b/doc/cli/version.md similarity index 100% rename from doc/version.md rename to doc/cli/version.md diff --git a/doc/view.md b/doc/cli/view.md similarity index 100% rename from doc/view.md rename to doc/cli/view.md diff --git a/doc/whoami.md b/doc/cli/whoami.md similarity index 100% rename from doc/whoami.md rename to doc/cli/whoami.md diff --git a/lib/help-search.js b/lib/help-search.js index e36dd7bab25..8d2ba012995 100644 --- a/lib/help-search.js +++ b/lib/help-search.js @@ -5,7 +5,7 @@ var fs = require("graceful-fs") , output = require("./utils/output.js") , path = require("path") , asyncMap = require("slide").asyncMap - , docsPath = path.join(__dirname, "..", "doc") + , docsPath = path.join(__dirname, "..", "doc", "cli") , log = require("./utils/log.js") , npm = require("../npm.js") diff --git a/lib/help.js b/lib/help.js index cc0a3c5a148..ce4602ab45d 100644 --- a/lib/help.js +++ b/lib/help.js @@ -26,13 +26,13 @@ function help (args, cb) { npm.config.set("loglevel", "silent") return output.write(npm.commands[section].usage, cb) } - var section_path = path.join(__dirname, "../man1/"+section+".1") + var section_path = path.join(__dirname, "../man/man1/"+section+".1") return fs.stat ( section_path , function (e, o) { if (e) return npm.commands["help-search"](args, cb) - var manpath = path.join(__dirname, "..") + var manpath = path.join(__dirname, "..", "man") , env = {} Object.keys(process.env).forEach(function (i) { env[i] = process.env[i] }) env.MANPATH = manpath @@ -85,7 +85,7 @@ function wrap (arr) { } function getSections(cb) { - fs.readdir(path.join(__dirname, "../man1/"), function (er, files) { + fs.readdir(path.join(__dirname, "../man/man1/"), function (er, files) { if (er) return cb(er) var sectionList = files.concat("help.1") .filter(function (s) { return s.match(/\.1$/) }) diff --git a/man1/adduser.1 b/man/man1/adduser.1 similarity index 100% rename from man1/adduser.1 rename to man/man1/adduser.1 diff --git a/man1/author.1 b/man/man1/author.1 similarity index 100% rename from man1/author.1 rename to man/man1/author.1 diff --git a/man1/bin.1 b/man/man1/bin.1 similarity index 100% rename from man1/bin.1 rename to man/man1/bin.1 diff --git a/man1/build.1 b/man/man1/build.1 similarity index 100% rename from man1/build.1 rename to man/man1/build.1 diff --git a/man1/bundle.1 b/man/man1/bundle.1 similarity index 100% rename from man1/bundle.1 rename to man/man1/bundle.1 diff --git a/man1/cache.1 b/man/man1/cache.1 similarity index 100% rename from man1/cache.1 rename to man/man1/cache.1 diff --git a/man1/changelog.1 b/man/man1/changelog.1 similarity index 100% rename from man1/changelog.1 rename to man/man1/changelog.1 diff --git a/man1/coding-style.1 b/man/man1/coding-style.1 similarity index 100% rename from man1/coding-style.1 rename to man/man1/coding-style.1 diff --git a/man1/completion.1 b/man/man1/completion.1 similarity index 100% rename from man1/completion.1 rename to man/man1/completion.1 diff --git a/man1/config.1 b/man/man1/config.1 similarity index 100% rename from man1/config.1 rename to man/man1/config.1 diff --git a/man1/deprecate.1 b/man/man1/deprecate.1 similarity index 100% rename from man1/deprecate.1 rename to man/man1/deprecate.1 diff --git a/man1/developers.1 b/man/man1/developers.1 similarity index 100% rename from man1/developers.1 rename to man/man1/developers.1 diff --git a/man1/docs.1 b/man/man1/docs.1 similarity index 100% rename from man1/docs.1 rename to man/man1/docs.1 diff --git a/man1/edit.1 b/man/man1/edit.1 similarity index 100% rename from man1/edit.1 rename to man/man1/edit.1 diff --git a/man1/explore.1 b/man/man1/explore.1 similarity index 100% rename from man1/explore.1 rename to man/man1/explore.1 diff --git a/man1/faq.1 b/man/man1/faq.1 similarity index 91% rename from man1/faq.1 rename to man/man1/faq.1 index 4d4ad701364..feeb75953fb 100644 --- a/man1/faq.1 +++ b/man/man1/faq.1 @@ -156,6 +156,9 @@ e) a \fB@\fR that points to (d) .IP "\(bu" 4 f) a \fB\fR that has a "latest" tag satisfying (e) . +.IP "\(bu" 4 +g) a \fBgit\fR url that, when cloned, results in (a)\. +. .IP "" 0 . .P @@ -164,6 +167,25 @@ benefits of using npm if you just want to write a node program (a), and perhaps if you also want to be able to easily install it elsewhere after packing it up into a tarball (b)\. . +.P +Git urls can be of the form: +. +.IP "" 4 +. +.nf +git://github\.com/user/project\.git#commit\-ish +git+ssh://user@hostname:project\.git#commit\-ish +git+http://user@hostname/project/blah\.git#commit\-ish +git+https://user@hostname/project/blah\.git#commit\-ish +. +.fi +. +.IP "" 0 +. +.P +The \fBcommit\-ish\fR can be any tag, sha, or branch which can be supplied as +an argument to \fBgit checkout\fR\|\. The default is \fBmaster\fR\|\. +. .SH "How do I install node with npm?" You don\'t\. Try one of these: . @@ -190,13 +212,8 @@ To set up your own private registry, check out \fBnpm help registry\fR\|\. . .SH "Can I list a url as a dependency?" Yes\. It should be a url to a gzipped tarball containing a single folder -that has a package\.json in its root\. (See "what is a package?" above\.) -. -.SH "OK, but can I list a git repo as a dependency?" -No\. -. -.P -However, you can list a url as a dependency\. +that has a package\.json in its root, or a git url\. +(See "what is a package?" above\.) . .SH "How do I symlink to a dev folder so I don\'t have to keep re\-installing?" See \fBnpm help link\fR diff --git a/man1/find.1 b/man/man1/find.1 similarity index 100% rename from man1/find.1 rename to man/man1/find.1 diff --git a/man1/folders.1 b/man/man1/folders.1 similarity index 100% rename from man1/folders.1 rename to man/man1/folders.1 diff --git a/man1/get.1 b/man/man1/get.1 similarity index 100% rename from man1/get.1 rename to man/man1/get.1 diff --git a/man1/global.1 b/man/man1/global.1 similarity index 100% rename from man1/global.1 rename to man/man1/global.1 diff --git a/man1/help-search.1 b/man/man1/help-search.1 similarity index 100% rename from man1/help-search.1 rename to man/man1/help-search.1 diff --git a/man1/home.1 b/man/man1/home.1 similarity index 100% rename from man1/home.1 rename to man/man1/home.1 diff --git a/man1/init.1 b/man/man1/init.1 similarity index 100% rename from man1/init.1 rename to man/man1/init.1 diff --git a/man1/install.1 b/man/man1/install.1 similarity index 100% rename from man1/install.1 rename to man/man1/install.1 diff --git a/man1/json.1 b/man/man1/json.1 similarity index 100% rename from man1/json.1 rename to man/man1/json.1 diff --git a/man1/link.1 b/man/man1/link.1 similarity index 100% rename from man1/link.1 rename to man/man1/link.1 diff --git a/man1/list.1 b/man/man1/list.1 similarity index 100% rename from man1/list.1 rename to man/man1/list.1 diff --git a/man1/ln.1 b/man/man1/ln.1 similarity index 100% rename from man1/ln.1 rename to man/man1/ln.1 diff --git a/man1/ls.1 b/man/man1/ls.1 similarity index 100% rename from man1/ls.1 rename to man/man1/ls.1 diff --git a/man1/npm.1 b/man/man1/npm.1 similarity index 100% rename from man1/npm.1 rename to man/man1/npm.1 diff --git a/man1/outdated.1 b/man/man1/outdated.1 similarity index 100% rename from man1/outdated.1 rename to man/man1/outdated.1 diff --git a/man1/owner.1 b/man/man1/owner.1 similarity index 100% rename from man1/owner.1 rename to man/man1/owner.1 diff --git a/man1/pack.1 b/man/man1/pack.1 similarity index 100% rename from man1/pack.1 rename to man/man1/pack.1 diff --git a/man1/prefix.1 b/man/man1/prefix.1 similarity index 100% rename from man1/prefix.1 rename to man/man1/prefix.1 diff --git a/man1/prune.1 b/man/man1/prune.1 similarity index 100% rename from man1/prune.1 rename to man/man1/prune.1 diff --git a/man1/publish.1 b/man/man1/publish.1 similarity index 100% rename from man1/publish.1 rename to man/man1/publish.1 diff --git a/man1/rebuild.1 b/man/man1/rebuild.1 similarity index 100% rename from man1/rebuild.1 rename to man/man1/rebuild.1 diff --git a/man1/registry.1 b/man/man1/registry.1 similarity index 100% rename from man1/registry.1 rename to man/man1/registry.1 diff --git a/man1/removing-npm.1 b/man/man1/removing-npm.1 similarity index 100% rename from man1/removing-npm.1 rename to man/man1/removing-npm.1 diff --git a/man1/restart.1 b/man/man1/restart.1 similarity index 100% rename from man1/restart.1 rename to man/man1/restart.1 diff --git a/man1/rm.1 b/man/man1/rm.1 similarity index 100% rename from man1/rm.1 rename to man/man1/rm.1 diff --git a/man1/root.1 b/man/man1/root.1 similarity index 100% rename from man1/root.1 rename to man/man1/root.1 diff --git a/man1/run-script.1 b/man/man1/run-script.1 similarity index 100% rename from man1/run-script.1 rename to man/man1/run-script.1 diff --git a/man1/scripts.1 b/man/man1/scripts.1 similarity index 95% rename from man1/scripts.1 rename to man/man1/scripts.1 index 36254083af6..47fbb0a9bdf 100644 --- a/man1/scripts.1 +++ b/man/man1/scripts.1 @@ -1,7 +1,7 @@ .\" Generated with Ronnjs/v0.1 .\" http://github.com/kapouer/ronnjs/ . -.TH "NPM\-SCRIPTS" "1" "July 2011" "" "" +.TH "NPM\-SCRIPTS" "1" "August 2011" "" "" . .SH "NAME" \fBnpm-scripts\fR \-\- How npm handles the "scripts" field @@ -83,6 +83,12 @@ default the \fBpreinstall\fR command to compile using node\-waf\. . .IP "" 0 . +.SH "USER" +If npm was invoked with root privileges, then it will change the uid to +the user account or uid specified by the \fBuser\fR config, which defaults +to \fBnobody\fR\|\. Set the \fBunsafe\-perm\fR flag to run scripts with root +privileges\. +. .SH "ENVIRONMENT" Package scripts run in an environment where many pieces of information are made available regarding the setup of npm and the current state of the diff --git a/man1/search.1 b/man/man1/search.1 similarity index 100% rename from man1/search.1 rename to man/man1/search.1 diff --git a/man1/semver.1 b/man/man1/semver.1 similarity index 100% rename from man1/semver.1 rename to man/man1/semver.1 diff --git a/man1/set.1 b/man/man1/set.1 similarity index 100% rename from man1/set.1 rename to man/man1/set.1 diff --git a/man1/start.1 b/man/man1/start.1 similarity index 100% rename from man1/start.1 rename to man/man1/start.1 diff --git a/man1/stop.1 b/man/man1/stop.1 similarity index 100% rename from man1/stop.1 rename to man/man1/stop.1 diff --git a/man1/submodule.1 b/man/man1/submodule.1 similarity index 100% rename from man1/submodule.1 rename to man/man1/submodule.1 diff --git a/man1/tag.1 b/man/man1/tag.1 similarity index 100% rename from man1/tag.1 rename to man/man1/tag.1 diff --git a/man1/test.1 b/man/man1/test.1 similarity index 100% rename from man1/test.1 rename to man/man1/test.1 diff --git a/man1/uninstall.1 b/man/man1/uninstall.1 similarity index 100% rename from man1/uninstall.1 rename to man/man1/uninstall.1 diff --git a/man1/unpublish.1 b/man/man1/unpublish.1 similarity index 100% rename from man1/unpublish.1 rename to man/man1/unpublish.1 diff --git a/man1/update.1 b/man/man1/update.1 similarity index 100% rename from man1/update.1 rename to man/man1/update.1 diff --git a/man1/version.1 b/man/man1/version.1 similarity index 100% rename from man1/version.1 rename to man/man1/version.1 diff --git a/man1/view.1 b/man/man1/view.1 similarity index 100% rename from man1/view.1 rename to man/man1/view.1 diff --git a/man1/whoami.1 b/man/man1/whoami.1 similarity index 100% rename from man1/whoami.1 rename to man/man1/whoami.1 diff --git a/man3/author.3 b/man/man3/author.3 similarity index 100% rename from man3/author.3 rename to man/man3/author.3 diff --git a/man3/bin.3 b/man/man3/bin.3 similarity index 100% rename from man3/bin.3 rename to man/man3/bin.3 diff --git a/man3/commands.3 b/man/man3/commands.3 similarity index 100% rename from man3/commands.3 rename to man/man3/commands.3 diff --git a/man3/config.3 b/man/man3/config.3 similarity index 100% rename from man3/config.3 rename to man/man3/config.3 diff --git a/man3/deprecate.3 b/man/man3/deprecate.3 similarity index 100% rename from man3/deprecate.3 rename to man/man3/deprecate.3 diff --git a/man3/docs.3 b/man/man3/docs.3 similarity index 100% rename from man3/docs.3 rename to man/man3/docs.3 diff --git a/man3/edit.3 b/man/man3/edit.3 similarity index 100% rename from man3/edit.3 rename to man/man3/edit.3 diff --git a/man3/explore.3 b/man/man3/explore.3 similarity index 100% rename from man3/explore.3 rename to man/man3/explore.3 diff --git a/man3/find.3 b/man/man3/find.3 similarity index 100% rename from man3/find.3 rename to man/man3/find.3 diff --git a/man3/get.3 b/man/man3/get.3 similarity index 100% rename from man3/get.3 rename to man/man3/get.3 diff --git a/man3/help-search.3 b/man/man3/help-search.3 similarity index 100% rename from man3/help-search.3 rename to man/man3/help-search.3 diff --git a/man3/home.3 b/man/man3/home.3 similarity index 100% rename from man3/home.3 rename to man/man3/home.3 diff --git a/man3/init.3 b/man/man3/init.3 similarity index 100% rename from man3/init.3 rename to man/man3/init.3 diff --git a/man3/install.3 b/man/man3/install.3 similarity index 100% rename from man3/install.3 rename to man/man3/install.3 diff --git a/man3/link.3 b/man/man3/link.3 similarity index 100% rename from man3/link.3 rename to man/man3/link.3 diff --git a/man3/list.3 b/man/man3/list.3 similarity index 100% rename from man3/list.3 rename to man/man3/list.3 diff --git a/man3/ln.3 b/man/man3/ln.3 similarity index 100% rename from man3/ln.3 rename to man/man3/ln.3 diff --git a/man3/load.3 b/man/man3/load.3 similarity index 100% rename from man3/load.3 rename to man/man3/load.3 diff --git a/man3/ls.3 b/man/man3/ls.3 similarity index 100% rename from man3/ls.3 rename to man/man3/ls.3 diff --git a/man3/npm.3 b/man/man3/npm.3 similarity index 100% rename from man3/npm.3 rename to man/man3/npm.3 diff --git a/man3/outdated.3 b/man/man3/outdated.3 similarity index 100% rename from man3/outdated.3 rename to man/man3/outdated.3 diff --git a/man3/owner.3 b/man/man3/owner.3 similarity index 100% rename from man3/owner.3 rename to man/man3/owner.3 diff --git a/man3/pack.3 b/man/man3/pack.3 similarity index 100% rename from man3/pack.3 rename to man/man3/pack.3 diff --git a/man3/prefix.3 b/man/man3/prefix.3 similarity index 100% rename from man3/prefix.3 rename to man/man3/prefix.3 diff --git a/man3/prune.3 b/man/man3/prune.3 similarity index 100% rename from man3/prune.3 rename to man/man3/prune.3 diff --git a/man3/publish.3 b/man/man3/publish.3 similarity index 100% rename from man3/publish.3 rename to man/man3/publish.3 diff --git a/man3/rebuild.3 b/man/man3/rebuild.3 similarity index 100% rename from man3/rebuild.3 rename to man/man3/rebuild.3 diff --git a/man3/restart.3 b/man/man3/restart.3 similarity index 100% rename from man3/restart.3 rename to man/man3/restart.3 diff --git a/man3/rm.3 b/man/man3/rm.3 similarity index 100% rename from man3/rm.3 rename to man/man3/rm.3 diff --git a/man3/root.3 b/man/man3/root.3 similarity index 100% rename from man3/root.3 rename to man/man3/root.3 diff --git a/man3/run-script.3 b/man/man3/run-script.3 similarity index 100% rename from man3/run-script.3 rename to man/man3/run-script.3 diff --git a/man3/search.3 b/man/man3/search.3 similarity index 100% rename from man3/search.3 rename to man/man3/search.3 diff --git a/man3/set.3 b/man/man3/set.3 similarity index 100% rename from man3/set.3 rename to man/man3/set.3 diff --git a/man3/start.3 b/man/man3/start.3 similarity index 100% rename from man3/start.3 rename to man/man3/start.3 diff --git a/man3/stop.3 b/man/man3/stop.3 similarity index 100% rename from man3/stop.3 rename to man/man3/stop.3 diff --git a/man3/submodule.3 b/man/man3/submodule.3 similarity index 100% rename from man3/submodule.3 rename to man/man3/submodule.3 diff --git a/man3/tag.3 b/man/man3/tag.3 similarity index 100% rename from man3/tag.3 rename to man/man3/tag.3 diff --git a/man3/test.3 b/man/man3/test.3 similarity index 100% rename from man3/test.3 rename to man/man3/test.3 diff --git a/man3/uninstall.3 b/man/man3/uninstall.3 similarity index 100% rename from man3/uninstall.3 rename to man/man3/uninstall.3 diff --git a/man3/unpublish.3 b/man/man3/unpublish.3 similarity index 100% rename from man3/unpublish.3 rename to man/man3/unpublish.3 diff --git a/man3/update.3 b/man/man3/update.3 similarity index 100% rename from man3/update.3 rename to man/man3/update.3 diff --git a/man3/version.3 b/man/man3/version.3 similarity index 100% rename from man3/version.3 rename to man/man3/version.3 diff --git a/man3/view.3 b/man/man3/view.3 similarity index 100% rename from man3/view.3 rename to man/man3/view.3 diff --git a/man3/whoami.3 b/man/man3/whoami.3 similarity index 100% rename from man3/whoami.3 rename to man/man3/whoami.3 diff --git a/package.json b/package.json index 86aaeaf903d..fb6a55f2592 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ , "web" : "http://github.com/isaacs/npm/issues" } , "directories" : { "doc" : "./doc" - , "man" : "./man1" + , "man" : "./man" , "lib" : "./lib" , "bin" : "./bin" }