Permalink
Browse files

document the 'usage' config

  • Loading branch information...
1 parent 42c6fd2 commit 8f3ee0c03ba94a82c9ea05aa969273daa32dbf78 @isaacs isaacs committed Sep 29, 2010
Showing with 14 additions and 0 deletions.
  1. +7 −0 doc/config.md
  2. +7 −0 man1/config.1
View
@@ -212,3 +212,10 @@ The name of a GNU-compatible tar program on your system.
Default: env.GZIPBIN or "gzip"
The name of a GNU-compatible gzip program on your system.
+
+### usage
+
+If set to `true`, then this will tell help to print out the short usage statement
+instead of the long manpage type thing.
+
+This is set automatically if you invoke help like `npm command -?`.
View
@@ -282,3 +282,10 @@ Default: env\.GZIPBIN or "gzip"
.
.P
The name of a GNU\-compatible gzip program on your system\.
+.
+.SS "usage"
+If set to \fBtrue\fR, then this will tell help to print out the short usage statement
+instead of the long manpage type thing\.
+.
+.P
+This is set automatically if you invoke help like \fBnpm command \-?\fR\|\.

0 comments on commit 8f3ee0c

Please sign in to comment.