From eee68710ee83d2c0f95e62788c48de02c437d1d1 Mon Sep 17 00:00:00 2001 From: Rob Reynolds Date: Fri, 3 Jun 2016 10:02:00 -0500 Subject: [PATCH] fixup generated docs --- docs/generated/HelpersFormatFileSize.md | 3 +- docs/generated/HelpersGetFtpFile.md | 2 +- docs/generated/HelpersGetWebFile.md | 16 +-- docs/generated/HelpersGetWebFileName.md | 4 +- docs/generated/HelpersGetWebHeaders.md | 10 +- .../HelpersInstallChocolateyDesktopLink.md | 2 + ...ersInstallChocolateyEnvironmentVariable.md | 23 +++- ...elpersInstallChocolateyExplorerMenuItem.md | 10 +- ...HelpersInstallChocolateyFileAssociation.md | 16 +-- .../HelpersInstallChocolateyInstallPackage.md | 4 + .../HelpersInstallChocolateyPackage.md | 2 + .../generated/HelpersInstallChocolateyPath.md | 8 +- ...lpersInstallChocolateyPinnedTaskBarItem.md | 4 + ...lpersInstallChocolateyPowershellCommand.md | 18 +-- .../HelpersInstallChocolateyShortcut.md | 19 +-- .../HelpersInstallChocolateyVsixPackage.md | 14 +-- docs/generated/HelpersInstallVsix.md | 14 +-- docs/generated/HelpersReference.md | 1 + .../HelpersSetEnvironmentVariable.md | 98 +++++++++++++++ ...sUninstallChocolateyEnvironmentVariable.md | 116 ++++++++++++++++++ 20 files changed, 319 insertions(+), 65 deletions(-) create mode 100644 docs/generated/HelpersSetEnvironmentVariable.md create mode 100644 docs/generated/HelpersUninstallChocolateyEnvironmentVariable.md diff --git a/docs/generated/HelpersFormatFileSize.md b/docs/generated/HelpersFormatFileSize.md index 85e2982420..46dbd59a8a 100644 --- a/docs/generated/HelpersFormatFileSize.md +++ b/docs/generated/HelpersFormatFileSize.md @@ -17,6 +17,7 @@ Formats file size into a human readable format. ## Notes Available in 0.9.10+. + This function is not part of the API. ## Aliases @@ -51,7 +52,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 2 +Position? | named Default Value | Accept Pipeline Input? | false diff --git a/docs/generated/HelpersGetFtpFile.md b/docs/generated/HelpersGetFtpFile.md index 3678c91b90..9f533cf53a 100644 --- a/docs/generated/HelpersGetFtpFile.md +++ b/docs/generated/HelpersGetFtpFile.md @@ -80,7 +80,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 3 +Position? | 4 Default Value | Accept Pipeline Input? | false diff --git a/docs/generated/HelpersGetWebFile.md b/docs/generated/HelpersGetWebFile.md index baa45a075d..67b3a2e3a9 100644 --- a/docs/generated/HelpersGetWebFile.md +++ b/docs/generated/HelpersGetWebFile.md @@ -7,9 +7,9 @@ available. ~~~powershell Get-WebFile ` - [-Url ] ` - [-FileName ] ` - [-UserAgent ] ` + [-Url ] ` + [-FileName ] ` + [-UserAgent ] ` [-Passthru] ` [-Quiet] ` [-Options ] ` @@ -40,7 +40,7 @@ None ## Parameters -### -Url [<Object>] +### -Url [<String>] This is the url to download the file from. Prefer HTTPS when available. Property | Value @@ -51,7 +51,7 @@ Position? | 1 Default Value | Accept Pipeline Input? | false -### -FileName [<Object>] +### -FileName [<String>] This is the full path to the file to create. If downloading to the package folder next to the install script, the path will be like `"$(Split-Path -Parent $MyInvocation.MyCommand.Definition)\\file.exe"` @@ -64,7 +64,7 @@ Position? | 2 Default Value | Accept Pipeline Input? | false -### -UserAgent [<Object>] +### -UserAgent [<String>] The user agent to use as part of the request. Defaults to 'chocolatey command line'. @@ -105,7 +105,7 @@ Property | Value ---------------------- | -------------- Aliases | Required? | false -Position? | 4 +Position? | named Default Value | @{Headers=@{}} Accept Pipeline Input? | false @@ -116,7 +116,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 5 +Position? | named Default Value | Accept Pipeline Input? | false diff --git a/docs/generated/HelpersGetWebFileName.md b/docs/generated/HelpersGetWebFileName.md index 8f34ff6132..5a8d5b002f 100644 --- a/docs/generated/HelpersGetWebFileName.md +++ b/docs/generated/HelpersGetWebFileName.md @@ -9,7 +9,7 @@ the original file name for a file. Get-WebFileName ` [-Url ] ` -DefaultName ` - [-UserAgent ] ` + [-UserAgent ] ` [-IgnoredArguments ] [] ~~~ @@ -68,7 +68,7 @@ Position? | 2 Default Value | Accept Pipeline Input? | false -### -UserAgent [<Object>] +### -UserAgent [<String>] The user agent to use as part of the request. Defaults to 'chocolatey command line'. diff --git a/docs/generated/HelpersGetWebHeaders.md b/docs/generated/HelpersGetWebHeaders.md index 4ffd8d2e8b..e591c99563 100644 --- a/docs/generated/HelpersGetWebHeaders.md +++ b/docs/generated/HelpersGetWebHeaders.md @@ -6,8 +6,8 @@ Gets the request/response headers for a url. ~~~powershell Get-WebHeaders ` - [-Url ] ` - [-UserAgent ] ` + [-Url ] ` + [-UserAgent ] ` [-IgnoredArguments ] [] ~~~ @@ -35,7 +35,7 @@ None ## Parameters -### -Url [<Object>] +### -Url [<String>] This is the url to get a request/response from. Property | Value @@ -46,7 +46,7 @@ Position? | 1 Default Value | Accept Pipeline Input? | false -### -UserAgent [<Object>] +### -UserAgent [<String>] The user agent to use as part of the request. Defaults to 'chocolatey command line'. @@ -65,7 +65,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 3 +Position? | named Default Value | Accept Pipeline Input? | false diff --git a/docs/generated/HelpersInstallChocolateyDesktopLink.md b/docs/generated/HelpersInstallChocolateyDesktopLink.md index bf3b7214eb..fa6e903307 100644 --- a/docs/generated/HelpersInstallChocolateyDesktopLink.md +++ b/docs/generated/HelpersInstallChocolateyDesktopLink.md @@ -25,6 +25,8 @@ If this errors, such as it will if being installed under the local SYSTEM account, it will display a warning instead of failing a package installation. +Will not throw an error if it fails. + ## Aliases None diff --git a/docs/generated/HelpersInstallChocolateyEnvironmentVariable.md b/docs/generated/HelpersInstallChocolateyEnvironmentVariable.md index 66ca2cd563..0a66a2ab04 100644 --- a/docs/generated/HelpersInstallChocolateyEnvironmentVariable.md +++ b/docs/generated/HelpersInstallChocolateyEnvironmentVariable.md @@ -1,6 +1,8 @@ # Install-ChocolateyEnvironmentVariable -Creates a persistent environment variable +**NOTE:** Administrative Access Required when `-VariableType 'Machine'.` + +Creates a persistent environment variable. ## Syntax @@ -17,8 +19,8 @@ Install-ChocolateyEnvironmentVariable ` Install-ChocolateyEnvironmentVariable creates an environment variable with the specified name and value. The variable is persistent and will remain after reboots and across multiple PowerShell and command -line sessions. The variable can be scoped either to the user or to -the machine. If machine level scoping is specified, the command is +line sessions. The variable can be scoped either to the User or to +the Machine. If Machine level scoping is specified, the command is elevated to an administrative session. ## Notes @@ -26,6 +28,8 @@ elevated to an administrative session. This command will assert UAC/Admin privileges on the machine when `-VariableType Machine`. +This will add the environment variable to the current session. + ## Aliases None @@ -99,7 +103,7 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err ~~~powershell -# Creates a User environmet variable "JAVA_HOME" pointing to +# Creates a User environment variable "JAVA_HOME" pointing to # "d:\oracle\jdk\bin". Install-ChocolateyEnvironmentVariable "JAVA_HOME" "d:\oracle\jdk\bin" ~~~ @@ -108,7 +112,7 @@ Install-ChocolateyEnvironmentVariable "JAVA_HOME" "d:\oracle\jdk\bin" ~~~powershell -# Creates a User environmet variable "_NT_SYMBOL_PATH" pointing to +# Creates a User environment variable "_NT_SYMBOL_PATH" pointing to # "symsrv*symsrv.dll*f:\localsymbols*http://msdl.microsoft.com/download/symbols". # The command will be elevated to admin priviledges. Install-ChocolateyEnvironmentVariable ` @@ -117,8 +121,17 @@ Install-ChocolateyEnvironmentVariable ` -VariableType Machine ~~~ +**EXAMPLE 3** + +~~~powershell + +# Remove an environment variable +Install-ChocolateyEnvironmentVariable -VariableName 'bob' -VariableValue $null +~~~ + ## Links + * [[Uninstall-ChocolateyEnvironmentVariable|HelpersUninstallChocolateyEnvironmentVariable]] * [[Get-EnvironmentVariable|HelpersGetEnvironmentVariable]] * [[Set-EnvironmentVariable|HelpersSetEnvironmentVariable]] * [[Install-ChocolateyPath|HelpersInstallChocolateyPath]] diff --git a/docs/generated/HelpersInstallChocolateyExplorerMenuItem.md b/docs/generated/HelpersInstallChocolateyExplorerMenuItem.md index 24eed75e66..08b66341f1 100644 --- a/docs/generated/HelpersInstallChocolateyExplorerMenuItem.md +++ b/docs/generated/HelpersInstallChocolateyExplorerMenuItem.md @@ -1,5 +1,7 @@ # Install-ChocolateyExplorerMenuItem +**NOTE:** Administrative Access Required. + Creates a windows explorer context menu item that can be associated with a command @@ -7,7 +9,7 @@ a command ~~~powershell Install-ChocolateyExplorerMenuItem ` - [-MenuKey ] ` + -MenuKey ` [-MenuLabel ] ` [-Command ] ` [-Type ] ` @@ -46,13 +48,13 @@ None ## Parameters -### -MenuKey [<String>] +### -MenuKey <String> A unique string to identify this menu item in the registry Property | Value ---------------------- | ----- Aliases | -Required? | false +Required? | true Position? | 1 Default Value | Accept Pipeline Input? | false @@ -98,7 +100,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 5 +Position? | named Default Value | Accept Pipeline Input? | false diff --git a/docs/generated/HelpersInstallChocolateyFileAssociation.md b/docs/generated/HelpersInstallChocolateyFileAssociation.md index 31cae3b357..49f4e6da75 100644 --- a/docs/generated/HelpersInstallChocolateyFileAssociation.md +++ b/docs/generated/HelpersInstallChocolateyFileAssociation.md @@ -1,13 +1,15 @@ # Install-ChocolateyFileAssociation +**NOTE:** Administrative Access Required. + Creates an association between a file extension and a executable. ## Syntax ~~~powershell Install-ChocolateyFileAssociation ` - [-Extension ] ` - [-Executable ] ` + -Extension ` + -Executable ` [-IgnoredArguments ] [] ~~~ @@ -36,24 +38,24 @@ None ## Parameters -### -Extension [<String>] +### -Extension <String> The file extension to be associated. Property | Value ---------------------- | ----- Aliases | -Required? | false +Required? | true Position? | 1 Default Value | Accept Pipeline Input? | false -### -Executable [<String>] +### -Executable <String> The path to the application's executable to be associated. Property | Value ---------------------- | ----- Aliases | -Required? | false +Required? | true Position? | 2 Default Value | Accept Pipeline Input? | false @@ -65,7 +67,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 3 +Position? | named Default Value | Accept Pipeline Input? | false diff --git a/docs/generated/HelpersInstallChocolateyInstallPackage.md b/docs/generated/HelpersInstallChocolateyInstallPackage.md index 391334192c..e607cd4182 100644 --- a/docs/generated/HelpersInstallChocolateyInstallPackage.md +++ b/docs/generated/HelpersInstallChocolateyInstallPackage.md @@ -1,5 +1,7 @@ # Install-ChocolateyInstallPackage +**NOTE:** Administrative Access Required. + Installs software into "Programs and Features". Use Install-ChocolateyPackage when software must be downloaded first. @@ -22,6 +24,8 @@ This will run an installer (local file) on your machine. ## Notes +This command will assert UAC/Admin privileges on the machine. + If you are embedding files into a package, ensure that you have the rights to redistribute those files if you are sharing this package publicly (like on the [community feed](https://chocolatey.org/packages)). Otherwise, please use diff --git a/docs/generated/HelpersInstallChocolateyPackage.md b/docs/generated/HelpersInstallChocolateyPackage.md index b90e29c3bb..11b8df799b 100644 --- a/docs/generated/HelpersInstallChocolateyPackage.md +++ b/docs/generated/HelpersInstallChocolateyPackage.md @@ -1,5 +1,7 @@ # Install-ChocolateyPackage +**NOTE:** Administrative Access Required. + Installs software into "Programs and Features" based on a remote file download. Use Install-ChocolateyInstallPackage when local or embedded file. diff --git a/docs/generated/HelpersInstallChocolateyPath.md b/docs/generated/HelpersInstallChocolateyPath.md index 4177d1e943..99302978e7 100644 --- a/docs/generated/HelpersInstallChocolateyPath.md +++ b/docs/generated/HelpersInstallChocolateyPath.md @@ -1,5 +1,7 @@ # Install-ChocolateyPath +**NOTE:** Administrative Access Required when `-PathType 'Machine'.` + This puts a directory to the PATH environment variable. ## Syntax @@ -18,7 +20,9 @@ correctly shows up on the right PATH. ## Notes -Requires admin privileges if `PathType = 'Machine'`. +This command will assert UAC/Admin privileges on the machine if +`-PathType 'Machine'`. + This is used when the application/tool is not being linked by Chocolatey (not in the lib folder). @@ -83,7 +87,7 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err **EXAMPLE 1** ~~~powershell -Install-ChocolateyPath "$($env:SystemDrive)\tools\gittfs" +Install-ChocolateyPath -PathToInstall "$($env:SystemDrive)\tools\gittfs" ~~~ diff --git a/docs/generated/HelpersInstallChocolateyPinnedTaskBarItem.md b/docs/generated/HelpersInstallChocolateyPinnedTaskBarItem.md index 5ef271e440..e33ae773e4 100644 --- a/docs/generated/HelpersInstallChocolateyPinnedTaskBarItem.md +++ b/docs/generated/HelpersInstallChocolateyPinnedTaskBarItem.md @@ -11,6 +11,10 @@ Install-ChocolateyPinnedTaskBarItem ` ~~~ +## Notes + +Does not work with SYSTEM, but does not error. It warns with the error +message. ## Aliases diff --git a/docs/generated/HelpersInstallChocolateyPowershellCommand.md b/docs/generated/HelpersInstallChocolateyPowershellCommand.md index 0d6233690f..a7136bb38b 100644 --- a/docs/generated/HelpersInstallChocolateyPowershellCommand.md +++ b/docs/generated/HelpersInstallChocolateyPowershellCommand.md @@ -7,7 +7,7 @@ Installs a PowerShell Script as a command ~~~powershell Install-ChocolateyPowershellCommand ` [-PackageName ] ` - [-PsFileFullPath ] ` + -PsFileFullPath ` [-Url ] ` [-Url64bit ] ` [-Checksum ] ` @@ -61,7 +61,7 @@ Position? | 1 Default Value | Accept Pipeline Input? | false -### -PsFileFullPath [<String>] +### -PsFileFullPath <String> 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"` @@ -69,7 +69,7 @@ it in the package next to the install script, the path will be like Property | Value ---------------------- | ----- Aliases | -Required? | false +Required? | true Position? | 2 Default Value | Accept Pipeline Input? | false @@ -120,7 +120,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 5 +Position? | named Default Value | Accept Pipeline Input? | false @@ -136,7 +136,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 6 +Position? | named Default Value | Accept Pipeline Input? | false @@ -149,7 +149,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 7 +Position? | named Default Value | Accept Pipeline Input? | false @@ -166,7 +166,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 8 +Position? | named Default Value | Accept Pipeline Input? | false @@ -177,7 +177,7 @@ Property | Value ---------------------- | -------------- Aliases | Required? | false -Position? | 9 +Position? | named Default Value | @{Headers=@{}} Accept Pipeline Input? | false @@ -188,7 +188,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 10 +Position? | named Default Value | Accept Pipeline Input? | false diff --git a/docs/generated/HelpersInstallChocolateyShortcut.md b/docs/generated/HelpersInstallChocolateyShortcut.md index 5c98193cd5..97641a6650 100644 --- a/docs/generated/HelpersInstallChocolateyShortcut.md +++ b/docs/generated/HelpersInstallChocolateyShortcut.md @@ -6,8 +6,8 @@ Creates a shortcut ~~~powershell Install-ChocolateyShortcut ` - [-ShortcutFilePath ] ` - [-TargetPath ] ` + -ShortcutFilePath ` + -TargetPath ` [-WorkingDirectory ] ` [-Arguments ] ` [-IconLocation ] ` @@ -21,6 +21,11 @@ This adds a shortcut, at the specified location, with the option to specify a number of additional properties for the shortcut, such as Working Directory, Arguments, Icon Location, and Description. +## Notes + +If this errors, as it may if being run under the local SYSTEM account with +particular folder that SYSTEM doesn't have, it will display a warning instead +of failing a package installation. ## Aliases @@ -36,24 +41,24 @@ None ## Parameters -### -ShortcutFilePath [<String>] +### -ShortcutFilePath <String> The full absolute path to where the shortcut should be created. This is mandatory. Property | Value ---------------------- | ----- Aliases | -Required? | false +Required? | true Position? | 1 Default Value | Accept Pipeline Input? | false -### -TargetPath [<String>] +### -TargetPath <String> The full absolute path to the target for new shortcut. This is mandatory. Property | Value ---------------------- | ----- Aliases | -Required? | false +Required? | true Position? | 2 Default Value | Accept Pipeline Input? | false @@ -112,7 +117,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 7 +Position? | named Default Value | Accept Pipeline Input? | false diff --git a/docs/generated/HelpersInstallChocolateyVsixPackage.md b/docs/generated/HelpersInstallChocolateyVsixPackage.md index f1ac09c202..09f665b10c 100644 --- a/docs/generated/HelpersInstallChocolateyVsixPackage.md +++ b/docs/generated/HelpersInstallChocolateyVsixPackage.md @@ -6,7 +6,7 @@ Downloads and installs a VSIX package for Visual Studio ~~~powershell Install-ChocolateyVsixPackage ` - [-PackageName ] ` + -PackageName ` [-VsixUrl ] ` [-VsVersion ] ` [-Checksum ] ` @@ -47,14 +47,14 @@ None ## Parameters -### -PackageName [<String>] +### -PackageName <String> The name of the package - while this is an arbitrary value, it's recommended that it matches the package id. Property | Value ---------------------- | ----- Aliases | -Required? | false +Required? | true Position? | 1 Default Value | Accept Pipeline Input? | false @@ -95,7 +95,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 4 +Position? | named Default Value | Accept Pipeline Input? | false @@ -111,7 +111,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 5 +Position? | named Default Value | Accept Pipeline Input? | false @@ -122,7 +122,7 @@ Property | Value ---------------------- | -------------- Aliases | Required? | false -Position? | 6 +Position? | named Default Value | @{Headers=@{}} Accept Pipeline Input? | false @@ -133,7 +133,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 7 +Position? | named Default Value | Accept Pipeline Input? | false diff --git a/docs/generated/HelpersInstallVsix.md b/docs/generated/HelpersInstallVsix.md index 895bd8dfa8..a63d9e6665 100644 --- a/docs/generated/HelpersInstallVsix.md +++ b/docs/generated/HelpersInstallVsix.md @@ -6,8 +6,8 @@ DO NOT USE. Not part of the public API. ~~~powershell Install-Vsix ` - [-Installer ] ` - [-InstallFile ] ` + -Installer ` + -InstallFile ` [-IgnoredArguments ] [] ~~~ @@ -34,24 +34,24 @@ None ## Parameters -### -Installer [<String>] +### -Installer <String> The path to the VSIX installer Property | Value ---------------------- | ----- Aliases | -Required? | false +Required? | true Position? | 1 Default Value | Accept Pipeline Input? | false -### -InstallFile [<String>] +### -InstallFile <String> The VSIX file that is being installed. Property | Value ---------------------- | ----- Aliases | -Required? | false +Required? | true Position? | 2 Default Value | Accept Pipeline Input? | false @@ -63,7 +63,7 @@ Property | Value ---------------------- | ----- Aliases | Required? | false -Position? | 3 +Position? | named Default Value | Accept Pipeline Input? | false diff --git a/docs/generated/HelpersReference.md b/docs/generated/HelpersReference.md index dd88cb62c5..bc6c9e63ca 100644 --- a/docs/generated/HelpersReference.md +++ b/docs/generated/HelpersReference.md @@ -87,6 +87,7 @@ These are the functions from above as one list. * [[Start-ChocolateyProcessAsAdmin|HelpersStartChocolateyProcessAsAdmin]] * [[Test-ProcessAdminRights|HelpersTestProcessAdminRights]] * [[Uninstall-BinFile|HelpersUninstallBinFile]] + * [[Uninstall-ChocolateyEnvironmentVariable|HelpersUninstallChocolateyEnvironmentVariable]] * [[Uninstall-ChocolateyPackage|HelpersUninstallChocolateyPackage]] * [[Uninstall-ChocolateyZipPackage|HelpersUninstallChocolateyZipPackage]] * [[Update-SessionEnvironment|HelpersUpdateSessionEnvironment]] diff --git a/docs/generated/HelpersSetEnvironmentVariable.md b/docs/generated/HelpersSetEnvironmentVariable.md new file mode 100644 index 0000000000..980c9871a0 --- /dev/null +++ b/docs/generated/HelpersSetEnvironmentVariable.md @@ -0,0 +1,98 @@ +# Set-EnvironmentVariable + +**NOTE:** Administrative Access Required when `-Scope 'Machine'.` + +DO NOT USE. Not part of the public API. Use +`Install-ChocolateyEnvironmentVariable` instead. + +## Syntax + +~~~powershell +Set-EnvironmentVariable ` + -Name ` + [-Value ] ` + [-Scope {Process | User | Machine}] ` + [-IgnoredArguments ] [] +~~~ + +## Description + +Saves an environment variable. + +## Notes + +This command will assert UAC/Admin privileges on the machine if +`-Scope 'Machine'`. + +## Aliases + +None + +## Inputs + +None + +## Outputs + +None + +## Parameters + +### -Name <String> +Property | Value +---------------------- | ----- +Aliases | +Required? | true +Position? | 1 +Default Value | +Accept Pipeline Input? | false + +### -Value [<String>] +Property | Value +---------------------- | ----- +Aliases | +Required? | false +Position? | 2 +Default Value | +Accept Pipeline Input? | false + +### -Scope + +Valid options: Process, User, Machine + +Property | Value +---------------------- | ----- +Aliases | +Required? | false +Position? | 3 +Default Value | +Accept Pipeline Input? | false + +### -IgnoredArguments [<Object[]>] +Allows splatting with arguments that do not apply. Do not use directly. + +Property | Value +---------------------- | ----- +Aliases | +Required? | false +Position? | named +Default Value | +Accept Pipeline Input? | false + +### <CommonParameters> + +This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see `about_CommonParameters` http://go.microsoft.com/fwlink/p/?LinkID=113216 . + + + +## Links + + * [[Install-ChocolateyEnvironmentVariable|HelpersInstallChocolateyEnvironmentVariable]] + * [[Uninstall-ChocolateyEnvironmentVariable|HelpersUninstallChocolateyEnvironmentVariable]] + * [[Install-ChocolateyPath|HelpersInstallChocolateyPath]] + * [[Get-EnvironmentVariable|HelpersGetEnvironmentVariable]] + + +[[Function Reference|HelpersReference]] + +***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Set-EnvironmentVariable -Full`. diff --git a/docs/generated/HelpersUninstallChocolateyEnvironmentVariable.md b/docs/generated/HelpersUninstallChocolateyEnvironmentVariable.md new file mode 100644 index 0000000000..961e9c031d --- /dev/null +++ b/docs/generated/HelpersUninstallChocolateyEnvironmentVariable.md @@ -0,0 +1,116 @@ +# Uninstall-ChocolateyEnvironmentVariable + +**NOTE:** Administrative Access Required when `-VariableType 'Machine'.` + +Removes a persistent environment variable. + +## Syntax + +~~~powershell +Uninstall-ChocolateyEnvironmentVariable ` + -VariableName ` + [-VariableType {Process | User | Machine}] ` + [-IgnoredArguments ] [] +~~~ + +## Description + +Uninstall-ChocolateyEnvironmentVariable removes an environment variable +with the specified name and value. The variable can be scoped either to +the User or to the Machine. If Machine level scoping is specified, the +command is elevated to an administrative session. + +## Notes + +Available in 0.9.10+. If you need compatibility with older versions, +use Install-ChocolateyEnvironmentVariable and set `-VariableValue $null` + +This command will assert UAC/Admin privileges on the machine when +`-VariableType Machine`. + +This will remove the environment variable from the current session. + +## Aliases + +None + +## Inputs + +None + +## Outputs + +None + +## Parameters + +### -VariableName <String> +The name or key of the environment variable to remove. + +Property | Value +---------------------- | ----- +Aliases | +Required? | true +Position? | 1 +Default Value | +Accept Pipeline Input? | false + +### -VariableType +Specifies whether this variable is at either the individual User level +or at the Machine level. + + +Valid options: Process, User, Machine + +Property | Value +---------------------- | ----- +Aliases | +Required? | false +Position? | 2 +Default Value | User +Accept Pipeline Input? | false + +### -IgnoredArguments [<Object[]>] +Allows splatting with arguments that do not apply. Do not use directly. + +Property | Value +---------------------- | ----- +Aliases | +Required? | false +Position? | named +Default Value | +Accept Pipeline Input? | false + +### <CommonParameters> + +This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see `about_CommonParameters` http://go.microsoft.com/fwlink/p/?LinkID=113216 . + + +## Examples + + **EXAMPLE 1** + +~~~powershell + +# Remove an environment variable +Uninstall-ChocolateyEnvironmentVariable -VariableName 'bob' +~~~ + +**EXAMPLE 2** + +~~~powershell + +# Remove an environment variable from Machine +Uninstall-ChocolateyEnvironmentVariable -VariableName 'bob' -VariableType 'Machine' +~~~ + +## Links + + * [[Install-ChocolateyEnvironmentVariable|HelpersInstallChocolateyEnvironmentVariable]] + * [[Set-EnvironmentVariable|HelpersSetEnvironmentVariable]] + * [[Install-ChocolateyPath|HelpersInstallChocolateyPath]] + + +[[Function Reference|HelpersReference]] + +***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Uninstall-ChocolateyEnvironmentVariable -Full`.