Skip to content

Commit d5dca18

Browse files
Fix incorrect case/capitalization in ref docs (#11924)
This ensures the following components have the correct/consistent case throughout the reference documentation: Preference variable, PS environment variable, PS drive, PS provider, PS command name, PS command argument, PS module, PS file extension, PS host name/application, #Requires statement, parameter name, about_* topic, member name, scope modifier, keyword, operator, calculated property key/value, attribute, type accelerator, type literal/name, WMI namespace/class, variable name, special character, comment-based help keyword, product/company name, Windows drive letter/directory, Windows/Unix environment variable In addition, changes include fixes to incorrect terminology (e.g., referring to a keyword as a command) and formatting of PS syntax elements (non-exhaustive).
1 parent 02ad060 commit d5dca18

40 files changed

+156
-156
lines changed

reference/5.1/Microsoft.PowerShell.Management/Get-ChildItem.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ as follows:
8888
- `s` (system)
8989

9090
For more information about the mode flags, see
91-
[about_Filesystem_Provider](../Microsoft.PowerShell.Core/About/about_Filesystem_Provider.md#attributes-flagsexpression).
91+
[about_FileSystem_Provider](../Microsoft.PowerShell.Core/About/about_Filesystem_Provider.md#attributes-flagsexpression).
9292

9393
### Example 2: Get child item names in a directory
9494

@@ -357,8 +357,8 @@ point. In PowerShell, this information is available from the **Target** property
357357
object returned by `Get-ChildItem`.
358358

359359
```powershell
360-
PS D:\> New-Item -ItemType Junction -Name tmp -Target $env:TEMP
361-
PS D:\> Get-ChildItem | Select-Object name,*target
360+
PS D:\> New-Item -ItemType Junction -Name tmp -Target $Env:TEMP
361+
PS D:\> Get-ChildItem | Select-Object Name, *Target
362362
363363
Name Target
364364
---- ------
@@ -979,7 +979,7 @@ The cmdlet outputs this type when accessing the `Env:` drive.
979979

980980
### System.IO.FileInfo
981981

982-
The cmdlet outputs these types when accessing the Filesystem drives.
982+
The cmdlet outputs these types when accessing the FileSystem drives.
983983

984984
### System.Management.Automation.FunctionInfo
985985

reference/5.1/Microsoft.PowerShell.Management/Get-HotFix.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ Get-HotFix [-Description <String[]>] [-ComputerName <String[]>] [-Credential <PS
3333

3434
> **This cmdlet is only available on the Windows platform.**
3535
36-
The `Get-Hotfix` cmdlet uses the **Win32_QuickFixEngineering** WMI class to list hotfixes that are
36+
The `Get-HotFix` cmdlet uses the **Win32_QuickFixEngineering** WMI class to list hotfixes that are
3737
installed on the local computer or specified remote computers.
3838

3939
## EXAMPLES
4040

4141
### Example 1: Get all hotfixes on the local computer
4242

43-
The `Get-Hotfix` cmdlet gets all hotfixes installed on the local computer.
43+
The `Get-HotFix` cmdlet gets all hotfixes installed on the local computer.
4444

4545
```powershell
4646
Get-HotFix
@@ -56,14 +56,14 @@ Server01 Update KB4480056 NT AUTHORITY\SYSTEM 1/24/2019 00:
5656

5757
### Example 2: Get hotfixes from multiple computers filtered by a string
5858

59-
The `Get-Hotfix` command uses parameters to get hotfixes installed on remote computers. The results
59+
The `Get-HotFix` command uses parameters to get hotfixes installed on remote computers. The results
6060
are filtered by a specified description string.
6161

6262
```powershell
6363
Get-HotFix -Description Security* -ComputerName Server01, Server02 -Credential Domain01\admin01
6464
```
6565

66-
`Get-Hotfix` filters the output with the **Description** parameter and the string **Security** that
66+
`Get-HotFix` filters the output with the **Description** parameter and the string **Security** that
6767
includes the asterisk (`*`) wildcard. The **ComputerName** parameter includes a comma-separated
6868
string of remote computer names. The **Credential** parameter specifies a user account that has
6969
permission to access the remote computers and run commands.
@@ -81,7 +81,7 @@ $A | ForEach-Object { if (!(Get-HotFix -Id KB957095 -ComputerName $_))
8181

8282
The `$A` variable contains computer names that were obtained by `Get-Content` from a text file. The
8383
objects in `$A` are sent down the pipeline to `ForEach-Object`. An `if` statement uses the
84-
`Get-Hotfix` cmdlet with the **Id** parameter and a specific Id number for each computer name. If a
84+
`Get-HotFix` cmdlet with the **Id** parameter and a specific Id number for each computer name. If a
8585
computer doesn't have the specified hotfix Id installed, the `Add-Content` cmdlet writes the
8686
computer name to a file.
8787

@@ -93,7 +93,7 @@ This example gets the most recent hotfix installed on a computer.
9393
(Get-HotFix | Sort-Object -Property InstalledOn)[-1]
9494
```
9595

96-
`Get-Hotfix` sends the objects down the pipeline to the `Sort-Object` cmdlet. `Sort-Object` sorts
96+
`Get-HotFix` sends the objects down the pipeline to the `Sort-Object` cmdlet. `Sort-Object` sorts
9797
objects by ascending order and uses the **Property** parameter to evaluate each **InstalledOn**
9898
date. The array notation `[-1]` selects the most recent installed hotfix.
9999

@@ -104,7 +104,7 @@ date. The array notation `[-1]` selects the most recent installed hotfix.
104104
Specifies a remote computer. Type the NetBIOS name, an Internet Protocol (IP) address, or a fully
105105
qualified domain name (FQDN) of a remote computer.
106106

107-
When the **ComputerName** parameter isn't specified, `Get-Hotfix` runs on the local computer.
107+
When the **ComputerName** parameter isn't specified, `Get-HotFix` runs on the local computer.
108108

109109
The **ComputerName** parameter doesn't rely on Windows PowerShell remoting. If your computer isn't
110110
configured to run remote commands, use the **ComputerName** parameter.
@@ -196,7 +196,7 @@ You can pipe a string containing a computer name to this cmdlet.
196196

197197
## OUTPUTS
198198

199-
### System.Management.ManagementObject#root\CIMV2\Win32_QuickFixEngineering
199+
### System.Management.ManagementObject#root\cimv2\Win32_QuickFixEngineering
200200

201201
This cmdlet returns objects representing the hotfixes on the computer.
202202

reference/5.1/Microsoft.PowerShell.Management/Get-Item.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ cmdlet with the PowerShell Registry provider to get registry keys and subkeys, b
155155
`Get-ItemProperty` cmdlet to get the registry values and data.
156156

157157
```powershell
158-
Get-Item HKLM:\Software\Microsoft\Powershell\1\Shellids\Microsoft.Powershell\
158+
Get-Item HKLM:\Software\Microsoft\PowerShell\1\Shellids\Microsoft.PowerShell\
159159
```
160160

161161
### Example 7: Get items in a directory that have an exclusion
@@ -527,7 +527,7 @@ The cmdlet outputs this type when accessing the `Env:` drive.
527527

528528
### System.IO.FileInfo
529529

530-
The cmdlet outputs these types when accessing the Filesystem drives.
530+
The cmdlet outputs these types when accessing the FileSystem drives.
531531

532532
### System.Management.Automation.FunctionInfo
533533

@@ -563,7 +563,7 @@ to get registry values and data. The registry values are considered to be proper
563563
registry key.
564564

565565
This cmdlet is designed to work with the data exposed by any provider. To list the providers
566-
available in your session, type `Get-PsProvider`. For more information, see
566+
available in your session, type `Get-PSProvider`. For more information, see
567567
[about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
568568

569569
## RELATED LINKS

reference/5.1/Microsoft.PowerShell.Management/Get-PSDrive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ D 1211.06 123642.32 FileSystem D:\
8989
This command gets the D: drive on the computer. Note that the drive letter in the command is not
9090
followed by a colon.
9191

92-
### Example 3: Get all the drives that are supported by the Windows PowerShell file system provider
92+
### Example 3: Get all the drives that are supported by the Windows PowerShell FileSystem provider
9393

9494
```
9595
PS C:\> Get-PSDrive -PSProvider FileSystem

reference/5.1/Microsoft.PowerShell.Management/Get-PSProvider.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ This command displays a list of all available PowerShell providers.
4141
### Example 2: Display a list of all PowerShell providers that begin with specified letters
4242

4343
```powershell
44-
Get-PSProvider f*, r* | Format-List
44+
Get-PSProvider F*, R* | Format-List
4545
```
4646

47-
This command displays a list of all PowerShell providers with names that begin with the letter `f`
48-
or `r`.
47+
This command displays a list of all PowerShell providers with names that begin with the letter `F`
48+
or `R`.
4949

5050
### Example 3: Find snap-ins or module that added providers to your session
5151

@@ -67,7 +67,7 @@ WSMan Microsoft.WSMan.Management
6767
```
6868

6969
```powershell
70-
Get-PSProvider | Where {$_.ModuleName -eq "Microsoft.PowerShell.Security"}
70+
Get-PSProvider | where {$_.ModuleName -eq "Microsoft.PowerShell.Security"}
7171
```
7272

7373
```Output
@@ -89,7 +89,7 @@ values of their Name, Module, and PSSnapin properties.
8989
The second command uses the `Where-Object` cmdlet to get the providers that come from the
9090
**Microsoft.PowerShell.Security** snap-in.
9191

92-
### Example 4: Resolve the path of the Home property of the file system provider
92+
### Example 4: Resolve the path of the Home property of the FileSystem provider
9393

9494
```powershell
9595
C:\> Resolve-Path ~
@@ -102,7 +102,7 @@ C:\Users\User01
102102
```
103103

104104
```powershell
105-
PS C:\> (get-psprovider FileSystem).home
105+
PS C:\> (Get-PSProvider FileSystem).Home
106106
```
107107

108108
```Output
@@ -111,7 +111,7 @@ C:\Users\User01
111111

112112
This example shows that the tilde symbol (`~`) represents the value of the **Home** property of the
113113
FileSystem provider. The **Home** property value is optional, but for the **FileSystem** provider,
114-
it is defined as `$env:HOMEDRIVE\$env:HOMEPATH` or `$HOME`.
114+
it is defined as `$Env:HOMEDRIVE\$Env:HOMEPATH` or `$HOME`.
115115

116116
## PARAMETERS
117117

reference/5.1/Microsoft.PowerShell.Management/Get-Process.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ though the default display lists them in kilobytes and megabytes.
110110

111111
```powershell
112112
$A = Get-Process
113-
$A | Get-Process | Format-Table -View priority
113+
$A | Get-Process | Format-Table -View Priority
114114
```
115115

116116
These commands list the processes on the computer in groups based on their priority class. The first
@@ -257,13 +257,13 @@ The second command gets the PowerShell process that is hosting the current sessi
257257
### Example 10: Get all processes that have a main window title and display them in a table
258258

259259
```powershell
260-
Get-Process | Where-Object {$_.mainWindowTitle} | Format-Table Id, Name, mainWindowtitle -AutoSize
260+
Get-Process | Where-Object {$_.MainWindowTitle} | Format-Table Id, Name, MainWindowTitle -AutoSize
261261
```
262262

263263
This command gets all the processes that have a main window title, and it displays them in a table
264264
with the process ID and the process name.
265265

266-
The **mainWindowTitle** property is just one of many useful properties of the **Process** object
266+
The **MainWindowTitle** property is just one of many useful properties of the **Process** object
267267
that `Get-Process` returns. To view all of the properties, pipe the results of a `Get-Process`
268268
command to the `Get-Member` cmdlet `Get-Process | Get-Member`.
269269

@@ -476,7 +476,7 @@ of all of the properties of process objects, see
476476
- **VM(M)**: The amount of virtual memory that the process is using, in megabytes. Virtual memory
477477
includes storage in the paging files on disk.
478478
- **CPU(s)**: The amount of processor time that the process has used on all processors, in seconds.
479-
- **ID**: The process ID (PID) of the process.
479+
- **Id**: The process ID (PID) of the process.
480480
- **ProcessName**: The name of the process. For explanations of the concepts related to processes,
481481
see the Glossary in Help and Support Center and the Help for Task Manager.
482482

reference/5.1/Microsoft.PowerShell.Management/Get-Service.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ display name finds network-related services even when the service name doesn't i
7373
xmlprov, the Network Provisioning Service.
7474

7575
```powershell
76-
Get-Service -Displayname "*network*"
76+
Get-Service -DisplayName "*network*"
7777
```
7878

7979
### Example 4: Get services that begin with a search string and an exclusion
@@ -119,7 +119,7 @@ This example gets services that have dependent services.
119119
Get-Service |
120120
Where-Object {$_.DependentServices} |
121121
Format-List -Property Name, DependentServices, @{
122-
Label="NoOfDependentServices"; Expression={$_.dependentservices.count}
122+
Label="NoOfDependentServices"; Expression={$_.DependentServices.Count}
123123
}
124124
```
125125

@@ -153,7 +153,7 @@ property, stopped services appear before running services. This happens because
153153
To list running services first, use the **Descending** parameter of the `Sort-Object` cmdlet.
154154

155155
```powershell
156-
Get-Service "s*" | Sort-Object status
156+
Get-Service "s*" | Sort-Object Status
157157
```
158158

159159
```Output
@@ -178,7 +178,7 @@ Running seclogon Secondary Logon
178178

179179
```powershell
180180
Get-Service -Name "WinRM" -ComputerName "localhost", "Server01", "Server02" |
181-
Format-Table -Property MachineName, Status, Name, DisplayName -auto
181+
Format-Table -Property MachineName, Status, Name, DisplayName -Auto
182182
```
183183

184184
```Output

reference/5.1/Microsoft.PowerShell.Management/Join-Path.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ the `System\*` child path. It displays the same files and folders as `Get-ChildI
6565
displays the fully qualified path to each item. In this command, the `Path` and `ChildPath` optional
6666
parameter names are omitted.
6767

68-
### Example 4: Use Join-Path with the PowerShell registry provider
68+
### Example 4: Use Join-Path with the PowerShell Registry provider
6969

7070
```powershell
7171
PS HKLM:\> Join-Path -Path System -ChildPath *ControlSet* -Resolve
@@ -103,7 +103,7 @@ This command uses `Join-Path` to combine multiple path roots with a child path.
103103
### Example 6: Combine the roots of a file system drive with a child path
104104

105105
```powershell
106-
Get-PSDrive -PSProvider filesystem | ForEach-Object {$_.root} | Join-Path -ChildPath "Subdir"
106+
Get-PSDrive -PSProvider FileSystem | ForEach-Object {$_.Root} | Join-Path -ChildPath "Subdir"
107107
```
108108

109109
```output

reference/5.1/Microsoft.PowerShell.Management/New-Item.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ This command creates a text file that is named "testfile1.txt" in the current di
8181
follows the **Value** parameter is added to the file as content.
8282

8383
```powershell
84-
New-Item -Path . -Name "testfile1.txt" -ItemType "file" -Value "This is a text string."
84+
New-Item -Path . -Name "testfile1.txt" -ItemType "File" -Value "This is a text string."
8585
```
8686

8787
### Example 2: Create a directory
@@ -90,7 +90,7 @@ This command creates a directory named "Logfiles" in the `C:` drive. The **ItemT
9090
specifies that the new item is a directory, not a file or other file system object.
9191

9292
```powershell
93-
New-Item -Path "c:\" -Name "logfiles" -ItemType "directory"
93+
New-Item -Path "C:\" -Name "logfiles" -ItemType "Directory"
9494
```
9595

9696
### Example 3: Create a profile
@@ -112,7 +112,7 @@ For more information, see [about_Automatic_Variables](../Microsoft.PowerShell.Co
112112
and [about_Profiles](../Microsoft.PowerShell.Core/About/about_Profiles.md).
113113

114114
```powershell
115-
New-Item -Path $PROFILE -ItemType "file" -Force
115+
New-Item -Path $PROFILE -ItemType "File" -Force
116116
```
117117

118118
> [!NOTE]
@@ -128,7 +128,7 @@ instead of being specified in the value of **Name**. As indicated by the syntax,
128128
is valid.
129129

130130
```powershell
131-
New-Item -ItemType "directory" -Path "c:\ps-test\scripts"
131+
New-Item -ItemType "Directory" -Path "C:\ps-test\scripts"
132132
```
133133

134134
### Example 5: Create multiple files
@@ -137,7 +137,7 @@ This example creates files in two different directories. Because **Path** takes
137137
you can use it to create multiple items.
138138

139139
```powershell
140-
New-Item -ItemType "file" -Path "c:\ps-test\test.txt", "c:\ps-test\Logs\test.log"
140+
New-Item -ItemType "File" -Path "C:\ps-test\test.txt", "C:\ps-test\Logs\test.log"
141141
```
142142

143143
### Example 6: Use wildcards to create files in multiple directories
@@ -221,7 +221,7 @@ Mode LastWriteTime Length Name
221221
### Example 9: Use the -Force parameter to overwrite existing files
222222

223223
This example creates a file with a value and then recreates the file using `-Force`. This overwrites
224-
the existing file, as you can see by the length property.
224+
the existing file, as you can see by the **Length** property.
225225

226226
```powershell
227227
PS> New-Item ./TestFile.txt -ItemType File -Value 'This is just a test file'
@@ -676,7 +676,7 @@ Windows PowerShell includes the following aliases for `New-Item`:
676676
- `ni`
677677

678678
`New-Item` is designed to work with the data exposed by any provider. To list the providers
679-
available in your session, type `Get-PsProvider`. For more information, see
679+
available in your session, type `Get-PSProvider`. For more information, see
680680
[about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
681681

682682
## RELATED LINKS

reference/5.1/Microsoft.PowerShell.Management/New-ItemProperty.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ $newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'HereS
9797
This is text which contains newlines
9898
It can also contain "quoted" strings
9999
"@
100-
$newValue.multistring
100+
$newValue.HereString
101101
```
102102

103103
```output
@@ -111,7 +111,7 @@ The example shows how to use an array of values to create the `MultiString` valu
111111

112112
```powershell
113113
$newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'MultiString' -PropertyType MultiString -Value ('a','b','c')
114-
$newValue.multistring[0]
114+
$newValue.MultiString[0]
115115
```
116116

117117
```output

reference/7.4/Microsoft.PowerShell.Management/Get-ChildItem.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ as follows:
8686
- `s` (system)
8787

8888
For more information about the mode flags, see
89-
[about_Filesystem_Provider](../Microsoft.PowerShell.Core/About/about_Filesystem_Provider.md#attributes-flagsexpression).
89+
[about_FileSystem_Provider](../Microsoft.PowerShell.Core/About/about_Filesystem_Provider.md#attributes-flagsexpression).
9090

9191
### Example 2: Get child item names in a directory
9292

@@ -398,8 +398,8 @@ point. In PowerShell, this information is available from the **LinkTarget** prop
398398
filesystem object returned by `Get-ChildItem` and is displayed in the default output.
399399

400400
```powershell
401-
PS D:\> New-Item -ItemType Junction -Name tmp -Target $env:TEMP
402-
PS D:\> Get-ChildItem | Select-Object name, LinkTarget
401+
PS D:\> New-Item -ItemType Junction -Name tmp -Target $Env:TEMP
402+
PS D:\> Get-ChildItem | Select-Object Name, LinkTarget
403403
404404
Name LinkTarget
405405
---- ----------
@@ -991,7 +991,7 @@ The cmdlet outputs this type when accessing the `Env:` drive.
991991

992992
### System.IO.FileInfo
993993

994-
The cmdlet outputs these types when accessing the Filesystem drives.
994+
The cmdlet outputs these types when accessing the FileSystem drives.
995995

996996
### System.Management.Automation.FunctionInfo
997997

0 commit comments

Comments
 (0)