Skip to content

Commit 8962d0b

Browse files
authored
Sync changes to about_* articles (#11736)
1 parent f6c5d08 commit 8962d0b

File tree

118 files changed

+2030
-1693
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+2030
-1693
lines changed

reference/5.1/Microsoft.PowerShell.Core/About/About.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,8 @@ Describes the PowerShell debugger.
145145

146146
### [about_DesiredStateConfiguration](about_DesiredStateConfiguration.md)
147147

148-
Provides a brief introduction to the PowerShell Desired State Configuration (DSC) feature.
148+
Provides a brief introduction to the PowerShell Desired State Configuration
149+
(DSC) feature.
149150

150151
### [about_Do](about_Do.md)
151152

@@ -221,7 +222,8 @@ Describes the attribute that makes a function work like a compiled cmdlet.
221222

222223
### [about_Functions_OutputTypeAttribute](about_Functions_OutputTypeAttribute.md)
223224

224-
Describes an attribute that reports the type of object that the function returns.
225+
Describes an attribute that reports the type of object that the function
226+
returns.
225227

226228
### [about_Functions](about_Functions.md)
227229

@@ -370,7 +372,8 @@ Combining commands into pipelines in the PowerShell
370372

371373
### [about_PowerShell_exe](about_PowerShell_exe.md)
372374

373-
Explains how to use the `powershell.exe` command-line interface. Displays the command-line parameters and describes the syntax.
375+
Explains how to use the `powershell.exe` command-line interface. Displays the
376+
command-line parameters and describes the syntax.
374377

375378
### [about_PowerShell_Ise_exe](about_PowerShell_Ise_exe.md)
376379

@@ -630,20 +633,25 @@ Describes new features that are included in Windows PowerShell 5.1.
630633

631634
### [about_Windows_PowerShell_ISE](about_Windows_PowerShell_ISE.md)
632635

633-
Describes the features and system requirements of Windows PowerShell Integrated Scripting Environment (ISE).
636+
Describes the features and system requirements of Windows PowerShell Integrated
637+
Scripting Environment (ISE).
634638

635639
### [about_Windows_RT](about_Windows_RT.md)
636640

637641
Explains limitations of Windows PowerShell 4.0 on Windows RT 8.1.
638642

639643
### [about_WMI_Cmdlets](about_WMI_Cmdlets.md)
640644

641-
Provides background information about Windows Management Instrumentation (WMI) and Windows PowerShell.
645+
Provides background information about Windows Management Instrumentation (WMI)
646+
and Windows PowerShell.
642647

643648
### [about_WMI](about_WMI.md)
644649

645-
Windows Management Instrumentation (WMI) uses the Common Information Model (CIM) to represent systems, applications, networks, devices, and other manageable components of the modern enterprise.
650+
Windows Management Instrumentation (WMI) uses the Common Information Model
651+
(CIM) to represent systems, applications, networks, devices, and other
652+
manageable components of the modern enterprise.
646653

647654
### [about_WQL](about_WQL.md)
648655

649-
Describes WMI Query Language (WQL), which can be used to get WMI objects in Windows PowerShell.
656+
Describes WMI Query Language (WQL), which can be used to get WMI objects in
657+
Windows PowerShell.

reference/5.1/Microsoft.PowerShell.Core/About/about_PSSession_Details.md

+143-147
Large diffs are not rendered by default.

reference/5.1/Microsoft.PowerShell.Core/About/about_PSSessions.md

+80-68
Original file line numberDiff line numberDiff line change
@@ -11,78 +11,75 @@ title: about_PSSessions
1111

1212
## Short description
1313

14-
Describes Windows PowerShell sessions (PSSessions) and explains how to
15-
establish a persistent connection to a remote computer.
14+
Describes PowerShell sessions (PSSessions) and explains how to establish a
15+
persistent connection to a remote computer.
1616

1717
## Long description
1818

19-
To run Windows PowerShell commands on a remote computer, you can use the
20-
**ComputerName** parameter of a cmdlet, or you can create a Windows PowerShell
21-
session (PSSession) and run commands in the PSSession.
19+
To run PowerShell commands on a remote computer, you can use the
20+
**ComputerName** parameter of a cmdlet, or you can create a PowerShell session
21+
(PSSession) and run commands in the PSSession.
2222

23-
When you create a PSSession, Windows PowerShell establishes a persistent
24-
connection to the remote computer. Use a PSSession to run a series of related
25-
commands on a remote computer. Commands that run in the same PSSession can
26-
share data, such as the values of variables, aliases, and functions.
23+
When you create a PSSession, PowerShell establishes a persistent connection to
24+
the remote computer. Use a PSSession to run a series of related commands on a
25+
remote computer. Commands that run in the same PSSession can share data, such
26+
as the values of variables, aliases, and functions.
2727

2828
You can also create a PSSession on the local computer and run commands in it.
29-
A local PSSession uses the Windows PowerShell remoting infrastructure to
30-
create and maintain the PSSession.
29+
A local PSSession uses the PowerShell remoting infrastructure to create and
30+
maintain the PSSession.
3131

32-
Beginning in Windows PowerShell 3.0, PSSessions are independent of the
33-
sessions in which they are created. Active PSSessions are maintained on the
34-
remote computer (or the computer at the remote end or "server-side" of the
35-
connection). As a result, you can disconnect from the PSSession and reconnect
36-
to it at a later time from the same computer or from a different computer.
32+
Beginning in Windows PowerShell 3.0, PSSessions on Windows are independent
33+
of the sessions in which they are created. Active PSSessions are maintained
34+
on the remote computer (or the computer at the remote end or "server-side"
35+
of the connection). As a result, on Windows you can disconnect from a PSSession
36+
on a remote Windows computer and reconnect to it at a later time from the
37+
same computer or from a different Windows computer.
3738

3839
This topic explains how to create, use, get, and delete PSSessions. For more
39-
advanced information, see
40-
[about_PSSession_Details](about_PSSession_Details.md).
40+
advanced information, see [about_PSSession_Details][01].
4141

42-
Note: PSSessions use the Windows PowerShell remoting infrastructure. To use
43-
PSSessions, the local and remote computers must be configured for remoting.
44-
For more information, see
45-
[about_Remote_Requirements](about_Remote_Requirements.md).
42+
Note: PSSessions use the PowerShell remoting infrastructure. To use PSSessions,
43+
the local and remote computers must be configured for remoting. For more
44+
information, see [about_Remote_Requirements][02].
4645

4746
In Windows Vista and later versions of Windows, to create a PSSession on a
48-
local computer, you must start Windows PowerShell with the "Run as
49-
administrator" option.
47+
local computer, you must start PowerShell with the "Run as administrator"
48+
option.
5049

5150
## What Is a Session?
5251

53-
A session is an environment in which Windows PowerShell runs.
52+
A session is an environment in which PowerShell runs.
5453

55-
Each time you start Windows PowerShell, a session is created for you, and you
56-
can run commands in the session. You can also add items to your session, such
57-
as modules and snap-ins, and you can create items, such as variables,
58-
functions, and aliases. These items exist only in the session and are deleted
59-
when the session ends.
54+
Each time you start PowerShell, a session is created for you, and you can run
55+
commands in the session. You can also add items to your session, such as
56+
modules and snap-ins, and you can create items, such as variables, functions,
57+
and aliases. These items exist only in the session and are deleted when the
58+
session ends.
6059

61-
You can also create user-managed sessions, known as " Windows PowerShell
62-
sessions" or "PSSessions," on the local computer or on a remote computer. Like
63-
the default session, you can run commands in a PSSession and add and create
64-
items. However, unlike the session that starts automatically, you can control
65-
the PSSessions that you create. You can get, create, configure, and remove
66-
them, disconnect and reconnect to them, and run multiple commands in the same
67-
PSSession. The PSSession remains available until you delete it or it times
68-
out.
60+
You can also create user-managed sessions, known as "PowerShell sessions" or
61+
"PSSessions," on the local computer or on a remote computer. Like the default
62+
session, you can run commands in a PSSession and add and create items.
63+
However, unlike the session that starts automatically, you can control the
64+
PSSessions that you create. You can get, create, configure, and remove them,
65+
disconnect and reconnect to them, and run multiple commands in the same
66+
PSSession. The PSSession remains available until you delete it or it times out.
6967

7068
Typically, you create a PSSession to run a series of related commands on a
71-
remote computer. When you create a PSSession on a remote computer, Windows
72-
PowerShell establishes a persistent connection to the remote computer to
73-
support the session.
69+
remote computer. When you create a PSSession on a remote computer, PowerShell
70+
establishes a persistent connection to the remote computer to support the
71+
session.
7472

7573
If you use the **ComputerName** parameter of the `Invoke-Command` or
7674
`Enter-PSSession` cmdlet to run a remote command or to start an interactive
77-
session, Windows PowerShell creates a temporary session on the remote computer
78-
and closes the session as soon as the command is complete or as soon as the
75+
session, PowerShell creates a temporary session on the remote computer and
76+
closes the session as soon as the command is complete or as soon as the
7977
interactive session ends. You cannot control these temporary sessions, and you
80-
cannot use them for more than a single command or a single interactive
81-
session.
78+
cannot use them for more than a single command or a single interactive session.
8279

83-
In Windows PowerShell, the "current session" is the session that you are
84-
working in. The "current session" can refer to any session, including a
85-
temporary session or a PSSession.
80+
In PowerShell, the "current session" is the session that you are working in.
81+
The "current session" can refer to any session, including a temporary session
82+
or a PSSession.
8683

8784
## Why Use a PSSession?
8885

@@ -96,10 +93,9 @@ You can run remote commands without creating a PSSession. Use the
9693
or a series of unrelated commands on one or many computers.
9794

9895
When you use the **ComputerName** parameter of `Invoke-Command` or
99-
`Enter-PSSession`, Windows PowerShell establishes a temporary connection to
100-
the remote computer and then closes the connection as soon as the command is
101-
complete. Any data elements that you create are lost when the connection is
102-
closed.
96+
`Enter-PSSession`, PowerShell establishes a temporary connection to the remote
97+
computer and then closes the connection as soon as the command is complete.
98+
Any data elements that you create are lost when the connection is closed.
10399

104100
Other cmdlets that have a **ComputerName** parameter, such as `Get-Eventlog`
105101
and `Get-WmiObject`, use different remoting technologies to gather data. None
@@ -108,8 +104,8 @@ create a persistent connection like a PSSession.
108104
## How to Create a PSSession
109105

110106
To create a PSSession, use the `New-PSSession` cmdlet. To create the PSSession
111-
on a remote computer, use the **ComputerName** parameter of the
112-
`New-PSSession` cmdlet.
107+
on a remote computer, use the **ComputerName** parameter of the `New-PSSession`
108+
cmdlet.
113109

114110
For example, the following command creates a new PSSession on the Server01
115111
computer.
@@ -151,7 +147,8 @@ To get the PSSessions that were created in your current session, use the
151147
`Get-PSSession` cmdlet without the **ComputerName** parameter. `Get-PSSession`
152148
returns the same type of object that `New-PSSession` returns.
153149

154-
The following command gets all the PSSessions that were created in the current session.
150+
The following command gets all the PSSessions that were created in the current
151+
session.
155152

156153
```powershell
157154
Get-PSSession
@@ -239,7 +236,7 @@ until it times out.
239236

240237
You can also use the **IdleTimeout** parameter of the `New-PSSessionOption`
241238
cmdlet to set an expiration time for an idle PSSession. For more information,
242-
see [New-PSSessionOption](xref:Microsoft.PowerShell.Core.New-PSSessionOption).
239+
see [New-PSSessionOption][03].
243240

244241
## The PSSession Cmdlets
245242

@@ -261,18 +258,33 @@ Get-Help *-PSSession
261258

262259
## For More Information
263260

264-
For more information about PSSessions, see [about_PSSession_Details](about_PSSession_Details.md).
261+
For more information about PSSessions, see [about_PSSession_Details][01].
265262

266263
## See also
267264

268-
- [about_Remote](about_Remote.md)
269-
- [about_Remote_Disconnected_Sessions](about_Remote_Disconnected_Sessions.md)
270-
- [about_Remote_Requirements](about_Remote_Requirements.md)
271-
- [Invoke-Command](xref:Microsoft.PowerShell.Core.Invoke-Command)
272-
- [Connect-PSSession](xref:Microsoft.PowerShell.Core.Connect-PSSession)
273-
- [Disconnect-PSSession](xref:Microsoft.PowerShell.Core.Disconnect-PSSession)
274-
- [Enter-PSSession](xref:Microsoft.PowerShell.Core.Enter-PSSession)
275-
- [Exit-PSSession](xref:Microsoft.PowerShell.Core.Exit-PSSession)
276-
- [Get-PSSession](xref:Microsoft.PowerShell.Core.Get-PSSession)
277-
- [New-PSSession](xref:Microsoft.PowerShell.Core.New-PSSession)
278-
- [Remove-PSSession](xref:Microsoft.PowerShell.Core.Remove-PSSession)
265+
- [about_Remote][05]
266+
- [about_Remote_Disconnected_Sessions][04]
267+
- [about_Remote_Requirements][02]
268+
- [Invoke-Command][06]
269+
- [Connect-PSSession][07]
270+
- [Disconnect-PSSession][08]
271+
- [Enter-PSSession][09]
272+
- [Exit-PSSession][10]
273+
- [Get-PSSession][11]
274+
- [New-PSSession][12]
275+
- [Remove-PSSession][13]
276+
277+
<!-- link references -->
278+
[01]: about_PSSession_Details.md
279+
[02]: about_Remote_Requirements.md
280+
[03]: xref:Microsoft.PowerShell.Core.New-PSSessionOption
281+
[04]: about_Remote_Disconnected_Sessions.md
282+
[05]: about_Remote.md
283+
[06]: xref:Microsoft.PowerShell.Core.Invoke-Command
284+
[07]: xref:Microsoft.PowerShell.Core.Connect-PSSession
285+
[08]: xref:Microsoft.PowerShell.Core.Disconnect-PSSession
286+
[09]: xref:Microsoft.PowerShell.Core.Enter-PSSession
287+
[10]: xref:Microsoft.PowerShell.Core.Exit-PSSession
288+
[11]: xref:Microsoft.PowerShell.Core.Get-PSSession
289+
[12]: xref:Microsoft.PowerShell.Core.New-PSSession
290+
[13]: xref:Microsoft.PowerShell.Core.Remove-PSSession

reference/5.1/Microsoft.PowerShell.Core/About/about_Quoting_Rules.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ title: about_Quoting_Rules
99
# about_Quoting_Rules
1010

1111
## Short description
12+
1213
Describes rules for using single and double quotation marks in PowerShell.
1314

1415
## Long description
@@ -464,7 +465,7 @@ For more information about this behavior, see the [about_Parsing][03] article.
464465
[01]: #including-quote-characters-in-a-string
465466
[02]: about_Parsing.md#argument-mode
466467
[03]: about_Parsing.md#passing-arguments-that-contain-quote-characters
467-
[04]: about_preference_variables.md#ofs
468+
[04]: about_Preference_Variables.md#ofs
468469
[05]: about_Special_Characters.md
469470
[06]: https://en.wikipedia.org/wiki/Quotation_marks_in_English#Smart_quotes
470471
[07]: xref:Microsoft.PowerShell.Utility.ConvertFrom-StringData

reference/5.1/Microsoft.PowerShell.Core/About/about_Redirection.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,14 @@ title: about_Redirection
99
# about_Redirection
1010

1111
## Short description
12+
1213
Explains how to redirect output from PowerShell to text files.
1314

1415
## Long description
1516

1617
By default, PowerShell sends output to the PowerShell host. Usually this is the
17-
console application. However, you can redirect the output to a text file and you
18-
can redirect error output to the regular output stream.
18+
console application. However, you can redirect the output to a text file and
19+
you can redirect error output to the regular output stream.
1920

2021
You can use the following methods to redirect output:
2122

@@ -26,9 +27,11 @@ You can use the following methods to redirect output:
2627
- Use the `Tee-Object` cmdlet, which sends command output to a text file and
2728
then sends it to the pipeline.
2829

29-
- Use the PowerShell redirection operators. Using the redirection operator with
30-
a file target is functionally equivalent to piping to `Out-File` with no
31-
extra parameters.
30+
- Use the PowerShell redirection operators. Redirecting the output of a
31+
PowerShell command (cmdlet, function, script) using the redirection operator
32+
(`>`) is functionally equivalent to piping to `Out-File` with no extra
33+
parameters.
34+
3235

3336
For more information about streams, see [about_Output_Streams][04].
3437

@@ -142,27 +145,27 @@ particular stream. The script in this example shows how the value of
142145
```powershell
143146
$ErrorActionPreference = 'Continue'
144147
$ErrorActionPreference > log.txt
145-
get-item /not-here 2>&1 >> log.txt
148+
Get-Item /not-here 2>&1 >> log.txt
146149
147150
$ErrorActionPreference = 'SilentlyContinue'
148151
$ErrorActionPreference >> log.txt
149-
get-item /not-here 2>&1 >> log.txt
152+
Get-Item /not-here 2>&1 >> log.txt
150153
151154
$ErrorActionPreference = 'Stop'
152155
$ErrorActionPreference >> log.txt
153156
Try {
154-
get-item /not-here 2>&1 >> log.txt
157+
Get-Item /not-here 2>&1 >> log.txt
155158
}
156159
catch {
157160
"`tError caught!" >> log.txt
158161
}
159162
$ErrorActionPreference = 'Ignore'
160163
$ErrorActionPreference >> log.txt
161-
get-item /not-here 2>&1 >> log.txt
164+
Get-Item /not-here 2>&1 >> log.txt
162165
163166
$ErrorActionPreference = 'Inquire'
164167
$ErrorActionPreference >> log.txt
165-
get-item /not-here 2>&1 >> log.txt
168+
Get-Item /not-here 2>&1 >> log.txt
166169
167170
$ErrorActionPreference = 'Continue'
168171
```
@@ -340,7 +343,7 @@ used. For more information, see the `-gt` operator in
340343
[03]: about_Operators.md
341344
[04]: about_Output_Streams.md
342345
[05]: about_Path_Syntax.md
343-
[06]: about_preference_variables.md#psdefaultparametervalues
346+
[06]: about_Preference_Variables.md#psdefaultparametervalues
344347
[07]: xref:Microsoft.PowerShell.Utility.Out-File
345348
[08]: xref:Microsoft.PowerShell.Utility.Tee-Object
346349
[09]: xref:Microsoft.PowerShell.Utility.Write-Debug

0 commit comments

Comments
 (0)