/src/AddIns/Misc/PackageManagement/RequiredLibraries/NuGet.Cmdlets.dll-Help.xml
XML | 1112 lines | 1032 code | 50 blank | 30 comment | 0 complexity | 090b63081db9fe28f19448c0bbcc6ea0 MD5 | raw file
1<?xml version="1.0" encoding="utf-8" ?> 2 3<helpItems schema="maml"> 4 5 <!-- Install-Package command --> 6 <command:command 7 xmlns:maml="http://schemas.microsoft.com/maml/2004/10" 8 xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" 9 xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> 10 11 <command:details> 12 <command:name> 13 Install-Package 14 </command:name> 15 <maml:description> 16 <maml:para>Installs a package.</maml:para> 17 </maml:description> 18 <command:verb>Install</command:verb> 19 <command:noun>Package</command:noun> 20 <dev:version></dev:version> 21 </command:details> 22 23 <maml:description> 24 <maml:para>Installs a package and its dependencies into the project.</maml:para> 25 </maml:description> 26 27 <!-- Cmdlet syntax section--> 28 <command:syntax> 29 <command:syntaxItem> 30 <maml:name>Install-Package</maml:name> 31 <command:parameter required="true" position="1"> 32 <maml:name>Id</maml:name> 33 <command:parameterValue required="true">string</command:parameterValue> 34 </command:parameter> 35 <command:parameter required="false" position="named"> 36 <maml:name>IgnoreDependencies</maml:name> 37 </command:parameter> 38 <command:parameter required="false" position="named"> 39 <maml:name>ProjectName</maml:name> 40 <command:parameterValue required="true">string</command:parameterValue> 41 </command:parameter> 42 <command:parameter required="false" position="2"> 43 <maml:name>Version</maml:name> 44 <command:parameterValue required="true">string</command:parameterValue> 45 </command:parameter> 46 <command:parameter required="false" position="3"> 47 <maml:name>Source</maml:name> 48 <command:parameterValue required="true">string</command:parameterValue> 49 </command:parameter> 50 <command:parameter required="false" position="named"> 51 <maml:name>IncludePrerelease</maml:name> 52 </command:parameter> 53 <command:parameter required="false" position="named"> 54 <maml:name>FileConflictAction</maml:name> 55 </command:parameter> 56 <command:parameter required="false" position="named"> 57 <maml:name>DependencyVersion</maml:name> 58 </command:parameter> 59 <command:parameter required="false" position="named"> 60 <maml:name>WhatIf</maml:name> 61 </command:parameter> 62 </command:syntaxItem> 63 </command:syntax> 64 65 <!-- Cmdlet parameter section --> 66 <command:parameters> 67 <command:parameter required="true" position="1"> 68 <maml:name>Id</maml:name> 69 <maml:description> 70 <maml:para>Specifies the package ID of the package to install.</maml:para> 71 </maml:description> 72 <command:parameterValue required="true"> 73 string 74 </command:parameterValue> 75 <dev:defaultValue></dev:defaultValue> 76 </command:parameter> 77 <command:parameter required="false" position="named"> 78 <maml:name>IgnoreDependencies</maml:name> 79 <maml:description> 80 <maml:para>Installs only this package and not its dependencies.</maml:para> 81 </maml:description> 82 </command:parameter> 83 <command:parameter required="false" position="named"> 84 <maml:name>ProjectName</maml:name> 85 <maml:description> 86 <maml:para>Specifies the project to install the package into. If ommitted, the default project is chosen.</maml:para> 87 </maml:description> 88 <command:parameterValue required="true"> 89 string 90 </command:parameterValue> 91 </command:parameter> 92 <command:parameter required="false" position="named"> 93 <maml:name>Source</maml:name> 94 <maml:description> 95 <maml:para>Specifies the URL or directory path for the package source containing the package to install. When set to a local file system path, Source can be either absolute or relative to the current directory. If omitted, looks in the currently selected package source to find the corresponding package URL.</maml:para> 96 </maml:description> 97 <command:parameterValue required="true"> 98 string 99 </command:parameterValue> 100 </command:parameter> 101 <command:parameter required="false" position="named"> 102 <maml:name>Version</maml:name> 103 <maml:description> 104 <maml:para>Specifies the version of the package to install. If omitted, defaults to the latest version.</maml:para> 105 </maml:description> 106 <command:parameterValue required="true"> 107 string 108 </command:parameterValue> 109 </command:parameter> 110 <command:parameter required="false" position="named"> 111 <maml:name>IncludePrerelease</maml:name> 112 <maml:description> 113 <maml:para>Indicates whether this command will consider prerelease packages. If omitted, only stable packages are considered.</maml:para> 114 </maml:description> 115 </command:parameter> 116 <command:parameter required="false" position="named"> 117 <maml:name>FileConflictAction</maml:name> 118 <maml:description> 119 <maml:para>Indicates what this command should do if a file from the package's content folder already exists in the project.</maml:para> 120 </maml:description> 121 </command:parameter> 122 <command:parameter required="false" position="named"> 123 <maml:name>DependencyVersion</maml:name> 124 <maml:description> 125 <maml:para>Specifies which dependency package version to install. If omitted, this defaults to the lowest required version.</maml:para> 126 </maml:description> 127 </command:parameter> 128 <command:parameter required="false" position="named"> 129 <maml:name>WhatIf</maml:name> 130 <maml:description> 131 <maml:para>Displays the actions that would be taken and the effect of the command, instead of executing the command.</maml:para> 132 </maml:description> 133 </command:parameter> 134 </command:parameters> 135 136 <!-- Examples section --> 137 <command:examples> 138 <command:example> 139 <maml:title>---------- EXAMPLE 1 ----------</maml:title> 140 <dev:code>PM> Install-Package Elmah</dev:code> 141 <dev:remarks> 142 <maml:para> 143 Description 144 ------------------------------------------------------------------ 145 Installs the latest version of the Elmah package from the current 146 package source into the default project. 147 </maml:para> 148 <maml:para></maml:para> 149 <maml:para></maml:para> 150 </dev:remarks> 151 </command:example> 152 <command:example> 153 <maml:title>---------- EXAMPLE 2 ----------</maml:title> 154 <dev:code>PM> Install-Package Glimpse -Version 1.0.0 -Project MvcApplication1 </dev:code> 155 <dev:remarks> 156 <maml:para> 157 Description 158 ------------------------------------------------------------------ 159 Installs version 1.0.0 of Glimpse into the project named MvcApplication1 160 </maml:para> 161 <maml:para></maml:para> 162 <maml:para></maml:para> 163 </dev:remarks> 164 </command:example> 165 <command:example> 166 <maml:title>---------- EXAMPLE 3 ----------</maml:title> 167 <dev:code>PM> Install-Package Ninject.Mvc3 -IgnoreDependencies -Source c:\temp\packages </dev:code> 168 <dev:remarks> 169 <maml:para> 170 Description 171 ------------------------------------------------------------------ 172 Installs the package, Ninject.Mvc3, but not its dependencies. It looks in the directory, 173 c:\temp\packages to find the package. 174 </maml:para> 175 <maml:para></maml:para> 176 <maml:para></maml:para> 177 </dev:remarks> 178 </command:example> 179 </command:examples> 180 181 <!-- Link section --> 182 <maml:relatedLinks> 183 <maml:navigationLink> 184 <maml:linkText>Online version:</maml:linkText> 185 <maml:uri>http://docs.nuget.org/</maml:uri> 186 </maml:navigationLink> 187 <maml:navigationLink> 188 <maml:linkText>Install-Package</maml:linkText> 189 <maml:uri/> 190 </maml:navigationLink> 191 </maml:relatedLinks> 192 </command:command> 193 194 <!-- Get-Package command --> 195 <command:command 196 xmlns:maml="http://schemas.microsoft.com/maml/2004/10" 197 xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" 198 xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> 199 200 <command:details> 201 <command:name> 202 Get-Package 203 </command:name> 204 <maml:description> 205 <maml:para>Gets the set of installed packages. Use the -ListAvailable flag to list packages available from the package source.</maml:para> 206 </maml:description> 207 <command:verb>Get</command:verb> 208 <command:noun>Package</command:noun> 209 <dev:version></dev:version> 210 </command:details> 211 212 <maml:description> 213 <maml:para>Gets the set of installed packages. Use the -ListAvailable flag to list packages available from the package source.</maml:para> 214 </maml:description> 215 216 <!-- Cmdlet syntax section--> 217 <command:syntax> 218 <command:syntaxItem> 219 <maml:name>Get-Package</maml:name> 220 <command:parameter required="true" position="named"> 221 <maml:name>Source</maml:name> 222 <command:parameterValue required="true">string</command:parameterValue> 223 </command:parameter> 224 <command:parameter required="false" position="named"> 225 <maml:name>ListAvailable</maml:name> 226 </command:parameter> 227 <command:parameter required="false" position="named"> 228 <maml:name>Updates</maml:name> 229 </command:parameter> 230 <command:parameter required="false" position="named"> 231 <maml:name>ProjectName</maml:name> 232 <command:parameterValue required="true">string</command:parameterValue> 233 </command:parameter> 234 <command:parameter required="false" position="named"> 235 <maml:name>Filter</maml:name> 236 <command:parameterValue required="true">string</command:parameterValue> 237 </command:parameter> 238 <command:parameter required="false" position="named"> 239 <maml:name>First</maml:name> 240 <command:parameterValue required="true">int</command:parameterValue> 241 </command:parameter> 242 <command:parameter required="false" position="named"> 243 <maml:name>Skip</maml:name> 244 <command:parameterValue required="true">int</command:parameterValue> 245 </command:parameter> 246 <command:parameter required="false" position="named"> 247 <maml:name>AllVersions</maml:name> 248 </command:parameter> 249 <command:parameter required="false" position="named"> 250 <maml:name>IncludePrerelease</maml:name> 251 </command:parameter> 252 </command:syntaxItem> 253 </command:syntax> 254 255 <!-- Cmdlet parameter section --> 256 <command:parameters> 257 <command:parameter required="false" position="named"> 258 <maml:name>Source</maml:name> 259 <maml:description> 260 <maml:para>Specifies the URL or directory path for the package source containing the package to install. When set to a local file system path, Source can be either absolute or relative to the current directory. If omitted, looks in the currently selected package source to find the corresponding package URL.</maml:para> 261 </maml:description> 262 <command:parameterValue required="true"> 263 string 264 </command:parameterValue> 265 </command:parameter> 266 <command:parameter required="false" position="named"> 267 <maml:name>ListAvailable</maml:name> 268 <maml:description> 269 <maml:para>Gets packages available from the online package source.</maml:para> 270 </maml:description> 271 </command:parameter> 272 <command:parameter required="false"> 273 <maml:name>ProjectName</maml:name> 274 <maml:description> 275 <maml:para>Specifies the project to get installed packages from. If ommitted, the command will return installed projects for the entire solution.</maml:para> 276 </maml:description> 277 </command:parameter> 278 <command:parameter required="false" position="named"> 279 <maml:name>Updates</maml:name> 280 <maml:description> 281 <maml:para>Gets packages that have an update available from the package source.</maml:para> 282 </maml:description> 283 </command:parameter> 284 <command:parameter required="false" position="named"> 285 <maml:name>Filter</maml:name> 286 <maml:description> 287 <maml:para>Specifies a filter string used to narrow down the list of packages returned. The filter is searched for in the package Id, the description and tags.</maml:para> 288 </maml:description> 289 </command:parameter> 290 <command:parameter required="false" position="named"> 291 <maml:name>First</maml:name> 292 <maml:description> 293 <maml:para>Specifies the number of packages to return from the beginning of the list.</maml:para> 294 </maml:description> 295 </command:parameter> 296 <command:parameter required="false" position="named"> 297 <maml:name>Skip</maml:name> 298 <maml:description> 299 <maml:para>Skips (does not return) the specified number of packages, counting from the beginning of the list.</maml:para> 300 </maml:description> 301 </command:parameter> 302 <command:parameter required="false" position="named"> 303 <maml:name>AllVersions</maml:name> 304 <maml:description> 305 <maml:para>Displays all available versions of a package. The latest version of each package is listed by default. </maml:para> 306 </maml:description> 307 </command:parameter> 308 <command:parameter required="false" position="named"> 309 <maml:name>IncludePrerelease</maml:name> 310 <maml:description> 311 <maml:para>Indicates whether to include prerelease packages in the returned results.</maml:para> 312 </maml:description> 313 </command:parameter> 314 </command:parameters> 315 316 <!-- Examples section --> 317 <command:examples> 318 <command:example> 319 <maml:title>---------- EXAMPLE 1 ----------</maml:title> 320 <dev:code>PM> Get-Package</dev:code> 321 <dev:remarks> 322 <maml:para> 323 Description 324 ------------------------------------------------------------------ 325 Returns packages installed in the current solution. 326 </maml:para> 327 <maml:para></maml:para> 328 <maml:para></maml:para> 329 </dev:remarks> 330 </command:example> 331 <command:example> 332 <maml:title>---------- EXAMPLE 2 ----------</maml:title> 333 <dev:code>PM> Get-Package -ProjectName MyProject</dev:code> 334 <dev:remarks> 335 <maml:para> 336 Description 337 ------------------------------------------------------------------ 338 Returns packages installed in the "MyProject" project. 339 </maml:para> 340 <maml:para></maml:para> 341 <maml:para></maml:para> 342 </dev:remarks> 343 </command:example> 344 <command:example> 345 <maml:title>---------- EXAMPLE 3 ----------</maml:title> 346 <dev:code>PM> Get-Package -ListAvailable</dev:code> 347 <dev:remarks> 348 <maml:para> 349 Description 350 ------------------------------------------------------------------ 351 Returns a list of packages available online in the current package source. 352 </maml:para> 353 <maml:para></maml:para> 354 <maml:para></maml:para> 355 </dev:remarks> 356 </command:example> 357 <command:example> 358 <maml:title>---------- EXAMPLE 4 ----------</maml:title> 359 <dev:code>PM> Get-Package -ListAvailable -Filter Ninject</dev:code> 360 <dev:remarks> 361 <maml:para> 362 Description 363 ------------------------------------------------------------------ 364 Returns a list of packages available online using "Ninject" as a search term. 365 </maml:para> 366 <maml:para></maml:para> 367 </dev:remarks> 368 </command:example> 369 <command:example> 370 <maml:title>---------- EXAMPLE 5 ----------</maml:title> 371 <dev:code>PS> Get-Package -Updates</dev:code> 372 <dev:remarks> 373 <maml:para> 374 Description 375 ------------------------------------------------------------------ 376 Returns a list of packages installed in the default project that have updates available in the current package source. 377 </maml:para> 378 <maml:para></maml:para> 379 <maml:para></maml:para> 380 </dev:remarks> 381 </command:example> 382 </command:examples> 383 384 <!-- Link section --> 385 <maml:relatedLinks> 386 <maml:navigationLink> 387 <maml:linkText>Online version:</maml:linkText> 388 <maml:uri>http://docs.nuget.org/</maml:uri> 389 </maml:navigationLink> 390 <maml:navigationLink> 391 <maml:linkText>Get-Package</maml:linkText> 392 <maml:uri/> 393 </maml:navigationLink> 394 </maml:relatedLinks> 395 </command:command> 396 397 <!-- Uninstall-Package command --> 398 <command:command 399 xmlns:maml="http://schemas.microsoft.com/maml/2004/10" 400 xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" 401 xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> 402 403 <command:details> 404 <command:name> 405 Uninstall-Package 406 </command:name> 407 <maml:description> 408 <maml:para>Uninstalls a package.</maml:para> 409 </maml:description> 410 <command:verb>Uninstall</command:verb> 411 <command:noun>Package</command:noun> 412 <dev:version></dev:version> 413 </command:details> 414 415 <maml:description> 416 <maml:para>Uninstalls a package. If other packages depend on this package, the command will fail unless the –Force option is specified.</maml:para> 417 </maml:description> 418 419 <!-- Cmdlet syntax section--> 420 <command:syntax> 421 <command:syntaxItem> 422 <maml:name>Uninstall-Package</maml:name> 423 <command:parameter required="true" position="1"> 424 <maml:name>Id</maml:name> 425 <command:parameterValue required="true">string</command:parameterValue> 426 </command:parameter> 427 <command:parameter required="false" position="named"> 428 <maml:name>RemoveDependencies</maml:name> 429 </command:parameter> 430 <command:parameter required="false" position="named"> 431 <maml:name>ProjectName</maml:name> 432 <command:parameterValue required="true">string</command:parameterValue> 433 </command:parameter> 434 <command:parameter required="false" position="named"> 435 <maml:name>Force</maml:name> 436 </command:parameter> 437 <command:parameter required="false" position="named"> 438 <maml:name>Version</maml:name> 439 <command:parameterValue required="true">string</command:parameterValue> 440 </command:parameter> 441 <command:parameter required="false" position="named"> 442 <maml:name>WhatIf</maml:name> 443 </command:parameter> 444 </command:syntaxItem> 445 </command:syntax> 446 447 <!-- Cmdlet parameter section --> 448 <command:parameters> 449 <command:parameter required="true" position="1"> 450 <maml:name>Id</maml:name> 451 <maml:description> 452 <maml:para>Specifies the package ID of the package to uninstall.</maml:para> 453 </maml:description> 454 <command:parameterValue required="true"> 455 string 456 </command:parameterValue> 457 <dev:defaultValue></dev:defaultValue> 458 </command:parameter> 459 <command:parameter required="false" position="named"> 460 <maml:name>RemoveDependencies</maml:name> 461 <maml:description> 462 <maml:para>Uninstalls the package and its unused dependencies.</maml:para> 463 </maml:description> 464 </command:parameter> 465 <command:parameter required="false" position="named"> 466 <maml:name>ProjectName</maml:name> 467 <maml:description> 468 <maml:para>Specifies the project to uninstall the package from. If ommitted, the default project is chosen.</maml:para> 469 </maml:description> 470 <command:parameterValue required="true"> 471 string 472 </command:parameterValue> 473 </command:parameter> 474 <command:parameter required="false" position="named"> 475 <maml:name>Force</maml:name> 476 <maml:description> 477 <maml:para>Forces an uninstall of the package even if another package depends on it.</maml:para> 478 </maml:description> 479 </command:parameter> 480 <command:parameter required="false" position="named"> 481 <maml:name>Version</maml:name> 482 <maml:description> 483 <maml:para>The version of the package to uninstall. If omitted, defaults to the latest version.</maml:para> 484 </maml:description> 485 <command:parameterValue required="true"> 486 string 487 </command:parameterValue> 488 </command:parameter> 489 <command:parameter required="false" position="named"> 490 <maml:name>WhatIf</maml:name> 491 <maml:description> 492 <maml:para>Displays the actions that would be taken and the effect of the command, instead of executing the command.</maml:para> 493 </maml:description> 494 </command:parameter> 495 </command:parameters> 496 497 <command:examples> 498 <command:example> 499 <maml:title>---------- EXAMPLE 1 ----------</maml:title> 500 <dev:code>PM> Uninstall-Package Elmah</dev:code> 501 <dev:remarks> 502 <maml:para> 503 Description 504 ------------------------------------------------------------------ 505 Uninstalls the Elmah package from the default project. 506 </maml:para> 507 <maml:para></maml:para> 508 <maml:para></maml:para> 509 </dev:remarks> 510 </command:example> 511 <command:example> 512 <maml:title>---------- EXAMPLE 2 ----------</maml:title> 513 <dev:code>PM> Uninstall-Package Elmah -RemoveDependencies</dev:code> 514 <dev:remarks> 515 <maml:para> 516 Description 517 ------------------------------------------------------------------ 518 Uninstalls the Elmah package as well as all its dependencies. If any dependency has another package that depends on it, 519 it is skipped. 520 </maml:para> 521 <maml:para></maml:para> 522 <maml:para></maml:para> 523 </dev:remarks> 524 </command:example> 525 <command:example> 526 <maml:title>---------- EXAMPLE 3 ----------</maml:title> 527 <dev:code>PM> Uninstall-Package Elmah -Force</dev:code> 528 <dev:remarks> 529 <maml:para> 530 Description 531 ------------------------------------------------------------------ 532 Uninstalls the Elmah package even if another package depends on it. 533 </maml:para> 534 <maml:para></maml:para> 535 <maml:para></maml:para> 536 </dev:remarks> 537 </command:example> 538 </command:examples> 539 540 <!-- Link section --> 541 <maml:relatedLinks> 542 <maml:navigationLink> 543 <maml:linkText>Online version:</maml:linkText> 544 <maml:uri>http://docs.nuget.org/</maml:uri> 545 </maml:navigationLink> 546 <maml:navigationLink> 547 <maml:linkText>Uninstall-Package</maml:linkText> 548 <maml:uri/> 549 </maml:navigationLink> 550 </maml:relatedLinks> 551 </command:command> 552 553 <!-- Update-Package command --> 554 <command:command 555 xmlns:maml="http://schemas.microsoft.com/maml/2004/10" 556 xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" 557 xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> 558 559 <command:details> 560 <command:name> 561 Update-Package 562 </command:name> 563 <maml:description> 564 <maml:para>Updates a package.</maml:para> 565 </maml:description> 566 <command:verb>Update</command:verb> 567 <command:noun>Package</command:noun> 568 <dev:version></dev:version> 569 </command:details> 570 571 <maml:description> 572 <maml:para>Updates a package and its dependencies to a newer version.</maml:para> 573 </maml:description> 574 575 <!-- Cmdlet syntax section--> 576 <command:syntax> 577 <command:syntaxItem> 578 <maml:name>Update-Package</maml:name> 579 <command:parameter required="true" position="1"> 580 <maml:name>Id</maml:name> 581 <command:parameterValue required="true">string</command:parameterValue> 582 </command:parameter> 583 <command:parameter required="false" position="named"> 584 <maml:name>IgnoreDependencies</maml:name> 585 </command:parameter> 586 <command:parameter required="false" position="named"> 587 <maml:name>ProjectName</maml:name> 588 <command:parameterValue required="true">string</command:parameterValue> 589 </command:parameter> 590 <command:parameter required="false" position="named"> 591 <maml:name>Version</maml:name> 592 <command:parameterValue required="true">string</command:parameterValue> 593 </command:parameter> 594 <command:parameter required="false" position="named"> 595 <maml:name>Safe</maml:name> 596 </command:parameter> 597 <command:parameter required="false" position="named"> 598 <maml:name>Source</maml:name> 599 <command:parameterValue required="true">string</command:parameterValue> 600 </command:parameter> 601 <command:parameter required="false" position="named"> 602 <maml:name>IncludePrerelease</maml:name> 603 </command:parameter> 604 <command:parameter required="false" position="named"> 605 <maml:name>Reinstall</maml:name> 606 </command:parameter> 607 <command:parameter required="false" position="named"> 608 <maml:name>FileConflictAction</maml:name> 609 </command:parameter> 610 <command:parameter required="false" position="named"> 611 <maml:name>WhatIf</maml:name> 612 </command:parameter> 613 </command:syntaxItem> 614 </command:syntax> 615 616 <!-- Cmdlet parameter section --> 617 <command:parameters> 618 <command:parameter required="true" position="1"> 619 <maml:name>Id</maml:name> 620 <maml:description> 621 <maml:para>Specifies the package ID of the package to update. If omitted, every package is updated.</maml:para> 622 </maml:description> 623 <command:parameterValue required="true"> 624 string 625 </command:parameterValue> 626 <dev:defaultValue></dev:defaultValue> 627 </command:parameter> 628 <command:parameter required="false" position="named"> 629 <maml:name>IgnoreDependencies</maml:name> 630 <maml:description> 631 <maml:para>Updates all of the package’s dependencies to the latest version. False by default.</maml:para> 632 </maml:description> 633 </command:parameter> 634 <command:parameter required="false" position="named"> 635 <maml:name>ProjectName</maml:name> 636 <maml:description> 637 <maml:para>Specifies the project containing the project to update. If ommitted, the package is updated in every project with the package installed.</maml:para> 638 </maml:description> 639 <command:parameterValue required="true"> 640 string 641 </command:parameterValue> 642 </command:parameter> 643 <command:parameter required="false" position="named"> 644 <maml:name>Safe</maml:name> 645 <maml:description> 646 <maml:para>Constrains upgrades to newer versions with the same Major and Minor version component. For example, if version 1.0.0 of a package is installed, and versions 1.0.1, 1.0.2, and 1.1 are available in the feed, the -Safe flag updates the package to 1.0.2.</maml:para> 647 </maml:description> 648 </command:parameter> 649 <command:parameter required="false" position="named"> 650 <maml:name>Source</maml:name> 651 <maml:description> 652 <maml:para>Specifies the URL or directory path for the package source containing the package to update. When set to a local file system path, Source can be either absolute or relative to the current directory. If omitted, looks in the currently selected package source to find the corresponding package URL.</maml:para> 653 </maml:description> 654 <command:parameterValue required="true"> 655 string 656 </command:parameterValue> 657 </command:parameter> 658 <command:parameter required="false" position="named"> 659 <maml:name>Version</maml:name> 660 <maml:description> 661 <maml:para>Specifies the version that the package will be upgraded to. If omitted, defaults to the latest version.</maml:para> 662 </maml:description> 663 <command:parameterValue required="true"> 664 string 665 </command:parameterValue> 666 </command:parameter> 667 <command:parameter required="false" position="named"> 668 <maml:name>IncludePrerelease</maml:name> 669 <maml:description> 670 <maml:para>Indicates whether to include prereleases when searching for updates. If omitted, only stable packages are considered.</maml:para> 671 </maml:description> 672 </command:parameter> 673 <command:parameter required="false" position="named"> 674 <maml:name>Reinstall</maml:name> 675 <maml:description> 676 <maml:para>Reinstall packages with the existing versions.</maml:para> 677 </maml:description> 678 </command:parameter> 679 <command:parameter required="false" position="named"> 680 <maml:name>FileConflictAction</maml:name> 681 <maml:description> 682 <maml:para>Indicates what this command should do if a file from the package's content folder already exists in the project.</maml:para> 683 </maml:description> 684 </command:parameter> 685 <command:parameter required="false" position="named"> 686 <maml:name>WhatIf</maml:name> 687 <maml:description> 688 <maml:para>Displays the actions that would be taken and the effect of the command, instead of executing the command.</maml:para> 689 </maml:description> 690 </command:parameter> 691 </command:parameters> 692 693 <command:examples> 694 <command:example> 695 <maml:title>---------- EXAMPLE 1 ----------</maml:title> 696 <dev:code>PM> Update-Package Elmah</dev:code> 697 <dev:remarks> 698 <maml:para> 699 Description 700 ------------------------------------------------------------------ 701 Updates the Elmah package installed in every project to the latest version. 702 </maml:para> 703 <maml:para></maml:para> 704 <maml:para></maml:para> 705 </dev:remarks> 706 </command:example> 707 <command:example> 708 <maml:title>---------- EXAMPLE 2 ----------</maml:title> 709 <dev:code>PM> Update-Package Elmah -Version 1.1.0</dev:code> 710 <dev:remarks> 711 <maml:para> 712 Description 713 ------------------------------------------------------------------ 714 Updates the Elmah package to a specific version in every project. 715 </maml:para> 716 <maml:para></maml:para> 717 <maml:para></maml:para> 718 </dev:remarks> 719 </command:example> 720 <command:example> 721 <maml:title>---------- EXAMPLE 3 ----------</maml:title> 722 <dev:code>PM> Update-Package</dev:code> 723 <dev:remarks> 724 <maml:para> 725 Description 726 ------------------------------------------------------------------ 727 Updates every package in every project. 728 </maml:para> 729 <maml:para></maml:para> 730 <maml:para></maml:para> 731 </dev:remarks> 732 </command:example> 733 <command:example> 734 <maml:title>---------- EXAMPLE 3 ----------</maml:title> 735 <dev:code>PM> Update-Package -Safe -Project MvcApplication1</dev:code> 736 <dev:remarks> 737 <maml:para> 738 Description 739 ------------------------------------------------------------------ 740 Updates every package in the project, MvcApplication1, to the latest "safe" version. For example, 741 if version 1.0.0 of a package is installed, and versions 1.0.1, 1.0.2, and 1.1 are 742 available in the feed, the -Safe flag updates the package to 1.0.2. 743 </maml:para> 744 <maml:para></maml:para> 745 <maml:para></maml:para> 746 </dev:remarks> 747 </command:example> 748 </command:examples> 749 750 <!-- Link section --> 751 <maml:relatedLinks> 752 <maml:navigationLink> 753 <maml:linkText>Online version:</maml:linkText> 754 <maml:uri>http://docs.nuget.org/</maml:uri> 755 </maml:navigationLink> 756 <maml:navigationLink> 757 <maml:linkText>Update-Package</maml:linkText> 758 <maml:uri/> 759 </maml:navigationLink> 760 </maml:relatedLinks> 761 </command:command> 762 763 <!-- Add-BindingRedirect command --> 764 <command:command 765 xmlns:maml="http://schemas.microsoft.com/maml/2004/10" 766 xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" 767 xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> 768 769 <command:details> 770 <command:name> 771 Add-BindingRedirect 772 </command:name> 773 <maml:description> 774 <maml:para>Adds binding redirects to the config file.</maml:para> 775 </maml:description> 776 <command:verb>Add</command:verb> 777 <command:noun>BindingRedirect</command:noun> 778 <dev:version></dev:version> 779 </command:details> 780 781 <maml:description> 782 <maml:para> 783 Examines all assemblies within the output path for a project and adds binding redirects to the 784 application (or web) configuration file where necessary. NOTE: As of NuGet 1.2, NuGet automatically 785 runs this command when installing a package. 786 </maml:para> 787 </maml:description> 788 789 <!-- Cmdlet syntax section--> 790 <command:syntax> 791 <command:syntaxItem> 792 <maml:name>Add-BindingRedirect</maml:name> 793 <command:parameter required="true" position="1"> 794 <maml:name>ProjectName</maml:name> 795 <command:parameterValue required="true">string</command:parameterValue> 796 </command:parameter> 797 </command:syntaxItem> 798 </command:syntax> 799 800 <!-- Cmdlet parameter section --> 801 <command:parameters> 802 <command:parameter required="true" position="1"> 803 <maml:name>ProjectName</maml:name> 804 <maml:description> 805 <maml:para>Specifies the project to analyze and add binding redirects to.</maml:para> 806 </maml:description> 807 <command:parameterValue required="true"> 808 string 809 </command:parameterValue> 810 </command:parameter> 811 </command:parameters> 812 813 <command:examples> 814 <command:example> 815 <maml:title>---------- EXAMPLE 1 ----------</maml:title> 816 <dev:code>PM> Add-BindingRedirect MyProjectName</dev:code> 817 <dev:remarks> 818 <maml:para> 819 Description 820 ------------------------------------------------------------------ 821 Adds binding redirects to the specified project, MyProjectName. 822 </maml:para> 823 <maml:para></maml:para> 824 <maml:para></maml:para> 825 </dev:remarks> 826 </command:example> 827 </command:examples> 828 829 <!-- Link section --> 830 <maml:relatedLinks> 831 <maml:navigationLink> 832 <maml:linkText>Online version:</maml:linkText> 833 <maml:uri>http://docs.nuget.org/</maml:uri> 834 </maml:navigationLink> 835 <maml:navigationLink> 836 <maml:linkText>Add-BindingRedirect</maml:linkText> 837 <maml:uri/> 838 </maml:navigationLink> 839 </maml:relatedLinks> 840 </command:command> 841 842 <!-- Get-Project --> 843 <command:command 844 xmlns:maml="http://schemas.microsoft.com/maml/2004/10" 845 xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" 846 xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> 847 848 <command:details> 849 <command:name> 850 Get-Project 851 </command:name> 852 <maml:description> 853 <maml:para>Gets the specified project. If none is specified, returns the default project.</maml:para> 854 </maml:description> 855 <command:verb>Get</command:verb> 856 <command:noun>Project</command:noun> 857 <dev:version></dev:version> 858 </command:details> 859 860 <maml:description> 861 <maml:para>Returns a reference to the DTE (Development Tools Environment) for the specified project. If none is specifed, returns the default project selected in the Package Manager Console.</maml:para> 862 </maml:description> 863 864 <!-- Cmdlet syntax section--> 865 <command:syntax> 866 <command:syntaxItem> 867 <maml:name>Get-Project</maml:name> 868 <command:parameter required="false" position="1"> 869 <maml:name>Name</maml:name> 870 <command:parameterValue required="true">string</command:parameterValue> 871 </command:parameter> 872 <command:parameter required="false" position="named"> 873 <maml:name>All</maml:name> 874 </command:parameter> 875 </command:syntaxItem> 876 </command:syntax> 877 878 <!-- Cmdlet parameter section --> 879 <command:parameters> 880 <command:parameter required="false" position="1"> 881 <maml:name>Name</maml:name> 882 <maml:description> 883 <maml:para>Specifies the project to return. If ommitted, the default project selected in the Package Manager Console is returned.</maml:para> 884 </maml:description> 885 <command:parameterValue required="true"> 886 string 887 </command:parameterValue> 888 </command:parameter> 889 <command:parameter required="false" position="named"> 890 <maml:name>All</maml:name> 891 <maml:description> 892 <maml:para>Returns every project in the solution.</maml:para> 893 </maml:description> 894 </command:parameter> 895 </command:parameters> 896 897 <command:examples> 898 <command:example> 899 <maml:title>---------- EXAMPLE 1 ----------</maml:title> 900 <dev:code>PM> Get-Project</dev:code> 901 <dev:remarks> 902 <maml:para> 903 Description 904 ------------------------------------------------------------------ 905 Returns a reference to the default project. 906 </maml:para> 907 <maml:para></maml:para> 908 <maml:para></maml:para> 909 </dev:remarks> 910 </command:example> 911 <command:example> 912 <maml:title>---------- EXAMPLE 2 ----------</maml:title> 913 <dev:code>PM> Get-Project MyProjectName</dev:code> 914 <dev:remarks> 915 <maml:para> 916 Description 917 ------------------------------------------------------------------ 918 Returns a reference to the specifed project, MyProjectName. 919 </maml:para> 920 <maml:para></maml:para> 921 <maml:para></maml:para> 922 </dev:remarks> 923 </command:example> 924 <command:example> 925 <maml:title>---------- EXAMPLE 3 ----------</maml:title> 926 <dev:code>PM> Get-Project -All</dev:code> 927 <dev:remarks> 928 <maml:para> 929 Description 930 ------------------------------------------------------------------ 931 Returns a reference to every project in the solution. 932 </maml:para> 933 <maml:para></maml:para> 934 <maml:para></maml:para> 935 </dev:remarks> 936 </command:example> 937 </command:examples> 938 939 <!-- Link section --> 940 <maml:relatedLinks> 941 <maml:navigationLink> 942 <maml:linkText>Online version:</maml:linkText> 943 <maml:uri>http://docs.nuget.org/</maml:uri> 944 </maml:navigationLink> 945 <maml:navigationLink> 946 <maml:linkText>Get-Project</maml:linkText> 947 <maml:uri/> 948 </maml:navigationLink> 949 </maml:relatedLinks> 950 </command:command> 951 952 <!-- Open-PackagePage --> 953 <command:command 954 xmlns:maml="http://schemas.microsoft.com/maml/2004/10" 955 xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" 956 xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> 957 958 <command:details> 959 <command:name> 960 Open-PackagePage 961 </command:name> 962 <maml:description> 963 <maml:para> 964 Open the browser pointing to ProjectUrl, LicenseUrl or ReportAbuseUrl of the specified package. 965 </maml:para> 966 </maml:description> 967 <command:verb>Open</command:verb> 968 <command:noun>PackagePage</command:noun> 969 <dev:version></dev:version> 970 </command:details> 971 972 <maml:description> 973 <maml:para> 974 Open the browser pointing to ProjectUrl, LicenseUrl or ReportAbuseUrl of the specified package. 975 </maml:para> 976 </maml:description> 977 978 <!-- Cmdlet syntax section--> 979 <command:syntax> 980 <command:syntaxItem> 981 <maml:name>Open-PackagePage</maml:name> 982 <command:parameter required="true" position="named"> 983 <maml:name>Id</maml:name> 984 <command:parameterValue required="true">string</command:parameterValue> 985 </command:parameter> 986 <command:parameter required="false" position="named"> 987 <maml:name>Version</maml:name> 988 </command:parameter> 989 <command:parameter required="false" position="named"> 990 <maml:name>Source</maml:name> 991 </command:parameter> 992 <command:parameter required="false" position="named"> 993 <maml:name>License</maml:name> 994 </command:parameter> 995 <command:parameter required="false" position="named"> 996 <maml:name>ReportAbuse</maml:name> 997 </command:parameter> 998 <command:parameter required="false" position="named"> 999 <maml:name>PassThru</maml:name> 1000 </command:parameter> 1001 </command:syntaxItem> 1002 </command:syntax> 1003 1004 <!-- Cmdlet parameter section --> 1005 <command:parameters> 1006 <command:parameter required="false" position="named"> 1007 <maml:name>Id</maml:name> 1008 <maml:description> 1009 <maml:para>Specifies the Id of the package to search for.</maml:para> 1010 </maml:description> 1011 <command:parameterValue required="true">string</command:parameterValue> 1012 </command:parameter> 1013 <command:parameter required="false" position="named"> 1014 <maml:name>Version</maml:name> 1015 <maml:description> 1016 <maml:para>Specifies the version of the package to search for. If omitted, defaults to the latest version.</maml:para> 1017 </maml:description> 1018 </command:parameter> 1019 <command:parameter required="false" position="named"> 1020 <maml:name>Source</maml:name> 1021 <maml:description> 1022 <maml:para>Specifies the source of the repository to search for package. If omitted, defaults to the selected source in the package source dropdown control.</maml:para> 1023 </maml:description> 1024 </command:parameter> 1025 <command:parameter required="false" position="named"> 1026 <maml:name>License</maml:name> 1027 <maml:description> 1028 <maml:para>Indicates the cmdlet should open the LicenseUrl of the specified package. If neither LicenseUrl nor ReportAbuseUrl is set, the cmdlet will open the ProjectUrl by default.</maml:para> 1029 </maml:description> 1030 </command:parameter> 1031 <command:parameter required="false" position="named"> 1032 <maml:name>ReportAbuse</maml:name> 1033 <maml:description> 1034 <maml:para>Indicates the cmdlet should open the ReportAbuseUrl of the specified package. If neither LicenseUrl nor ReportAbuseUrl is set, the cmdlet will open the ProjectUrl by default.</maml:para> 1035 </maml:description> 1036 </command:parameter> 1037 <command:parameter required="false" position="named"> 1038 <maml:name>PassThru</maml:name> 1039 <maml:description> 1040 <maml:para>If specified, the cmdlet will return the value of the requested URL.</maml:para> 1041 </maml:description> 1042 </command:parameter> 1043 </command:parameters> 1044 1045 <command:examples> 1046 <command:example> 1047 <maml:title>---------- EXAMPLE 1 ----------</maml:title> 1048 <dev:code>PM> Open-PackagePage Ninject</dev:code> 1049 <dev:remarks> 1050 <maml:para> 1051 Description 1052 ------------------------------------------------------------------ 1053 Opens a browser to the project URL specified in the Ninject package. 1054 </maml:para> 1055 <maml:para></maml:para> 1056 <maml:para></maml:para> 1057 </dev:remarks> 1058 </command:example> 1059 <command:example> 1060 <maml:title>---------- EXAMPLE 2 ----------</maml:title> 1061 <dev:code>PM> Open-PackagePage Ninject -License</dev:code> 1062 <dev:remarks> 1063 <maml:para> 1064 Description 1065 ------------------------------------------------------------------ 1066 Opens a browser to the license URL specified in the Ninject package. 1067 </maml:para> 1068 <maml:para></maml:para> 1069 <maml:para></maml:para> 1070 </dev:remarks> 1071 </command:example> 1072 <command:example> 1073 <maml:title>---------- EXAMPLE 3 ----------</maml:title> 1074 <dev:code>PM> Open-PackagePage Ninject -ReportAbuse</dev:code> 1075 <dev:remarks> 1076 <maml:para> 1077 Description 1078 ------------------------------------------------------------------ 1079 Opens a browser to the URL at the current package source used to report abuse for the specified package. 1080 </maml:para> 1081 <maml:para></maml:para> 1082 <maml:para></maml:para> 1083 </dev:remarks> 1084 </command:example> 1085 <command:example> 1086 <maml:title>---------- EXAMPLE 4 ----------</maml:title> 1087 <dev:code>PM> $url = Open-PackagePage Ninject -License -WhatIf -PassThru</dev:code> 1088 <dev:remarks> 1089 <maml:para> 1090 Description 1091 ------------------------------------------------------------------ 1092 Assigns the license URL to the variable, $url, without opening the URL in a browser. 1093 </maml:para> 1094 <maml:para></maml:para> 1095 <maml:para></maml:para> 1096 </dev:remarks> 1097 </command:example> 1098 </command:examples> 1099 1100 <!-- Link section --> 1101 <maml:relatedLinks> 1102 <maml:navigationLink> 1103 <maml:linkText>Online version:</maml:linkText> 1104 <maml:uri>http://docs.nuget.org/</maml:uri> 1105 </maml:navigationLink> 1106 <maml:navigationLink> 1107 <maml:linkText>Open-PackagePage</maml:linkText> 1108 <maml:uri/> 1109 </maml:navigationLink> 1110 </maml:relatedLinks> 1111 </command:command> 1112</helpItems>