Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Commit

Permalink
(doc) update generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ferventcoder committed Apr 5, 2017
1 parent 200c7ef commit 3064805
Show file tree
Hide file tree
Showing 32 changed files with 1,513 additions and 142 deletions.
42 changes: 40 additions & 2 deletions CommandsApiKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,13 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
Debug - Show debug messaging.
-v, --verbose
Verbose - Show verbose messaging.
Verbose - Show verbose messaging. Very verbose messaging, avoid using
under normal circumstances.
--trace
Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
except when needing super low-level .NET Framework debugging. Available
in 0.10.4+.
--acceptlicense, --accept-license
AcceptLicense - Accept license dialogs automatically. Reserved for
Expand All @@ -71,7 +77,7 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
--timeout, --execution-timeout=VALUE
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds.
configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-c, --cache, --cachelocation, --cache-location=VALUE
CacheLocation - Location for download cache, defaults to %TEMP% or value
Expand All @@ -91,6 +97,38 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
instead of the built-in PowerShell host. Should only be used when
internal host is failing. Available in 0.9.10+.
--no-progress
Do Not Show Progress - Do not show download progress percentages.
Available in 0.10.4+.
--proxy=VALUE
Proxy Location - Explicit proxy location. Overrides the default proxy
location of ''. Available for config settings in 0.9.9.9+, this CLI
option available in 0.10.4+.
--proxy-user=VALUE
Proxy User Name - Explicit proxy user (optional). Requires explicity
proxy (`--proxy` or config setting). Overrides the default proxy user of
'123'. Available for config settings in 0.9.9.9+, this CLI option
available in 0.10.4+.
--proxy-password=VALUE
Proxy Password - Explicit proxy password (optional) to be used with
username. Requires explicity proxy (`--proxy` or config setting) and
user name. Overrides the default proxy password (encrypted in settings
if set). Available for config settings in 0.9.9.9+, this CLI option
available in 0.10.4+.
--proxy-bypass-list=VALUE
ProxyBypassList - Comma separated list of regex locations to bypass on
proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
the default proxy bypass list of ''. Available in 0.10.4+.
--proxy-bypass-on-local
Proxy Bypass On Local - Bypass proxy for local connections. Requires
explicity proxy (`--proxy` or config setting). Overrides the default
proxy bypass on local setting of 'True'. Available in 0.10.4+.
-s, --source=VALUE
Source [REQUIRED] - The source location for the key
Expand Down
42 changes: 40 additions & 2 deletions CommandsConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,13 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
Debug - Show debug messaging.
-v, --verbose
Verbose - Show verbose messaging.
Verbose - Show verbose messaging. Very verbose messaging, avoid using
under normal circumstances.
--trace
Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
except when needing super low-level .NET Framework debugging. Available
in 0.10.4+.
--acceptlicense, --accept-license
AcceptLicense - Accept license dialogs automatically. Reserved for
Expand All @@ -71,7 +77,7 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
--timeout, --execution-timeout=VALUE
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds.
configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-c, --cache, --cachelocation, --cache-location=VALUE
CacheLocation - Location for download cache, defaults to %TEMP% or value
Expand All @@ -91,6 +97,38 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
instead of the built-in PowerShell host. Should only be used when
internal host is failing. Available in 0.9.10+.
--no-progress
Do Not Show Progress - Do not show download progress percentages.
Available in 0.10.4+.
--proxy=VALUE
Proxy Location - Explicit proxy location. Overrides the default proxy
location of ''. Available for config settings in 0.9.9.9+, this CLI
option available in 0.10.4+.
--proxy-user=VALUE
Proxy User Name - Explicit proxy user (optional). Requires explicity
proxy (`--proxy` or config setting). Overrides the default proxy user of
'123'. Available for config settings in 0.9.9.9+, this CLI option
available in 0.10.4+.
--proxy-password=VALUE
Proxy Password - Explicit proxy password (optional) to be used with
username. Requires explicity proxy (`--proxy` or config setting) and
user name. Overrides the default proxy password (encrypted in settings
if set). Available for config settings in 0.9.9.9+, this CLI option
available in 0.10.4+.
--proxy-bypass-list=VALUE
ProxyBypassList - Comma separated list of regex locations to bypass on
proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
the default proxy bypass list of ''. Available in 0.10.4+.
--proxy-bypass-on-local
Proxy Bypass On Local - Bypass proxy for local connections. Requires
explicity proxy (`--proxy` or config setting). Overrides the default
proxy bypass on local setting of 'True'. Available in 0.10.4+.
--name=VALUE
Name - the name of the config setting. Required with some actions.
Defaults to empty.
Expand Down
118 changes: 79 additions & 39 deletions CommandsDownload.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
<!-- This file is automatically generated based on output from https://github.com/chocolatey/choco/tree/stable/src/chocolatey/infrastructure.app/commands/ChocolateyDownloadCommand.cs using https://github.com/chocolatey/choco/tree/stable/GenerateDocs.ps1. Contributions are welcome at the original location(s). If the file is not found, it is not part of the open source edition of Chocolatey or the name of the file is different. -->
<!-- This file is automatically generated based on output from https://github.com/chocolatey/choco/tree/stable/src/chocolatey/infrastructure.app/commands/ChocolateyDownloadCommand.cs using https://github.com/chocolatey/choco/tree/stable/GenerateDocs.ps1. Contributions are welcome at the original location(s). If the file is not found, it is not part of the open source edition of Chocolatey or the name of the file is different. -->

# Download Command (choco download)

### Package Copy / Package Downloader

[Chocolatey Professional](https://chocolatey.org/compare) and up starting in version 1.7.1.

Downloads a package from a source and unpacks it.
Expand All @@ -18,6 +19,7 @@ Downloads a package from a source, optionally downloading remote

See https://chocolatey.org/docs/features-automatically-recompile-packages


## Usage

choco download <pkg> [<options/switches>]
Expand Down Expand Up @@ -58,18 +60,24 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
Debug - Show debug messaging.
-v, --verbose
Verbose - Show verbose messaging.
Verbose - Show verbose messaging. Very verbose messaging, avoid using
under normal circumstances.
--trace
Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
except when needing super low-level .NET Framework debugging. Available
in 0.10.4+.
--acceptlicense, --accept-license
AcceptLicense - Accept license dialogs automatically. Reserved for
AcceptLicense - Accept license dialogs automatically. Reserved for
future use.
-y, --yes, --confirm
Confirm all prompts - Chooses affirmative answer instead of prompting.
Confirm all prompts - Chooses affirmative answer instead of prompting.
Implies --accept-license
-f, --force
Force - force the behavior. Do not use force during normal operation -
Force - force the behavior. Do not use force during normal operation -
it subverts some of the smart behavior for commands.
--noop, --whatif, --what-if
Expand All @@ -79,30 +87,62 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
LimitOutput - Limit the output to essential information
--timeout, --execution-timeout=VALUE
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds.
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-c, --cache, --cachelocation, --cache-location=VALUE
CacheLocation - Location for download cache, defaults to %TEMP% or value
CacheLocation - Location for download cache, defaults to %TEMP% or value
in chocolatey.config file.
--allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
AllowUnofficialBuild - When not using the official build you must set
AllowUnofficialBuild - When not using the official build you must set
this flag for choco to continue.
--failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
FailOnStandardError - Fail on standard error output (stderr), typically
received when running external commands during install providers. This
FailOnStandardError - Fail on standard error output (stderr), typically
received when running external commands during install providers. This
overrides the feature failOnStandardError.
--use-system-powershell
UseSystemPowerShell - Execute PowerShell using an external process
instead of the built-in PowerShell host. Should only be used when
UseSystemPowerShell - Execute PowerShell using an external process
instead of the built-in PowerShell host. Should only be used when
internal host is failing. Available in 0.9.10+.
--no-progress
Do Not Show Progress - Do not show download progress percentages.
Available in 0.10.4+.
--proxy=VALUE
Proxy Location - Explicit proxy location. Overrides the default proxy
location of ''. Available for config settings in 0.9.9.9+, this CLI
option available in 0.10.4+.
--proxy-user=VALUE
Proxy User Name - Explicit proxy user (optional). Requires explicity
proxy (`--proxy` or config setting). Overrides the default proxy user of
'123'. Available for config settings in 0.9.9.9+, this CLI option
available in 0.10.4+.
--proxy-password=VALUE
Proxy Password - Explicit proxy password (optional) to be used with
username. Requires explicity proxy (`--proxy` or config setting) and
user name. Overrides the default proxy password (encrypted in settings
if set). Available for config settings in 0.9.9.9+, this CLI option
available in 0.10.4+.
--proxy-bypass-list=VALUE
ProxyBypassList - Comma separated list of regex locations to bypass on
proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
the default proxy bypass list of ''. Available in 0.10.4+.
--proxy-bypass-on-local
Proxy Bypass On Local - Bypass proxy for local connections. Requires
explicity proxy (`--proxy` or config setting). Overrides the default
proxy bypass on local setting of 'True'. Available in 0.10.4+.
-s, --source=VALUE
Source - The source to find the package(s) to download. Defaults to
Source - The source to find the package(s) to download. Defaults to
default feeds.
--version=VALUE
Expand All @@ -118,53 +158,53 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
Password - the user's password to the source. Defaults to empty.
--cert=VALUE
Client certificate - PFX pathname for an x509 authenticated feeds.
Client certificate - PFX pathname for an x509 authenticated feeds.
Defaults to empty.
--cp, --certpassword=VALUE
Certificate Password - the client certificate's password to the source.
Certificate Password - the client certificate's password to the source.
Defaults to empty.
--outputdirectory=VALUE
OutputDirectory - Specifies the directory for the downloaded Chocolatey
--out, --outdir, --outputdirectory, --output-directory=VALUE
OutputDirectory - Specifies the directory for the downloaded Chocolatey
package file. If not specified, uses the current directory.
-i, --ignoredependencies, --ignore-dependencies
IgnoreDependencies - Ignore dependencies when installing package(s).
Licensed editions v1.9.0+ Defaults to false.
IgnoreDependencies - Ignore dependencies when installing package(s).
[Licensed editions](https://chocolatey.org/compare) v1.9.0+ Defaults to false.
--recompile, --internalize
Recompile / Internalize - Download all external resources and recompile
the package to use the local resources instead. Business editions only
Recompile / Internalize - Download all external resources and recompile
the package to use the local resources instead. Business editions only
(licensed version 1.5.0+).
--resources-location=VALUE
Resources Location - When internalizing, use this location for resources
instead of embedding the downloaded resources into the package. Can be a
file share or an internal url location. When it is a file share, it will
attempt to download to that location. When it is an internal url, it
will download locally and give further instructions on where it should
be uploaded to match package edits. Business editions only (licensed
Resources Location - When internalizing, use this location for resources
instead of embedding the downloaded resources into the package. Can be a
file share or an internal url location. When it is a file share, it will
attempt to download to that location. When it is an internal url, it
will download locally and give further instructions on where it should
be uploaded to match package edits. Business editions only (licensed
version 1.5.1+).
--download-location=VALUE
Download Location - OPTIONAL - when internalizing, download the
resources to this location. Used with Resources Location (and defaults
to Resources Location when not set). Business editions only (licensed
version 1.8.3+).
Download Location - OPTIONAL - when internalizing, download the
resources to this location. Used with Resources Location (and defaults
to Resources Location when not set). Business editions only (licensed
version 1.8.3+).
--append-useoriginallocation, --append-use-original-location
Append -UseOriginalLocation - When `Install-ChocolateyPackage` is
internalized, append the `-UseOriginalLocation` parameter to the
function. Business editions only (licensed version 1.7.0+). Requires at
least Chocolatey v0.10.1 for `Install-ChocolateyPackage` to recognize
the switch appropriately. Overrides the feature
Append -UseOriginalLocation - When `Install-ChocolateyPackage` is
internalized, append the `-UseOriginalLocation` parameter to the
function. Business editions only (licensed version 1.7.0+). Requires at
least Chocolatey v0.10.1 for `Install-ChocolateyPackage` to recognize
the switch appropriately. Overrides the feature
'internalizeAppendUseOriginalLocation' set to by default to 'False'.
~~~

[[Command Reference|CommandsReference]]


***NOTE:*** This documentation has been automatically generated from `choco download -h`.
***NOTE:*** This documentation has been automatically generated from `choco download -h`.

42 changes: 40 additions & 2 deletions CommandsFeature.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,13 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
Debug - Show debug messaging.
-v, --verbose
Verbose - Show verbose messaging.
Verbose - Show verbose messaging. Very verbose messaging, avoid using
under normal circumstances.
--trace
Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
except when needing super low-level .NET Framework debugging. Available
in 0.10.4+.
--acceptlicense, --accept-license
AcceptLicense - Accept license dialogs automatically. Reserved for
Expand All @@ -57,7 +63,7 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
--timeout, --execution-timeout=VALUE
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds.
configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-c, --cache, --cachelocation, --cache-location=VALUE
CacheLocation - Location for download cache, defaults to %TEMP% or value
Expand All @@ -77,6 +83,38 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
instead of the built-in PowerShell host. Should only be used when
internal host is failing. Available in 0.9.10+.
--no-progress
Do Not Show Progress - Do not show download progress percentages.
Available in 0.10.4+.
--proxy=VALUE
Proxy Location - Explicit proxy location. Overrides the default proxy
location of ''. Available for config settings in 0.9.9.9+, this CLI
option available in 0.10.4+.
--proxy-user=VALUE
Proxy User Name - Explicit proxy user (optional). Requires explicity
proxy (`--proxy` or config setting). Overrides the default proxy user of
'123'. Available for config settings in 0.9.9.9+, this CLI option
available in 0.10.4+.
--proxy-password=VALUE
Proxy Password - Explicit proxy password (optional) to be used with
username. Requires explicity proxy (`--proxy` or config setting) and
user name. Overrides the default proxy password (encrypted in settings
if set). Available for config settings in 0.9.9.9+, this CLI option
available in 0.10.4+.
--proxy-bypass-list=VALUE
ProxyBypassList - Comma separated list of regex locations to bypass on
proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
the default proxy bypass list of ''. Available in 0.10.4+.
--proxy-bypass-on-local
Proxy Bypass On Local - Bypass proxy for local connections. Requires
explicity proxy (`--proxy` or config setting). Overrides the default
proxy bypass on local setting of 'True'. Available in 0.10.4+.
-n, --name=VALUE
Name - the name of the source. Required with some actions. Defaults to
empty.
Expand Down
Loading

0 comments on commit 3064805

Please sign in to comment.