0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-30 23:43:09 +01:00
nodejs/deps/npm/man/man3/deprecate.3
2012-12-12 14:41:28 -08:00

55 lines
1009 B
Groff

.\" Generated with Ronnjs 0.3.8
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-DEPRECATE" "3" "December 2012" "" ""
.
.SH "NAME"
\fBnpm-deprecate\fR \-\- Deprecate a version of a package
.
.SH "SYNOPSIS"
.
.nf
npm\.commands\.deprecate(args, callback)
.
.fi
.
.SH "DESCRIPTION"
This command will update the npm registry entry for a package, providing
a deprecation warning to all who attempt to install it\.
.
.P
The \'args\' parameter must have exactly two elements:
.
.IP "\(bu" 4
\fBpackage[@version]\fR
.
.IP
The \fBversion\fR portion is optional, and may be either a range, or a
specific version, or a tag\.
.
.IP "\(bu" 4
\fBmessage\fR
.
.IP
The warning message that will be printed whenever a user attempts to
install the package\.
.
.IP "" 0
.
.P
Note that you must be the package owner to deprecate something\. See the \fBowner\fR and \fBadduser\fR help topics\.
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
npm apihelp publish
.
.IP "\(bu" 4
npm apihelp unpublish
.
.IP "\(bu" 4
npm help registry
.
.IP "" 0