deps/npm/man/man3/npm-deprecate.3

   1 .\" Generated with Ronnjs 0.3.8
   2 .\" http://github.com/kapouer/ronnjs/
   3 .
   4 .TH "NPM\-DEPRECATE" "3" "November 2013" "" ""
   5 .
   6 .SH "NAME"
   7 \fBnpm-deprecate\fR \-\- Deprecate a version of a package
   8 .
   9 .SH "SYNOPSIS"
  10 .
  11 .nf
  12 npm\.commands\.deprecate(args, callback)
  13 .
  14 .fi
  15 .
  16 .SH "DESCRIPTION"
  17 This command will update the npm registry entry for a package, providing
  18 a deprecation warning to all who attempt to install it\.
  19 .
  20 .P
  21 The \'args\' parameter must have exactly two elements:
  22 .
  23 .IP "\(bu" 4
  24 \fBpackage[@version]\fR
  25 .
  26 .IP
  27 The \fBversion\fR portion is optional, and may be either a range, or a
  28 specific version, or a tag\.
  29 .
  30 .IP "\(bu" 4
  31 \fBmessage\fR
  32 .
  33 .IP
  34 The warning message that will be printed whenever a user attempts to
  35 install the package\.
  36 .
  37 .IP "" 0
  38 .
  39 .P
  40 Note that you must be the package owner to deprecate something\.  See the \fBowner\fR and \fBadduser\fR help topics\.
  41 .
  42 .P
  43 To un\-deprecate a package, specify an empty string (\fB""\fR) for the \fBmessage\fR argument\.
  44 .
  45 .SH "SEE ALSO"
  46 .
  47 .IP "\(bu" 4
  48 npm apihelp publish
  49 .
  50 .IP "\(bu" 4
  51 npm apihelp unpublish
  52 .
  53 .IP "\(bu" 4
  54 npm help  registry
  55 .
  56 .IP "" 0
  57