Skip to content

Commit e6dea04

Browse files
Fix incorrect case/capitalization in ref docs (#11926)
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 57dbd14 commit e6dea04

40 files changed

+174
-174
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ verbs are determined by the filename extension of the file that runs in the proc
109109

110110
```powershell
111111
$startExe = New-Object System.Diagnostics.ProcessStartInfo -Args powershell.exe
112-
$startExe.verbs
112+
$startExe.Verbs
113113
```
114114

115115
```Output
@@ -131,8 +131,8 @@ Note that the first command specifies a string as **ArgumentList**. The second c
131131
array.
132132

133133
```powershell
134-
Start-Process -FilePath "$env:comspec" -ArgumentList "/c dir `"%SystemDrive%\Program Files`""
135-
Start-Process -FilePath "$env:comspec" -ArgumentList "/c","dir","`"%SystemDrive%\Program Files`""
134+
Start-Process -FilePath "$Env:ComSpec" -ArgumentList "/c dir `"%SystemDrive%\Program Files`""
135+
Start-Process -FilePath "$Env:ComSpec" -ArgumentList "/c","dir","`"%SystemDrive%\Program Files`""
136136
```
137137

138138
## PARAMETERS

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Start-Service : Service 'Telnet (TlntSvr)' cannot be started due to the followin
9494
At line:1 char:14
9595
+ Start-Service <<<< tlntsvr
9696
97-
PS> Get-CimInstance win32_service | Where-Object Name -eq "tlntsvr"
97+
PS> Get-CimInstance Win32_Service | Where-Object Name -EQ "tlntsvr"
9898
ExitCode : 0
9999
Name : TlntSvr
100100
ProcessId : 0

reference/5.1/Microsoft.PowerShell.Management/Stop-Computer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -398,8 +398,8 @@ When you use the **AsJob** parameter, this cmdlet returns a **RemotingJob** obje
398398
## NOTES
399399

400400
This cmdlet uses the
401-
[`Win32Shutdown`](/windows/desktop/CIMWin32Prov/win32shutdown-method-in-class-win32-operatingsystem)
402-
method of the [`Win32_OperatingSystem`](/windows/desktop/CIMWin32Prov/win32-operatingsystem) WMI
401+
[Win32Shutdown](/windows/desktop/CIMWin32Prov/win32shutdown-method-in-class-win32-operatingsystem)
402+
method of the [Win32_OperatingSystem](/windows/desktop/CIMWin32Prov/win32-operatingsystem) WMI
403403
class. This method requires the `SeShutdownPrivilege` privilege be enabled for the user account
404404
used to shutdown the machine.
405405

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ In this case, because the directory contains only .dwg files, the result is `$fa
123123
### Example 4: Check for a file
124124

125125
```powershell
126-
Test-Path -Path $PROFILE -PathType leaf
126+
Test-Path -Path $PROFILE -PathType Leaf
127127
```
128128

129129
```Output
@@ -135,7 +135,7 @@ case, because the PowerShell profile is a `.ps1` file, the cmdlet returns `$true
135135

136136
### Example 5: Check paths in the Registry
137137

138-
These commands use `Test-Path` with the PowerShell registry provider.
138+
These commands use `Test-Path` with the PowerShell Registry provider.
139139

140140
The first command tests whether the registry path of the **Microsoft.PowerShell** registry key is
141141
correct on the system. If PowerShell is installed correctly, the cmdlet returns `$true`.
@@ -163,13 +163,13 @@ False
163163

164164
### Example 6: Test if a file is newer than a specified date
165165

166-
This command uses the **NewerThan** dynamic parameter to determine whether the `PowerShell.exe`
166+
This command uses the **NewerThan** dynamic parameter to determine whether the `powershell.exe`
167167
file on the computer is newer than `July 13, 2009`.
168168

169169
The NewerThan parameter works only in file system drives.
170170

171171
```powershell
172-
Test-Path $PSHOME\PowerShell.exe -NewerThan "July 13, 2009"
172+
Test-Path $PSHOME\powershell.exe -NewerThan "July 13, 2009"
173173
```
174174

175175
```Output

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ stopped. You can specify a process by process name or process ID (PID), or pipe
4747
### Example 1: Stop a process and wait
4848

4949
```
50-
PS C:\> $nid = (Get-Process notepad).id
50+
PS C:\> $nid = (Get-Process notepad).Id
5151
PS C:\> Stop-Process -Id $nid
5252
PS C:\> Wait-Process -Id $nid
5353
```
@@ -67,7 +67,7 @@ The third command uses `Wait-Process` to wait until the Notepad process is stopp
6767

6868
```
6969
PS C:\> $p = Get-Process notepad
70-
PS C:\> Wait-Process -Id $p.id
70+
PS C:\> Wait-Process -Id $p.Id
7171
PS C:\> Wait-Process -Name "notepad"
7272
PS C:\> Wait-Process -InputObject $p
7373
```

reference/5.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ the `Cert:` drive.
7474
Set-Location Cert:
7575
```
7676

77-
You can also work with the certificate provider from any other PowerShell
77+
You can also work with the Certificate provider from any other PowerShell
7878
drive. To reference an alias from another location, use the `Cert:` drive name
7979
in the path.
8080

@@ -112,7 +112,7 @@ The example shows the new certificate script properties (**DnsNameList**,
112112
**EnhancedKeyUsageList**, **SendAsTrustedIssuer**) using `Select-Object`.
113113

114114
```powershell
115-
$c = Get-Item cert:\LocalMachine\My\52A149D0393CE8A8D4AF0B172ED667A9E3A1F44E
115+
$c = Get-Item Cert:\LocalMachine\My\52A149D0393CE8A8D4AF0B172ED667A9E3A1F44E
116116
$c | Format-List DnsNameList, EnhancedKeyUsageList, SendAsTrustedIssuer
117117
```
118118

@@ -130,7 +130,7 @@ This command uses the **CodeSigningCert** and **Recurse** parameters of the
130130
code-signing authority.
131131

132132
```powershell
133-
Get-ChildItem -Path cert: -CodeSigningCert -Recurse
133+
Get-ChildItem -Path Cert: -CodeSigningCert -Recurse
134134
```
135135

136136
### Find expired certificates
@@ -139,7 +139,7 @@ This command uses the **ExpiringInDays** parameter of the `Get-ChildItem`
139139
cmdlet to get certificates that expire within the next 30 days.
140140

141141
```powershell
142-
Get-ChildItem -Path cert:\LocalMachine\WebHosting -ExpiringInDays 30
142+
Get-ChildItem -Path Cert:\LocalMachine\WebHosting -ExpiringInDays 30
143143
```
144144

145145
### Find Server SSL Certificates
@@ -150,7 +150,7 @@ This command uses the **SSLServerAuthentication** parameter of the
150150

151151
```powershell
152152
$getChildItemSplat = @{
153-
Path = 'cert:\LocalMachine\My', 'cert:\LocalMachine\WebHosting'
153+
Path = 'Cert:\LocalMachine\My', 'Cert:\LocalMachine\WebHosting'
154154
SSLServerAuthentication = $true
155155
}
156156
Get-ChildItem @getChildItemSplat
@@ -167,7 +167,7 @@ that have expired.
167167
$invokeCommandSplat = @{
168168
ComputerName = 'Srv01', 'Srv02'
169169
ScriptBlock = {
170-
Get-ChildItem -Path cert:\* -Recurse -ExpiringInDays 0
170+
Get-ChildItem -Path Cert:\* -Recurse -ExpiringInDays 0
171171
}
172172
}
173173
Invoke-Command @invokeCommandSplat
@@ -186,9 +186,9 @@ have the following attributes:
186186
The **NotAfter** property stores the certificate expiration date.
187187

188188
```powershell
189-
[DateTime] $ValidThrough = (Get-Date) + (New-TimeSpan -Days 30)
189+
[datetime] $ValidThrough = (Get-Date) + (New-TimeSpan -Days 30)
190190
$getChildItemSplat = @{
191-
Path = 'cert:\*'
191+
Path = 'Cert:\*'
192192
Recurse = $true
193193
DnsName = "*fabrikam*"
194194
Eku = "*Client Authentication*"
@@ -207,7 +207,7 @@ This command opens the Certificates MMC snap-in to manage the specified
207207
certificate.
208208

209209
```powershell
210-
Invoke-Item cert:\CurrentUser\my\6B8223358119BB08840DEE50FD8AF9EA776CE66B
210+
Invoke-Item Cert:\CurrentUser\my\6B8223358119BB08840DEE50FD8AF9EA776CE66B
211211
```
212212

213213
## Copying Certificates
@@ -252,8 +252,8 @@ The returned certificates are piped to the `Move-Item` cmdlet, which moves the
252252
certificates to the `WebHosting` store.
253253

254254
```powershell
255-
Get-ChildItem cert:\LocalMachine\My -SSLServerAuthentication |
256-
Move-Item -Destination cert:\LocalMachine\WebHosting
255+
Get-ChildItem Cert:\LocalMachine\My -SSLServerAuthentication |
256+
Move-Item -Destination Cert:\LocalMachine\WebHosting
257257
```
258258

259259
## Deleting Certificates and Private Keys
@@ -271,7 +271,7 @@ In the `Cert:` drive, the `Remove-Item` cmdlet supports only the **DeleteKey**,
271271
ignored.
272272

273273
```powershell
274-
Remove-Item cert:\LocalMachine\CA\5DDC44652E62BF9AA1116DC41DE44AB47C87BDD0
274+
Remove-Item Cert:\LocalMachine\CA\5DDC44652E62BF9AA1116DC41DE44AB47C87BDD0
275275
```
276276

277277
### Delete a Certificate using a wildcards in the DNS name
@@ -281,7 +281,7 @@ This command deletes all certificates that have a DNS name that contains
281281
get the certificates and the `Remove-Item` cmdlet to delete them.
282282

283283
```powershell
284-
Get-ChildItem -Path cert:\LocalMachine -DnsName *Fabrikam* | Remove-Item
284+
Get-ChildItem -Path Cert:\LocalMachine -DnsName *Fabrikam* | Remove-Item
285285
```
286286

287287
### Delete private keys from a remote computer
@@ -327,7 +327,7 @@ parameter to remove the private key along with the specified certificate.
327327
```powershell
328328
Invoke-Command -Session $s {
329329
$removeItemSplat = @{
330-
Path = 'cert:\LocalMachine\My\D2D38EBA60CAA1C12055A2E1C83B15AD450110C2'
330+
Path = 'Cert:\LocalMachine\My\D2D38EBA60CAA1C12055A2E1C83B15AD450110C2'
331331
DeleteKey = $true
332332
}
333333
Remove-Item @removeItemSplat
@@ -345,7 +345,7 @@ cmdlet, which deletes them. The command uses the **DeleteKey** parameter to
345345
delete the private key along with the certificate.
346346

347347
```powershell
348-
$expired = Get-ChildItem cert:\LocalMachine\WebHosting -ExpiringInDays 0
348+
$expired = Get-ChildItem Cert:\LocalMachine\WebHosting -ExpiringInDays 0
349349
$expired | Remove-Item -DeleteKey
350350
```
351351

@@ -367,7 +367,7 @@ This command creates a new certificate store named `CustomStore` in the
367367
`LocalMachine` store location.
368368

369369
```powershell
370-
New-Item -Path cert:\LocalMachine\CustomStore
370+
New-Item -Path Cert:\LocalMachine\CustomStore
371371
```
372372

373373
### Create a new certificate store on a remote computer
@@ -382,7 +382,7 @@ new certificate store.
382382

383383
```powershell
384384
Invoke-Command -ComputerName Server01 -ScriptBlock {
385-
New-Item -Path cert:\LocalMachine\CustomStore
385+
New-Item -Path Cert:\LocalMachine\CustomStore
386386
}
387387
```
388388

@@ -415,7 +415,7 @@ store.
415415

416416
```powershell
417417
Invoke-Command -ComputerName S1, S2 -ScriptBlock {
418-
Remove-Item -Path cert:\LocalMachine\TestStore -Recurse
418+
Remove-Item -Path Cert:\LocalMachine\TestStore -Recurse
419419
}
420420
```
421421

@@ -540,7 +540,7 @@ This parameter was introduced in PowerShell 3.0.
540540

541541
## Script properties
542542

543-
New script properties have been added to the **x509Certificate2** object that
543+
New script properties have been added to the **X509Certificate2** object that
544544
represents the certificates to make it easy to search and manage the
545545
certificates.
546546

@@ -581,7 +581,7 @@ Get-Help Get-ChildItem
581581
```
582582

583583
```powershell
584-
Get-Help Get-ChildItem -Path cert:
584+
Get-Help Get-ChildItem -Path Cert:
585585
```
586586

587587
## See also

reference/5.1/Microsoft.PowerShell.Security/Get-Acl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Get-Acl C:\Windows\s*.log | Format-List -Property PSPath, Sddl
6666

6767
The command uses the `Get-Acl` cmdlet to get objects representing the security descriptors of each
6868
log file. It uses a pipeline operator (`|`) to send the results to the `Format-List` cmdlet. The
69-
command uses the **Property** parameter of `Format-List` to display only the **PsPath** and **SDDL**
69+
command uses the **Property** parameter of `Format-List` to display only the **PSPath** and **SDDL**
7070
properties of each security descriptor object.
7171

7272
Lists are often used in PowerShell, because long values appear truncated in tables.
@@ -325,7 +325,7 @@ and access list, PowerShell displays the following properties and property value
325325
Descriptor Definition Language format. PowerShell uses the **GetSddlForm** method of security
326326
descriptors to get this data.
327327

328-
Because `Get-Acl` is supported by the file system and registry providers, you can use `Get-Acl` to
328+
Because `Get-Acl` is supported by the FileSystem and Registry providers, you can use `Get-Acl` to
329329
view the ACL of file system objects, such as files and directories, and registry objects, such as
330330
registry keys and entries.
331331

reference/5.1/Microsoft.PowerShell.Security/Get-Credential.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ the **Credential** parameter.
6161
### Example 2
6262

6363
```powershell
64-
$c = Get-Credential -credential User01
64+
$c = Get-Credential -Credential User01
6565
$c.Username
6666
User01
6767
```
@@ -75,7 +75,7 @@ object.
7575
### Example 3
7676

7777
```powershell
78-
$Credential = $Host.ui.PromptForCredential("Need credentials", "Please enter your user name and password.", "", "NetBiosUserName")
78+
$Credential = $Host.UI.PromptForCredential("Need credentials", "Please enter your user name and password.", "", "NetBiosUserName")
7979
```
8080

8181
This command uses the **PromptForCredential** method to prompt the user for their user name and

reference/5.1/Microsoft.PowerShell.Security/Protect-CmsMessage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,10 @@ PS C:\> cd Cert:\CurrentUser\My
110110
PS Cert:\CurrentUser\My> Get-ChildItem -DocumentEncryptionCert
111111
```
112112

113-
To view document encryption certificates in the certificate provider, you can add the
113+
To view document encryption certificates in the Certificate provider, you can add the
114114
**DocumentEncryptionCert** dynamic parameter of
115115
[Get-ChildItem](../Microsoft.PowerShell.Management/Get-ChildItem.md), available only when the
116-
certificate provider is loaded.
116+
Certificate provider is loaded.
117117

118118
## PARAMETERS
119119

@@ -193,7 +193,7 @@ Accept wildcard characters: False
193193
194194
Specifies one or more CMS message recipients, identified in any of the following formats:
195195
196-
- An actual certificate (as retrieved from the certificate provider).
196+
- An actual certificate (as retrieved from the Certificate provider).
197197
- Path to the file containing the certificate.
198198
- Path to a directory containing the certificate.
199199
- Thumbprint of the certificate (used to look in the certificate store).

reference/5.1/Microsoft.PowerShell.Security/Set-Acl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ The first command in the pipeline uses the Get-ChildItem cmdlet to get all of th
105105
`C:\Temp` directory. The **Recurse** parameter extends the command to all subdirectories of
106106
`C:\temp`. The **Include** parameter limits the files retrieved to those with the `.txt` file name
107107
extension. The **Force** parameter gets hidden files, which would otherwise be excluded. (You cannot
108-
use `c:\temp\*.txt`, because the **Recurse** parameter works on directories, not on files.)
108+
use `C:\temp\*.txt`, because the **Recurse** parameter works on directories, not on files.)
109109

110110
The pipeline operator (`|`) sends the objects representing the retrieved files to the `Set-Acl`
111111
cmdlet, which applies the security descriptor in the **AclObject** parameter to all of the files in
@@ -460,7 +460,7 @@ security object depends on the type of the item.
460460

461461
## NOTES
462462

463-
The `Set-Acl` cmdlet is supported by the PowerShell file system and registry providers. As such, you
463+
The `Set-Acl` cmdlet is supported by the PowerShell FileSystem and Registry providers. As such, you
464464
can use it to change the security descriptors of files, directories, and registry keys.
465465

466466
## RELATED LINKS

0 commit comments

Comments
 (0)