From d71c1bc906ef9f439ecf8196291fb2dfe8ba9aa1 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 5 Sep 2023 08:40:10 -0500 Subject: [PATCH 1/3] Update install docs and support policy (#10384) --- .openpublishing.redirection.json | 5 + .../install/Installing-PowerShell-on-Linux.md | 47 ++++---- .../install/PowerShell-Support-Lifecycle.md | 16 +-- .../install/community-support.md | 73 +++++++++++- .../install/install-raspbian.md | 109 ------------------ 5 files changed, 101 insertions(+), 149 deletions(-) delete mode 100644 reference/docs-conceptual/install/install-raspbian.md diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 9633da63c46e..b06620c47ee2 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -30,6 +30,11 @@ "redirect_url": "/powershell/utility-modules/platyps/create-help-using-platyps", "source_path": "reference/docs-conceptual/dev-cross-plat/create-help-using-platyps.md" }, + { + "redirect_document_id": true, + "redirect_url": "/powershell/scripting/install/community-support", + "source_path": "reference/docs-conceptual/install/install-raspbian.md" + }, { "redirect_document_id": true, "redirect_url": "/powershell/scripting/install/installing-powershell-on-linux", diff --git a/reference/docs-conceptual/install/Installing-PowerShell-on-Linux.md b/reference/docs-conceptual/install/Installing-PowerShell-on-Linux.md index c2337c8894d6..68f006d2308c 100644 --- a/reference/docs-conceptual/install/Installing-PowerShell-on-Linux.md +++ b/reference/docs-conceptual/install/Installing-PowerShell-on-Linux.md @@ -1,17 +1,21 @@ --- -description: Learn about the Linux distributions supported by PowerShell. +description: This article lists the Linux distributions and package managers that are supported for installing PowerShell. ms.date: 01/09/2023 title: Install PowerShell on Linux --- # Install PowerShell on Linux -PowerShell can be installed on different Linux distributions. Most Linux platforms and distributions -have a major release each year, and provide a package manager that's used to install PowerShell. -This article lists the currently supported Linux distributions and package managers. +PowerShell can be installed on several different Linux distributions. Most Linux platforms and +distributions have a major release each year, and provide a package manager that's used to install +PowerShell. PowerShell can be installed on some distributions of Linux that aren't supported by +Microsoft. In those cases, you may find support from the community for PowerShell on those +platforms. -The rest of this article is a breakdown of each Linux distribution that PowerShell supports. All -PowerShell releases remain supported until either the version of -[PowerShell reaches end-of-support][05] or the Linux distribution reaches end-of-life. +For more information, see the [PowerShell Support Lifecycle][05] documentation. + +This article lists the supported Linux distributions and package managers. All PowerShell releases +remain supported until either the version of PowerShell or the version of the Linux distribution +reaches end-of-support. For the best compatibility, choose a long-term release (LTS) version. @@ -45,39 +49,32 @@ Ubuntu uses APT (Advanced Package Tool) as a package manager. For more information, see [Install PowerShell on Ubuntu][18]. -## Raspberry Pi OS - -[Raspberry Pi OS][12] (formerly Raspbian) is a free operating system based on Debian. - -> [!IMPORTANT] -> .NET isn't supported on ARMv6 architecture devices, including Raspberry Pi Zero and Raspberry Pi -> devices prior to Raspberry Pi 2. +## Community supported distributions -For more information, see [Install PowerShell on Raspberry Pi OS][16]. +PowerShell can be installed on many distributions of Linux that aren't supported by Microsoft. In +those cases, you may find support from the community for PowerShell on those platforms -## Community supported distributions +To be supported by Microsoft, the Linux distribution must meet the following criteria: -There are many distributions of Linux that aren't officially supported by Microsoft. In some cases, -PowerShell may be supported by the community for these releases. For more information, see -[Community support for PowerShell on Linux][06]. +- The version and architecture of the distribution is supported by .NET Core. +- The version of the distribution is supported for at least one year. +- The version of the distribution isn't an interim release or equivalent. +- The PowerShell team has tested the version of the distribution. -CentOS and Fedora distributions are no longer supported. The versions of these operating systems -that were supported have reached their end-of-life dates. We aren't supporting any newer versions. +For more information, see [Community support for PowerShell on Linux][06]. ## Alternate installation methods There are three other ways to install PowerShell on Linux, including Linux distributions that aren't officially supported. You can try to install PowerShell using the PowerShell Snap Package. You can -also try deploying PowerShell binaries directly using the Linux `tar.gz`. For more information, see -[Alternate ways to install PowerShell on Linux][15]. +also try deploying PowerShell binaries directly using the Linux `tar.gz` package. For more +information, see [Alternate ways to install PowerShell on Linux][15]. [05]: ../PowerShell-Support-Lifecycle.md [06]: community-support.md -[12]: https://www.raspberrypi.org/documentation/installation/installing-images/README.md [13]: install-alpine.md [14]: install-debian.md [15]: install-other-linux.md -[16]: install-raspbian.md [17]: install-rhel.md [18]: install-ubuntu.md diff --git a/reference/docs-conceptual/install/PowerShell-Support-Lifecycle.md b/reference/docs-conceptual/install/PowerShell-Support-Lifecycle.md index b3ba791cd10e..4a718579d676 100644 --- a/reference/docs-conceptual/install/PowerShell-Support-Lifecycle.md +++ b/reference/docs-conceptual/install/PowerShell-Support-Lifecycle.md @@ -1,6 +1,6 @@ --- description: Details the policies governing support for PowerShell -ms.date: 06/22/2023 +ms.date: 09/02/2023 title: PowerShell Support Lifecycle --- # PowerShell Support Lifecycle @@ -66,14 +66,6 @@ needing access but formal support and updates of any kind are no longer be provi [!INCLUDE [Ubuntu support](../../includes/ubuntu-support.md)] -### Raspberry Pi OS - -[Raspberry Pi OS][15] (formerly Raspbian) is a free operating system based on Debian. - -> [!IMPORTANT] -> .NET isn't supported on ARMv6 architecture devices, including Raspberry Pi Zero and Raspberry Pi -> devices prior to Raspberry Pi 2. - ## Windows PowerShell Compatibility The support lifecycle for PowerShell doesn't cover modules that ship outside of the PowerShell @@ -82,7 +74,8 @@ Server is supported under the [Windows Support Lifecycle][01]. ## Experimental features -[Experimental features][05] are limited to community support. +[Experimental features][05] aren't intended to be used in production environments. We appreciate +feedback on experimental features and we provide best-effort support for them. ## Notes on licensing @@ -97,7 +90,7 @@ Support for PowerShell is delivered via traditional Microsoft support agreements You can also pay for [assisted support][10] for PowerShell by filing a support request for your problem. -There are also [community support][04] options. You can file an issue, bug, or feature request on +There are multiple [community support][04] options. You can file an issue, bug, or feature request on GitHub. Also, you can get help from other members of the community in the Microsoft [PowerShell Tech Community][12] or any of the community forums listed on the [PowerShell][04] hub page. If you have a problem that requires immediate attention, you should use the traditional, paid @@ -179,4 +172,3 @@ you're running: [12]: https://techcommunity.microsoft.com/t5/PowerShell/ct-p/WindowsPowerShell [13]: https://www.microsoft.com/licensing/licensing-programs/enterprise [14]: https://www.microsoft.com/licensing/licensing-programs/software-assurance-default -[15]: https://www.raspberrypi.org/documentation/installation/installing-images/README.md diff --git a/reference/docs-conceptual/install/community-support.md b/reference/docs-conceptual/install/community-support.md index a7c3de0c332e..35d6f63c3419 100644 --- a/reference/docs-conceptual/install/community-support.md +++ b/reference/docs-conceptual/install/community-support.md @@ -5,8 +5,8 @@ title: Community support for PowerShell on Linux --- # Community support for PowerShell on Linux -There are many distributions of Linux that aren't officially supported by Microsoft. In some cases, -PowerShell may be supported by the community for these releases. +PowerShell can be installed on some distributions of Linux that aren't supported by Microsoft. In +those cases, you may find support from the community for PowerShell on those platforms. To be supported by Microsoft, the Linux distribution must meet the following criteria: @@ -44,7 +44,8 @@ from the AUR, see the [Arch Linux wiki][06] or [Using PowerShell in Docker][09]. ## Kali -Kali support isn't officially supported by Microsoft and is maintained by the community. +> [!NOTE] +> Kali support isn't officially supported by Microsoft and is maintained by the community. ### Installation - Kali @@ -63,6 +64,70 @@ pwsh apt -y remove powershell ``` +## Raspberry Pi OS + +[Raspberry Pi OS][13] (formerly Raspbian) is a free operating system based on Debian. + +> [!IMPORTANT] +> .NET isn't supported on ARMv6 architecture devices, including Raspberry Pi Zero and Raspberry Pi +> devices prior to Raspberry Pi 2. + +### Install on Raspberry Pi OS + +Download the tar.gz package from the [releases][12] page onto your Raspberry Pi computer. The links +to the current versions are: + +- PowerShell 7.3.6 - `https://github.com/PowerShell/PowerShell/releases/download/v7.3.6/powershell-7.3.6-linux-arm32.tar.gz` +- PowerShell 7.2.13 - `https://github.com/PowerShell/PowerShell/releases/download/v7.2.13/powershell-7.2.13-linux-arm32.tar.gz` + +Use the following shell commands to download and install the package. Change the URL to match the +PowerShell version that you want to install. + +```sh +################################### +# Prerequisites + +# Update package lists +sudo apt-get update + +# Install dependencies +sudo apt-get install libssl1.1 libunwind8 -y + +################################### +# Download and extract PowerShell + +# Grab the latest tar.gz +wget https://github.com/PowerShell/PowerShell/releases/download/v7.3.6/powershell-7.3.6-linux-arm32.tar.gz + +# Make folder to put powershell +mkdir ~/powershell + +# Unpack the tar.gz file +tar -xvf ./powershell-7.3.6-linux-arm32.tar.gz -C ~/powershell + +# Start PowerShell +~/powershell/pwsh +``` + +Optionally, you can create a symbolic link to start PowerShell without specifying the path to the +`pwsh` binary. + +```sh +# Start PowerShell from bash with sudo to create a symbolic link +sudo ~/powershell/pwsh -command 'New-Item -ItemType SymbolicLink -Path "/usr/bin/pwsh" -Target "$PSHOME/pwsh" -Force' + +# alternatively you can run following to create a symbolic link +# sudo ln -s ~/powershell/pwsh /usr/bin/pwsh + +# Now to start PowerShell you can just run "pwsh" +``` + +### Uninstallation - Raspberry Pi OS + +```sh +rm -rf ~/powershell +``` + [01]: ../community/community-support.md [02]: https://aur.archlinux.org/packages/powershell-bin/ @@ -74,3 +139,5 @@ apt -y remove powershell [08]: install-ubuntu.md [09]: powershell-in-docker.md [10]: powershell-support-lifecycle.md +[12]: install-other-linux.md#binary-archives +[13]: https://www.raspberrypi.org/documentation/installation/installing-images/README.md diff --git a/reference/docs-conceptual/install/install-raspbian.md b/reference/docs-conceptual/install/install-raspbian.md deleted file mode 100644 index 3862b8118ff6..000000000000 --- a/reference/docs-conceptual/install/install-raspbian.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -description: Information about installing PowerShell on Raspberry Pi OS -ms.date: 06/28/2023 -title: Installing PowerShell on Raspberry Pi OS ---- -# Installing PowerShell on Raspberry Pi OS - -All packages are available on our GitHub [releases][01] page. After the package is installed, run -`pwsh` from a terminal. Run `pwsh-preview` if you installed a preview release. - -> [!NOTE] -> PowerShell 7.3 is an in-place upgrade that removes previous versions of PowerShell. -> -> If you need to run PowerShell 7.3 side-by-side with a previous version, reinstall the previous -> version using the [binary archive][04] method. - -## Raspberry Pi OS - -[Raspberry Pi OS][03] (formerly Raspbian) is a free operating system based on Debian. - -> [!IMPORTANT] -> .NET isn't supported on ARMv6 architecture devices, including Raspberry Pi Zero and Raspberry Pi -> devices prior to Raspberry Pi 2. - -### Install on Raspberry Pi OS - -Download the tar.gz package from the [releases][01] page onto your Raspberry Pi computer. The links -to the current versions are: - -- PowerShell 7.3.6 - `https://github.com/PowerShell/PowerShell/releases/download/v7.3.6/powershell-7.3.6-linux-arm32.tar.gz` -- PowerShell 7.2.13 - `https://github.com/PowerShell/PowerShell/releases/download/v7.2.13/powershell-7.2.13-linux-arm32.tar.gz` - -Use the following shell commands to download and install the package. Change the URL to match the -PowerShell version that you want to install. - -```sh -################################### -# Prerequisites - -# Update package lists -sudo apt-get update - -# Install dependencies -sudo apt-get install libssl1.1 libunwind8 -y - -################################### -# Download and extract PowerShell - -# Grab the latest tar.gz -wget https://github.com/PowerShell/PowerShell/releases/download/v7.3.6/powershell-7.3.6-linux-arm32.tar.gz - -# Make folder to put powershell -mkdir ~/powershell - -# Unpack the tar.gz file -tar -xvf ./powershell-7.3.6-linux-arm32.tar.gz -C ~/powershell - -# Start PowerShell -~/powershell/pwsh -``` - -Optionally, you can create a symbolic link to start PowerShell without specifying the path to the -`pwsh` binary. - -```sh -# Start PowerShell from bash with sudo to create a symbolic link -sudo ~/powershell/pwsh -command 'New-Item -ItemType SymbolicLink -Path "/usr/bin/pwsh" -Target "$PSHOME/pwsh" -Force' - -# alternatively you can run following to create a symbolic link -# sudo ln -s ~/powershell/pwsh /usr/bin/pwsh - -# Now to start PowerShell you can just run "pwsh" -``` - -### Uninstallation - Raspberry Pi OS - -```sh -rm -rf ~/powershell -``` - -## PowerShell paths - -- `$PSHOME` is `/opt/microsoft/powershell/7/` -- User profiles are read from `~/.config/powershell/profile.ps1` -- Default profiles are read from `$PSHOME/profile.ps1` -- User modules are read from `~/.local/share/powershell/Modules` -- Shared modules are read from `/usr/local/share/powershell/Modules` -- Default modules are read from `$PSHOME/Modules` -- PSReadLine history is recorded to `~/.local/share/powershell/PSReadLine/ConsoleHost_history.txt` - -The profiles respect PowerShell's per-host configuration, so the default host-specific profiles -exists at `Microsoft.PowerShell_profile.ps1` in the same locations. - -PowerShell respects the [XDG Base Directory Specification][02] on Linux. - -## Installation support - -Microsoft supports the installation methods in this document. There may be other methods of -installation available from other third-party sources. While those tools and methods may work, -Microsoft can't support those methods. - -The Raspberry Pi OS is available for Arm 64 processors. PowerShell hasn't been tested on Arm 64 -for the Raspberry Pi OS. - - -[01]: https://aka.ms/PowerShell-Release?tag=stable -[02]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html -[03]: https://www.raspberrypi.org/documentation/installation/installing-images/README.md -[04]: install-other-linux.md#binary-archives From a77c8feb51994f2c0789e97c75a95d2057af39c2 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 5 Sep 2023 09:30:56 -0500 Subject: [PATCH 2/3] (AB#156514) Remove reference to .NET Framework in about_Operators (#10386) Prior to this change, the documentation in `about_Operators` referenced .NET Framework types and classes instead of .NET types and classes. This change: - Removes the incorrect qualifier as 7+ is built on .NET, not the .NET Framework. - Fixes AB#156514 - Resolves #10382 --- .../Microsoft.PowerShell.Core/About/about_Operators.md | 10 +++++----- .../Microsoft.PowerShell.Core/About/about_Operators.md | 10 +++++----- .../Microsoft.PowerShell.Core/About/about_Operators.md | 10 +++++----- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/reference/7.2/Microsoft.PowerShell.Core/About/about_Operators.md b/reference/7.2/Microsoft.PowerShell.Core/About/about_Operators.md index 1a2c72b93f80..97cfe109e7ba 100644 --- a/reference/7.2/Microsoft.PowerShell.Core/About/about_Operators.md +++ b/reference/7.2/Microsoft.PowerShell.Core/About/about_Operators.md @@ -1,7 +1,7 @@ --- description: Describes the operators that are supported by PowerShell. Locale: en-US -ms.date: 05/30/2023 +ms.date: 09/05/2023 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_operators?view=powershell-7.2&WT.mc_id=ps-gethelp schema: 2.0.0 title: about Operators @@ -88,8 +88,8 @@ For more information, see [about_Split][20] and [about_Join][11]. ## Type Operators -Use the type operators (`-is`, `-isnot`, `-as`) to find or change the .NET -Framework type of an object. +Use the type operators (`-is`, `-isnot`, `-as`) to find or change the .NET type +of an object. For more information, see [about_Type_Operators][21]. @@ -687,8 +687,8 @@ see [about_Member-Access_Enumeration][13]. ### Static member operator `::` -Calls the static properties and methods of a .NET Framework class. To find the -static properties and methods of an object, use the Static parameter of the +Calls the static properties and methods of a .NET class. To find the static +properties and methods of an object, use the Static parameter of the `Get-Member` cmdlet. The member name may be an expression. ```powershell diff --git a/reference/7.3/Microsoft.PowerShell.Core/About/about_Operators.md b/reference/7.3/Microsoft.PowerShell.Core/About/about_Operators.md index afcd081ae401..31d700e1d3b8 100644 --- a/reference/7.3/Microsoft.PowerShell.Core/About/about_Operators.md +++ b/reference/7.3/Microsoft.PowerShell.Core/About/about_Operators.md @@ -1,7 +1,7 @@ --- description: Describes the operators that are supported by PowerShell. Locale: en-US -ms.date: 05/30/2023 +ms.date: 09/05/2023 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_operators?view=powershell-7.3&WT.mc_id=ps-gethelp schema: 2.0.0 title: about Operators @@ -88,8 +88,8 @@ For more information, see [about_Split][20] and [about_Join][11]. ## Type Operators -Use the type operators (`-is`, `-isnot`, `-as`) to find or change the .NET -Framework type of an object. +Use the type operators (`-is`, `-isnot`, `-as`) to find or change the .NET type +of an object. For more information, see [about_Type_Operators][21]. @@ -687,8 +687,8 @@ see [about_Member-Access_Enumeration][13]. ### Static member operator `::` -Calls the static properties and methods of a .NET Framework class. To find the -static properties and methods of an object, use the Static parameter of the +Calls the static properties and methods of a .NET class. To find the static +properties and methods of an object, use the Static parameter of the `Get-Member` cmdlet. The member name may be an expression. ```powershell diff --git a/reference/7.4/Microsoft.PowerShell.Core/About/about_Operators.md b/reference/7.4/Microsoft.PowerShell.Core/About/about_Operators.md index 0c891bd7d373..4c77aa535acd 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/About/about_Operators.md +++ b/reference/7.4/Microsoft.PowerShell.Core/About/about_Operators.md @@ -1,7 +1,7 @@ --- description: Describes the operators that are supported by PowerShell. Locale: en-US -ms.date: 05/30/2023 +ms.date: 09/05/2023 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_operators?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: about Operators @@ -88,8 +88,8 @@ For more information, see [about_Split][20] and [about_Join][11]. ## Type Operators -Use the type operators (`-is`, `-isnot`, `-as`) to find or change the .NET -Framework type of an object. +Use the type operators (`-is`, `-isnot`, `-as`) to find or change the .NET type +of an object. For more information, see [about_Type_Operators][21]. @@ -687,8 +687,8 @@ see [about_Member-Access_Enumeration][13]. ### Static member operator `::` -Calls the static properties and methods of a .NET Framework class. To find the -static properties and methods of an object, use the Static parameter of the +Calls the static properties and methods of a .NET class. To find the static +properties and methods of an object, use the Static parameter of the `Get-Member` cmdlet. The member name may be an expression. ```powershell From 54744e9f81d1d958439f4d5aa5dc73e0a410b7dc Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 5 Sep 2023 13:00:18 -0500 Subject: [PATCH 3/3] (GH-10385) Indicate Path accepts wildcards for `Convert-Path` (#10388) Prior to this change, the **Path** parameter for the `Convert-Path` cmdlet indicated that it does not accept wildcard values, even though it does. This change: - Updates the metadata to accurately reflect the cmdlet behavior - Fixes AB#156610 - Resolves #10385 --- .../Convert-Path.md | 21 ++++++++++-------- .../Convert-Path.md | 22 ++++++++++--------- .../Convert-Path.md | 22 ++++++++++--------- .../Convert-Path.md | 22 ++++++++++--------- 4 files changed, 48 insertions(+), 39 deletions(-) diff --git a/reference/5.1/Microsoft.PowerShell.Management/Convert-Path.md b/reference/5.1/Microsoft.PowerShell.Management/Convert-Path.md index 948746c7fb76..fee528992e8d 100644 --- a/reference/5.1/Microsoft.PowerShell.Management/Convert-Path.md +++ b/reference/5.1/Microsoft.PowerShell.Management/Convert-Path.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Management -ms.date: 11/22/2022 +ms.date: 09/05/2023 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/convert-path?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: Convert-Path @@ -66,10 +66,13 @@ C:\Users\User01 ### -LiteralPath Specifies, as a string array, the path to be converted. The value of the **LiteralPath** parameter -is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes +is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences. +For more information, see +[about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md). + ```yaml Type: System.String[] Parameter Sets: LiteralPath @@ -95,7 +98,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False +Accept wildcard characters: True ``` ### -UseTransaction @@ -141,18 +144,18 @@ Windows PowerShell includes the following aliases for `Convert-Path`: - `cvpa` The cmdlets that contain the Path noun manipulate path names and return the names in a concise -format that all PowerShell providers can interpret. They are designed for use in programs and -scripts where you want to display all or part of a path name in a particular format. Use them like -you would use **Dirname**, **Normpath**, **Realpath**, **Join**, or other path manipulators. +format that all PowerShell providers can interpret. They're designed for use in programs and +scripts where you want to display all or part of a path in a particular format. Use them like you +would use **Dirname**, **Normpath**, **Realpath**, **Join**, or other path manipulators. -You can use the path cmdlets with several providers, including the FileSystem, Registry, and -Certificate providers. +You can use the path cmdlets with several providers, including the **FileSystem**, **Registry**, +and **Certificate** providers. This cmdlet is designed to work with the data exposed by any provider. To list the providers available in your session, type `Get-PSProvider`. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md). -`Convert-Path` only converts existing paths. It cannot be used to convert a location that does not +`Convert-Path` only converts existing paths. It can't be used to convert a location that doesn't exist yet. ## RELATED LINKS diff --git a/reference/7.2/Microsoft.PowerShell.Management/Convert-Path.md b/reference/7.2/Microsoft.PowerShell.Management/Convert-Path.md index eb4274b3e074..ae6b7c1d5609 100644 --- a/reference/7.2/Microsoft.PowerShell.Management/Convert-Path.md +++ b/reference/7.2/Microsoft.PowerShell.Management/Convert-Path.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Management -ms.date: 11/22/2022 +ms.date: 09/05/2023 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/convert-path?view=powershell-7.2&WT.mc_id=ps-gethelp schema: 2.0.0 title: Convert-Path @@ -66,10 +66,13 @@ C:\Users\User01 ### -LiteralPath Specifies, as a string array, the path to be converted. The value of the **LiteralPath** parameter -is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes +is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences. +For more information, see +[about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md). + ```yaml Type: System.String[] Parameter Sets: LiteralPath @@ -95,7 +98,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False +Accept wildcard characters: True ``` ### CommonParameters @@ -125,18 +128,18 @@ PowerShell includes the following aliases for `Convert-Path`: - `cvpa` The cmdlets that contain the Path noun manipulate path names and return the names in a concise -format that all PowerShell providers can interpret. They are designed for use in programs and -scripts where you want to display all or part of a path name in a particular format. Use them like -you would use **Dirname**, **Normpath**, **Realpath**, **Join**, or other path manipulators. +format that all PowerShell providers can interpret. They're designed for use in programs and +scripts where you want to display all or part of a path in a particular format. Use them like you +would use **Dirname**, **Normpath**, **Realpath**, **Join**, or other path manipulators. -You can use the path cmdlets with several providers, including the FileSystem, Registry, and -Certificate providers. +You can use the path cmdlets with several providers, including the **FileSystem**, **Registry**, +and **Certificate** providers. This cmdlet is designed to work with the data exposed by any provider. To list the providers available in your session, type `Get-PSProvider`. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md). -`Convert-Path` only converts existing paths. It cannot be used to convert a location that does not +`Convert-Path` only converts existing paths. It can't be used to convert a location that doesn't exist yet. ## RELATED LINKS @@ -150,4 +153,3 @@ exist yet. [Test-Path](Test-Path.md) [Get-PSProvider](Get-PSProvider.md) - diff --git a/reference/7.3/Microsoft.PowerShell.Management/Convert-Path.md b/reference/7.3/Microsoft.PowerShell.Management/Convert-Path.md index d527c132c7fc..e470e145f630 100644 --- a/reference/7.3/Microsoft.PowerShell.Management/Convert-Path.md +++ b/reference/7.3/Microsoft.PowerShell.Management/Convert-Path.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Management -ms.date: 11/22/2022 +ms.date: 09/05/2023 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/convert-path?view=powershell-7.3&WT.mc_id=ps-gethelp schema: 2.0.0 title: Convert-Path @@ -66,10 +66,13 @@ C:\Users\User01 ### -LiteralPath Specifies, as a string array, the path to be converted. The value of the **LiteralPath** parameter -is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes +is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences. +For more information, see +[about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md). + ```yaml Type: System.String[] Parameter Sets: LiteralPath @@ -95,7 +98,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False +Accept wildcard characters: True ``` ### CommonParameters @@ -125,18 +128,18 @@ PowerShell includes the following aliases for `Convert-Path`: - `cvpa` The cmdlets that contain the Path noun manipulate path names and return the names in a concise -format that all PowerShell providers can interpret. They are designed for use in programs and -scripts where you want to display all or part of a path name in a particular format. Use them like -you would use **Dirname**, **Normpath**, **Realpath**, **Join**, or other path manipulators. +format that all PowerShell providers can interpret. They're designed for use in programs and +scripts where you want to display all or part of a path in a particular format. Use them like you +would use **Dirname**, **Normpath**, **Realpath**, **Join**, or other path manipulators. -You can use the path cmdlets with several providers, including the FileSystem, Registry, and -Certificate providers. +You can use the path cmdlets with several providers, including the **FileSystem**, **Registry**, +and **Certificate** providers. This cmdlet is designed to work with the data exposed by any provider. To list the providers available in your session, type `Get-PSProvider`. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md). -`Convert-Path` only converts existing paths. It cannot be used to convert a location that does not +`Convert-Path` only converts existing paths. It can't be used to convert a location that doesn't exist yet. ## RELATED LINKS @@ -150,4 +153,3 @@ exist yet. [Test-Path](Test-Path.md) [Get-PSProvider](Get-PSProvider.md) - diff --git a/reference/7.4/Microsoft.PowerShell.Management/Convert-Path.md b/reference/7.4/Microsoft.PowerShell.Management/Convert-Path.md index 2c43fdaaa5b0..d1891c5c747f 100644 --- a/reference/7.4/Microsoft.PowerShell.Management/Convert-Path.md +++ b/reference/7.4/Microsoft.PowerShell.Management/Convert-Path.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Management -ms.date: 11/22/2022 +ms.date: 09/05/2023 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/convert-path?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: Convert-Path @@ -66,10 +66,13 @@ C:\Users\User01 ### -LiteralPath Specifies, as a string array, the path to be converted. The value of the **LiteralPath** parameter -is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes +is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences. +For more information, see +[about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md). + ```yaml Type: System.String[] Parameter Sets: LiteralPath @@ -95,7 +98,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False +Accept wildcard characters: True ``` ### CommonParameters @@ -125,18 +128,18 @@ PowerShell includes the following aliases for `Convert-Path`: - `cvpa` The cmdlets that contain the Path noun manipulate path names and return the names in a concise -format that all PowerShell providers can interpret. They are designed for use in programs and -scripts where you want to display all or part of a path name in a particular format. Use them like -you would use **Dirname**, **Normpath**, **Realpath**, **Join**, or other path manipulators. +format that all PowerShell providers can interpret. They're designed for use in programs and +scripts where you want to display all or part of a path in a particular format. Use them like you +would use **Dirname**, **Normpath**, **Realpath**, **Join**, or other path manipulators. -You can use the path cmdlets with several providers, including the FileSystem, Registry, and -Certificate providers. +You can use the path cmdlets with several providers, including the **FileSystem**, **Registry**, +and **Certificate** providers. This cmdlet is designed to work with the data exposed by any provider. To list the providers available in your session, type `Get-PSProvider`. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md). -`Convert-Path` only converts existing paths. It cannot be used to convert a location that does not +`Convert-Path` only converts existing paths. It can't be used to convert a location that doesn't exist yet. ## RELATED LINKS @@ -150,4 +153,3 @@ exist yet. [Test-Path](Test-Path.md) [Get-PSProvider](Get-PSProvider.md) -