Merge branch 'stable'

* stable:
  (doc) update generated docs
  (doc) New parameter choco version availability

docs/generated/CommandsApiKey.md

@@ -15,18 +15,34 @@ Anything that doesn't contain source and key will list api keys.
 ## Examples
 
     choco apikey
-    choco apikey -s"https://somewhere/out/there"
-    choco apikey -s"https://somewhere/out/there/" -k="value"
-    choco apikey -s"https://chocolatey.org/" -k="123-123123-123"
+    choco apikey -s https://somewhere/out/there
+    choco apikey -s="https://somewhere/out/there/" -k="value"
+    choco apikey -s "https://push.chocolatey.org/" -k="123-123123-123"
+    choco apikey -s "http://internal_nexus" -k="user:password"
 
-## Connecting to Chocolatey.org
+For source location, this can be a folder/file share or an 
+http location. When it comes to urls, they can be different from the packages 
+url (where packages are searched and installed from). As an example, for 
+Chocolatey's community package package repository, the package url is 
+https://chocolatey.org/api/v2, but the push url is https://push.chocolatey.org 
+(and the deprecated https://chocolatey.org/ as a push url). Check the 
+documentation for your choice of repository to learn what the push url is. 
 
-In order to save your API key for https://chocolatey.org/, 
+For the key, this can be an apikey that is provided by your source repository. 
+With some sources, like Nexus, this can be a NuGet API key or it could be a 
+user name and password specified as 'user:password' for the API key. Please see 
+your repository's documentation (for Nexus, please see 
+https://bit.ly/nexus2apikey).
+
+
+## Connecting to Chocolatey.org (Community Package Repository)
+
+In order to save your API key for https://push.chocolatey.org/, 
  log in (or register, confirm and then log in) to
- https://chocolatey.org/, go to https://chocolatey.org/account, 
+ https://push.chocolatey.org/, go to https://push.chocolatey.org/account, 
  copy the API Key, and then use it in the following command:
 
-    choco apikey -k <your key here> -s https://chocolatey.org/
+    choco apikey -k <your key here> -s https://push.chocolatey.org/
 
 
 ## Options and Switches
@@ -133,7 +149,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
      Source [REQUIRED] - The source location for the key
 
  -k, --key, --apikey, --api-key=VALUE
-     ApiKey - The api key for the source.
+     ApiKey - The API key for the source. This is the authentication that 
+       identifies you and allows you to push to a source. With some sources 
+       this is either a key or it could be a user name and password specified 
+       as 'user:password'.
 
 ~~~
 

docs/generated/CommandsInstall.md

@@ -431,6 +431,13 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        installer for software. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. 
        See https://chocolatey.org/docs/features-install-directory-override 
 
+     --bps, --maxdownloadrate, --max-download-rate, --maxdownloadbitspersecond, --max-download-bits-per-second, --maximumdownloadbitspersecond, --maximum-download-bits-per-second=VALUE
+     Maximum Download Rate Bits Per Second - The maximum download rate in 
+       bits per second. '0' or empty means no maximum. A number means that will 
+       be the maximum download rate in bps. Defaults to config setting of '0'. 
+       Available in [licensed editions](https://chocolatey.org/compare) v2+ only. See https://chocolate-
+       y.org/docs/features-download-throttle  
+
 ~~~
 
 [[Command Reference|CommandsReference]]

docs/generated/CommandsList.md

@@ -155,6 +155,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
  -l, --lo, --localonly, --local-only
      LocalOnly - Only search against local machine items.
 
+     --idonly, --id-only
+     Id Only - Only return Package Ids in the list results. Available in 0.1-
+       0.6+.
+
      --pre, --prerelease
      Prerelease - Include Prereleases? Defaults to false.
 
@@ -198,6 +202,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
      ByIdOnly - Only return packages where the id contains the search filter. 
        Available in 0.9.10+.
 
+     --by-tag-only, --by-tags-only
+     ByTagOnly - Only return packages where the search filter matches on the 
+       tags. Available in 0.10.6+.
+
      --id-starts-with
      IdStartsWith - Only return packages where the id starts with the search 
        filter. Available in 0.9.10+.

docs/generated/CommandsOutdated.md

@@ -145,6 +145,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
      Certificate Password - the client certificate's password to the source. 
        Defaults to empty. Available in 0.9.10+.
 
+     --ignore-pinned
+     Ignore Pinned - Ignore pinned packages. Defaults to false. Available in 
+       0.10.6+.
+
 ~~~
 
 [[Command Reference|CommandsReference]]

docs/generated/CommandsPush.md

@@ -12,7 +12,7 @@ Chocolatey will attempt to push a compiled nupkg to a package feed.
  [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`).
 
 A feed can be a local folder, a file share, the [community feed](https://chocolatey.org/packages) 
- (https://chocolatey.org/), or a custom/private feed. For web
+ (https://push.chocolatey.org/), or a custom/private feed. For web
  feeds, it has a requirement that it implements the proper OData
  endpoints required for NuGet packages.
 
@@ -43,8 +43,8 @@ A common error is `Failed to process request. 'The specified API key
  does not provide the authority to push packages.' The remote server 
  returned an error: (403) Forbidden..` This means the package already 
  exists with a different user (API key). The package could be unlisted. 
- You can verify by going to https://chocolatey.org/packages/packageName. 
- Please contact the administrators of https://chocolatey.org/ if you see this 
+ You can verify by going to https://push.chocolatey.org/packages/packageName. 
+ Please contact the administrators of https://push.chocolatey.org/ if you see this 
  and you don't see a good reason for it.
 
 ## Options and Switches
@@ -148,8 +148,8 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        proxy bypass on local setting of 'True'. Available in 0.10.4+.
 
  -s, --source=VALUE
-     Source - The source we are pushing the package to. Use 
-       https://chocolatey.org/ to push to [community feed](https://chocolatey.org/packages).
+     Source - The source we are pushing the package to. Use https://pus-
+       h.chocolatey.org/ to push to [community feed](https://chocolatey.org/packages).
 
  -k, --key, --apikey, --api-key=VALUE
      ApiKey - The api key for the source. If not specified (and not local 

docs/generated/CommandsSearch.md

@@ -155,6 +155,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
  -l, --lo, --localonly, --local-only
      LocalOnly - Only search against local machine items.
 
+     --idonly, --id-only
+     Id Only - Only return Package Ids in the list results. Available in 0.1-
+       0.6+.
+
      --pre, --prerelease
      Prerelease - Include Prereleases? Defaults to false.
 
@@ -198,6 +202,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
      ByIdOnly - Only return packages where the id contains the search filter. 
        Available in 0.9.10+.
 
+     --by-tag-only, --by-tags-only
+     ByTagOnly - Only return packages where the search filter matches on the 
+       tags. Available in 0.10.6+.
+
      --id-starts-with
      IdStartsWith - Only return packages where the id starts with the search 
        filter. Available in 0.9.10+.

docs/generated/CommandsSetapiKey.md

@@ -15,18 +15,34 @@ Anything that doesn't contain source and key will list api keys.
 ## Examples
 
     choco apikey
-    choco apikey -s"https://somewhere/out/there"
-    choco apikey -s"https://somewhere/out/there/" -k="value"
-    choco apikey -s"https://chocolatey.org/" -k="123-123123-123"
+    choco apikey -s https://somewhere/out/there
+    choco apikey -s="https://somewhere/out/there/" -k="value"
+    choco apikey -s "https://push.chocolatey.org/" -k="123-123123-123"
+    choco apikey -s "http://internal_nexus" -k="user:password"
 
-## Connecting to Chocolatey.org
+For source location, this can be a folder/file share or an 
+http location. When it comes to urls, they can be different from the packages 
+url (where packages are searched and installed from). As an example, for 
+Chocolatey's community package package repository, the package url is 
+https://chocolatey.org/api/v2, but the push url is https://push.chocolatey.org 
+(and the deprecated https://chocolatey.org/ as a push url). Check the 
+documentation for your choice of repository to learn what the push url is. 
 
-In order to save your API key for https://chocolatey.org/, 
+For the key, this can be an apikey that is provided by your source repository. 
+With some sources, like Nexus, this can be a NuGet API key or it could be a 
+user name and password specified as 'user:password' for the API key. Please see 
+your repository's documentation (for Nexus, please see 
+https://bit.ly/nexus2apikey).
+
+
+## Connecting to Chocolatey.org (Community Package Repository)
+
+In order to save your API key for https://push.chocolatey.org/, 
  log in (or register, confirm and then log in) to
- https://chocolatey.org/, go to https://chocolatey.org/account, 
+ https://push.chocolatey.org/, go to https://push.chocolatey.org/account, 
  copy the API Key, and then use it in the following command:
 
-    choco apikey -k <your key here> -s https://chocolatey.org/
+    choco apikey -k <your key here> -s https://push.chocolatey.org/
 
 
 ## Options and Switches
@@ -133,7 +149,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
      Source [REQUIRED] - The source location for the key
 
  -k, --key, --apikey, --api-key=VALUE
-     ApiKey - The api key for the source.
+     ApiKey - The API key for the source. This is the authentication that 
+       identifies you and allows you to push to a source. With some sources 
+       this is either a key or it could be a user name and password specified 
+       as 'user:password'.
 
 ~~~
 

docs/generated/CommandsSource.md

@@ -19,13 +19,19 @@ Chocolatey will allow you to interact with sources.
 
     choco source
     choco source list
-    choco source add -n=bob -s"https://somewhere/out/there/api/v2/"
-    choco source add -n=bob -s"'https://somewhere/out/there/api/v2/'" -cert=\Users\bob\bob.pfx
-    choco source add -n=bob -s"'https://somewhere/out/there/api/v2/'" -u=bob -p=12345
+    choco source add -n=bob -s="https://somewhere/out/there/api/v2/"
+    choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -cert=\Users\bob\bob.pfx
+    choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -u=bob -p=12345
     choco source disable -n=bob
     choco source enable -n=bob
     choco source remove -n=bob
 
+When it comes to the source location, this can be a folder/file share or an http
+location. If it is a url, it will be a location you can go to in a browser and 
+it returns OData with something that says Packages in the browser, similar to 
+what you see when you go to https://chocolatey.org/api/v2/.
+
+
 ## Options and Switches
 
 **NOTE:** Options and switches apply to all items passed, so if you are
@@ -131,7 +137,11 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        empty.
 
  -s, --source=VALUE
-     Source - The source. Defaults to empty.
+     Source - The source. This can be a folder/file share or an http locatio-
+       n. If it is a url, it will be a location you can go to in a browser and 
+       it returns OData with something that says Packages in the browser, 
+       similar to what you see when you go to https://chocolatey.org/api/v2/. 
+       Defaults to empty.
 
  -u, --user=VALUE
      User - used with authenticated feeds. Defaults to empty.

docs/generated/CommandsSources.md

@@ -19,13 +19,19 @@ Chocolatey will allow you to interact with sources.
 
     choco source
     choco source list
-    choco source add -n=bob -s"https://somewhere/out/there/api/v2/"
-    choco source add -n=bob -s"'https://somewhere/out/there/api/v2/'" -cert=\Users\bob\bob.pfx
-    choco source add -n=bob -s"'https://somewhere/out/there/api/v2/'" -u=bob -p=12345
+    choco source add -n=bob -s="https://somewhere/out/there/api/v2/"
+    choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -cert=\Users\bob\bob.pfx
+    choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -u=bob -p=12345
     choco source disable -n=bob
     choco source enable -n=bob
     choco source remove -n=bob
 
+When it comes to the source location, this can be a folder/file share or an http
+location. If it is a url, it will be a location you can go to in a browser and 
+it returns OData with something that says Packages in the browser, similar to 
+what you see when you go to https://chocolatey.org/api/v2/.
+
+
 ## Options and Switches
 
 **NOTE:** Options and switches apply to all items passed, so if you are
@@ -131,7 +137,11 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        empty.
 
  -s, --source=VALUE
-     Source - The source. Defaults to empty.
+     Source - The source. This can be a folder/file share or an http locatio-
+       n. If it is a url, it will be a location you can go to in a browser and 
+       it returns OData with something that says Packages in the browser, 
+       similar to what you see when you go to https://chocolatey.org/api/v2/. 
+       Defaults to empty.
 
  -u, --user=VALUE
      User - used with authenticated feeds. Defaults to empty.

docs/generated/CommandsUpgrade.md

@@ -352,6 +352,13 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        installer for software. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. 
        See https://chocolatey.org/docs/features-install-directory-override 
 
+     --bps, --maxdownloadrate, --max-download-rate, --maxdownloadbitspersecond, --max-download-bits-per-second, --maximumdownloadbitspersecond, --maximum-download-bits-per-second=VALUE
+     Maximum Download Rate Bits Per Second - The maximum download rate in 
+       bits per second. '0' or empty means no maximum. A number means that will 
+       be the maximum download rate in bps. Defaults to config setting of '0'. 
+       Available in [licensed editions](https://chocolatey.org/compare) v2+ only. See https://chocolate-
+       y.org/docs/features-download-throttle  
+
 ~~~
 
 [[Command Reference|CommandsReference]]

docs/generated/HelpersInstallChocolateyPackage.md

@@ -211,9 +211,16 @@ a 32 bit installation on a 64 bit system.
 
 Prefer HTTPS when available. Can be HTTP, FTP, or File URIs.
 
+In 0.10.6+, `File` and `FileFullPath` are aliases for Url. These 
+aliases, if used in earlier versions of Chocolatey, produce `ERROR: 
+Cannot bind parameter because parameter 'fileType' is specified more 
+than once.` See https://github.com/chocolatey/choco/issues/1284. Do not
+use these aliases with the community package repository until January
+2018.
+
 Property               | Value
----------------------- | -----
-Aliases                | 
+---------------------- | ------------------
+Aliases                | file, fileFullPath
 Required?              | false
 Position?              | 4
 Default Value          | 
@@ -230,9 +237,16 @@ this parameter.
 
 Prefer HTTPS when available. Can be HTTP, FTP, or File URIs.
 
+In 0.10.6+, `File64` and `FileFullPath64` are aliases for Url64Bit. 
+These aliases, if used in earlier versions of Chocolatey, produce 
+`ERROR: Cannot bind parameter because parameter 'fileType' is specified
+more than once.` See https://github.com/chocolatey/choco/issues/1284. 
+Do not use these aliases with the community package repository until 
+January 2018.
+
 Property               | Value
----------------------- | -----
-Aliases                | url64
+---------------------- | -----------------------------
+Aliases                | url64, file64, fileFullPath64
 Required?              | false
 Position?              | 5
 Default Value          | 

docs/generated/HelpersInstallChocolateyPowershellCommand.md

@@ -104,9 +104,11 @@ Full file path to PowerShell file to turn into a command. If embedding
 it in the package next to the install script, the path will be like
 `"$(Split-Path -parent $MyInvocation.MyCommand.Definition)\\Script.ps1"`
 
+In 0.10.6+, `File` and `FileFullPath` are aliases for PsFileFullPath.
+
 Property               | Value
----------------------- | -----
-Aliases                | 
+---------------------- | ------------------
+Aliases                | file, fileFullPath
 Required?              | true
 Position?              | 2
 Default Value          | 
@@ -116,7 +118,7 @@ Accept Pipeline Input? | false
 This is the 32 bit url to download the resource from. This resource can
 be used on 64 bit systems when a package has both a Url and Url64bit
 specified if a user passes `--forceX86`. If there is only a 64 bit url
-available, please remove do not use the parameter (only use Url64bit).
+available, please remove do not use this parameter (only use Url64bit).
 Will fail on 32bit systems if missing or if a user attempts to force
 a 32 bit installation on a 64 bit system.
 

docs/generated/HelpersInstallChocolateyVsixPackage.md

@@ -95,9 +95,16 @@ Prefer HTTPS when available. Can be HTTP, FTP, or File URIs.
 
 In 0.10.4+, `Url` is an alias for VsixUrl.
 
+In 0.10.6+, `File` and `FileFullPath` are aliases for VsixUrl. These 
+aliases, if used in earlier versions of Chocolatey, may produce `ERROR: 
+Cannot bind parameter because parameter 'fileType' is specified more 
+than once.` See https://github.com/chocolatey/choco/issues/1284. Do not
+use these aliases with the community package repository until January
+2018.
+
 Property               | Value
----------------------- | -----
-Aliases                | url
+---------------------- | -----------------------
+Aliases                | url, file, fileFullPath
 Required?              | false
 Position?              | 2
 Default Value          |