/src/AddIns/Misc/PackageManagement/RequiredLibraries/NuGet.Cmdlets.dll-Help.xml

https://github.com/ajadex/SharpDevelop · XML · 1112 lines · 1032 code · 50 blank · 30 comment · 0 complexity · 090b63081db9fe28f19448c0bbcc6ea0 MD5 · raw file

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