(chocolateyGH-697) Update Generated Documentation

Update the generated documentation with the result of GenerateDocs.ps1.
ferventcoder · Apr 28, 2016 · 4cd9cca · 4cd9cca
1 parent 8b19ec1
commit 4cd9cca
Show file tree

Hide file tree

Showing 34 changed files with 3,024 additions and 608 deletions.
diff --git a/docs/generated/CommandsApiKey.md b/docs/generated/CommandsApiKey.md
@@ -1,5 +1,6 @@
-# Chocolatey Upgrade (choco apikey)
-This lists api keys that are a set, or sets an api key, for a particular
+# ApiKey Command (choco apiKey)
+
+This lists api keys that are set or sets an api key for a particular   
  source so it doesn't need to be specified every time.
 
 Anything that doesn't contain source and key will list api keys.
@@ -18,21 +19,82 @@ Anything that doesn't contain source and key will list api keys.
 
 ## Connecting to Chocolatey.org
 
-In order to save your API key for https://chocolatey.org/,
+In order to save your API key for https://chocolatey.org/, 
  log in (or register, confirm and then log in) to
- https://chocolatey.org/, go to https://chocolatey.org/account,
+ https://chocolatey.org/, go to https://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/
 
+
 ## Options and Switches
 
-Includes [[default options/switches|CommandsReference#default-options-and-switches]]
+**NOTE:** Options and switches apply to all items passed, so if you are
+ running a command like install that allows installing multiple
+ packages, and you use `--version=1.0.0`, it is going to look for and
+ try to install version 1.0.0 of every package passed. So please split
+ out multiple package calls when wanting to pass specific options.
+
+Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
+
+~~~
+
+ -?, --help, -h
+     Prints out the help menu.
+
+ -d, --debug
+     Debug - Run in Debug Mode.
+
+ -v, --verbose
+     Verbose - See verbose messaging.
+
+     --acceptlicense, --accept-license
+     AcceptLicense - Accept license dialogs automatically.
+
+ -y, --yes, --confirm
+     Confirm all prompts - Chooses affirmative answer instead of prompting. 
+       Implies --accept-license
+
+ -f, --force
+     Force - force the behavior
+
+     --noop, --whatif, --what-if
+     NoOp - Don't actually do anything.
+
+ -r, --limitoutput, --limit-output
+     LimitOutput - Limit the output to essential information
+
+     --execution-timeout=VALUE
+     CommandExecutionTimeoutSeconds - Override the default execution timeout 
+       in the configuration of 2700 seconds.
+
+ -c, --cache, --cachelocation, --cache-location=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 
+       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 
+       overrides the feature failOnStandardError.
+
+     --use-system-powershell
+     UseSystemPowerShell - Execute PowerShell using an external process 
+       instead of the built-in PowerShell host. Available in 0.9.10+.
+
+ -s, --source=VALUE
+     Source [REQUIRED] - The source location for the key
+
+ -k, --key, --apikey, --api-key=VALUE
+     ApiKey - The api key for the source.
+
+~~~
+
+[[Command Reference|CommandsReference]]
+
 
-```
--s, --source=VALUE
-  Source [REQUIRED] - The source location for the key
+***NOTE:*** This documentation has been automatically generated from `choco apiKey -h`. 
 
--k, --key, --apikey, --api-key=VALUE
-  ApiKey - The api key for the source.
-```
diff --git a/docs/generated/CommandsConfig.md b/docs/generated/CommandsConfig.md
@@ -1,11 +1,14 @@
-# Chocolatey Config (choco config)
-***NOTE***: New in 0.9.9.9.
+# Config Command (choco config)
 
 Chocolatey will allow you to interact with the configuration file settings.
 
+**NOTE:** Available in 0.9.9.9+.
+
 ## Usage
 
-    choco config [list]|get|set [<options/switches>]
+    choco config [list]|get|set|unset [<options/switches>]
+
+**NOTE:** `Unset` subcommand available in 0.9.10+.
 
 ## Examples
 
@@ -15,24 +18,85 @@ Chocolatey will allow you to interact with the configuration file settings.
     choco config get --name cacheLocation
     choco config set cacheLocation c:\temp\choco
     choco config set --name cacheLocation --value c:\temp\choco
+    choco config unset proxy
+    choco config unset --name proxy
+
+
+## See It In Action
+
+![Config shown in action](https://raw.githubusercontent.com/wiki/chocolatey/choco/images/gifs/choco_config.gif)
+
 
 ## Options and Switches
 
-**NOTE**: Options and switches apply to all items passed, so if you are installing multiple packages, and you use `--version=1.0.0`, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.
+**NOTE:** Options and switches apply to all items passed, so if you are
+ running a command like install that allows installing multiple
+ packages, and you use `--version=1.0.0`, it is going to look for and
+ try to install version 1.0.0 of every package passed. So please split
+ out multiple package calls when wanting to pass specific options.
+
+Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
+
+~~~
+
+ -?, --help, -h
+     Prints out the help menu.
+
+ -d, --debug
+     Debug - Run in Debug Mode.
+
+ -v, --verbose
+     Verbose - See verbose messaging.
 
-Includes [[default options/switches|CommandsReference#default-options-and-switches]]
+     --acceptlicense, --accept-license
+     AcceptLicense - Accept license dialogs automatically.
+
+ -y, --yes, --confirm
+     Confirm all prompts - Chooses affirmative answer instead of prompting. 
+       Implies --accept-license
+
+ -f, --force
+     Force - force the behavior
+
+     --noop, --whatif, --what-if
+     NoOp - Don't actually do anything.
+
+ -r, --limitoutput, --limit-output
+     LimitOutput - Limit the output to essential information
+
+     --execution-timeout=VALUE
+     CommandExecutionTimeoutSeconds - Override the default execution timeout 
+       in the configuration of 2700 seconds.
+
+ -c, --cache, --cachelocation, --cache-location=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 
+       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 
+       overrides the feature failOnStandardError.
+
+     --use-system-powershell
+     UseSystemPowerShell - Execute PowerShell using an external process 
+       instead of the built-in PowerShell host. Available in 0.9.10+.
 
-```
      --name=VALUE
-     Name - the name of the config setting. Required with some actions.
+     Name - the name of the config setting. Required with some actions. 
        Defaults to empty.
 
      --value=VALUE
-     Value - the value of the config setting. Required with some actions.
+     Value - the value of the config setting. Required with some actions. 
        Defaults to empty.
 
-```
+~~~
 
-## See It In Action
+[[Command Reference|CommandsReference]]
+
+
+***NOTE:*** This documentation has been automatically generated from `choco config -h`. 
 
-![Config shown in action](https://raw.githubusercontent.com/wiki/chocolatey/choco/images/gifs/choco_config.gif)
diff --git a/docs/generated/CommandsFeature.md b/docs/generated/CommandsFeature.md
@@ -1,4 +1,4 @@
-# Chocolatey Feature (choco feature)
+# Feature Command (choco feature)
 
 Chocolatey will allow you to interact with features.
 
@@ -8,17 +8,77 @@ Chocolatey will allow you to interact with features.
 
 ## Examples
 
+    choco feature
     choco feature list
     choco feature disable -n=bob
     choco feature enable -n=bob
 
 ## Options and Switches
 
-Includes [[default options/switches|CommandsReference#default-options-and-switches]]
+**NOTE:** Options and switches apply to all items passed, so if you are
+ running a command like install that allows installing multiple
+ packages, and you use `--version=1.0.0`, it is going to look for and
+ try to install version 1.0.0 of every package passed. So please split
+ out multiple package calls when wanting to pass specific options.
 
-```
+Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
+
+~~~
+
+ -?, --help, -h
+     Prints out the help menu.
+
+ -d, --debug
+     Debug - Run in Debug Mode.
+
+ -v, --verbose
+     Verbose - See verbose messaging.
+
+     --acceptlicense, --accept-license
+     AcceptLicense - Accept license dialogs automatically.
+
+ -y, --yes, --confirm
+     Confirm all prompts - Chooses affirmative answer instead of prompting. 
+       Implies --accept-license
+
+ -f, --force
+     Force - force the behavior
+
+     --noop, --whatif, --what-if
+     NoOp - Don't actually do anything.
+
+ -r, --limitoutput, --limit-output
+     LimitOutput - Limit the output to essential information
+
+     --execution-timeout=VALUE
+     CommandExecutionTimeoutSeconds - Override the default execution timeout 
+       in the configuration of 2700 seconds.
+
+ -c, --cache, --cachelocation, --cache-location=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 
+       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 
+       overrides the feature failOnStandardError.
+
+     --use-system-powershell
+     UseSystemPowerShell - Execute PowerShell using an external process 
+       instead of the built-in PowerShell host. Available in 0.9.10+.
+
+ -n, --name=VALUE
+     Name - the name of the source. Required with some actions. Defaults to 
+       empty.
+
+~~~
+
+[[Command Reference|CommandsReference]]
+
+
+***NOTE:*** This documentation has been automatically generated from `choco feature -h`. 
 
--n, --name=VALUE
-    Name - the name of the source. Required with some actions. Defaults to
-    empty.
-```
diff --git a/docs/generated/CommandsFeatures.md b/docs/generated/CommandsFeatures.md
@@ -0,0 +1,84 @@
+# Feature Command (choco features)
+
+Chocolatey will allow you to interact with features.
+
+## Usage
+
+    choco feature [list]|disable|enable [<options/switches>]
+
+## Examples
+
+    choco feature
+    choco feature list
+    choco feature disable -n=bob
+    choco feature enable -n=bob
+
+## Options and Switches
+
+**NOTE:** Options and switches apply to all items passed, so if you are
+ running a command like install that allows installing multiple
+ packages, and you use `--version=1.0.0`, it is going to look for and
+ try to install version 1.0.0 of every package passed. So please split
+ out multiple package calls when wanting to pass specific options.
+
+Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
+
+~~~
+
+ -?, --help, -h
+     Prints out the help menu.
+
+ -d, --debug
+     Debug - Run in Debug Mode.
+
+ -v, --verbose
+     Verbose - See verbose messaging.
+
+     --acceptlicense, --accept-license
+     AcceptLicense - Accept license dialogs automatically.
+
+ -y, --yes, --confirm
+     Confirm all prompts - Chooses affirmative answer instead of prompting. 
+       Implies --accept-license
+
+ -f, --force
+     Force - force the behavior
+
+     --noop, --whatif, --what-if
+     NoOp - Don't actually do anything.
+
+ -r, --limitoutput, --limit-output
+     LimitOutput - Limit the output to essential information
+
+     --execution-timeout=VALUE
+     CommandExecutionTimeoutSeconds - Override the default execution timeout 
+       in the configuration of 2700 seconds.
+
+ -c, --cache, --cachelocation, --cache-location=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 
+       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 
+       overrides the feature failOnStandardError.
+
+     --use-system-powershell
+     UseSystemPowerShell - Execute PowerShell using an external process 
+       instead of the built-in PowerShell host. Available in 0.9.10+.
+
+ -n, --name=VALUE
+     Name - the name of the source. Required with some actions. Defaults to 
+       empty.
+
+~~~
+
+[[Command Reference|CommandsReference]]
+
+
+***NOTE:*** This documentation has been automatically generated from `choco features -h`. 
+