Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

10/31/2023 PM Publish #10604

Merged
merged 2 commits into from
Oct 31, 2023
Merged

10/31/2023 PM Publish #10604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a2abd9
Remove copy/paste error in description (#10600)
sdwheeler Oct 31, 2023
075cbf1
Fixes #10569 - Refactor descriptions of syntax (#10602)
sdwheeler Oct 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
332 changes: 152 additions & 180 deletions reference/5.1/Microsoft.PowerShell.Core/About/about_Command_Syntax.md
View file
Open in desktop

Large diffs are not rendered by default.

29 changes: 14 additions & 15 deletions reference/5.1/Microsoft.PowerShell.Management/Add-Content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Management
ms.date: 10/12/2023
ms.date: 10/31/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/add-content?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Add-Content
Expand Down Expand Up @@ -36,8 +36,7 @@ Add-Content [-Value] <Object[]> -LiteralPath <string[]> [-PassThru] [-Filter <st
## DESCRIPTION

The `Add-Content` cmdlet appends content to a specified item or file. Content can be passed in from
the pipeline or specified by using the **Value** parameter. By default, `Add-Content` overwrites the
existing content of an item. To append content to a file, use the **Append** parameter.
the pipeline or specified by using the **Value** parameter.

If you need to create files or directories for the following examples, see [New-Item](New-Item.md).

Expand Down Expand Up @@ -162,7 +161,7 @@ set to `False`.
### -Credential

> [!NOTE]
> This parameter is not supported by any providers installed with PowerShell.
> This parameter isn't supported by any providers installed with PowerShell.
> To impersonate another user, or elevate your credentials when running this cmdlet,
> use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md).

Expand Down Expand Up @@ -241,7 +240,7 @@ installed PowerShell provider that supports the use of filters. You can find the
**FileSystem** filter language in
[about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient
than other parameters, because the provider applies them when the cmdlet gets the objects rather
than having PowerShell filter the objects after they are retrieved.
than having PowerShell filter the objects after they're retrieved.

```yaml
Type: System.String
Expand All @@ -258,7 +257,7 @@ Accept wildcard characters: True
### -Force

Overrides the read-only attribute, allowing you to add content to a read-only file. For example,
**Force** overrides the read-only attribute but it does not change file permissions.
**Force** overrides the read-only attribute but it doesn't change file permissions.

```yaml
Type: System.Management.Automation.SwitchParameter
Expand Down Expand Up @@ -294,7 +293,7 @@ Accept wildcard characters: True

### -LiteralPath

Specifies a path to one or more locations. The value of **LiteralPath** is used exactly as it is
Specifies a path to one or more locations. The value of **LiteralPath** 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.
Expand All @@ -316,7 +315,7 @@ Accept wildcard characters: False

### -NoNewline

Indicates that this cmdlet does not add a new line or carriage return to the content.
Indicates that this cmdlet doesn't add a new line or carriage return to the content.

The string representations of the input objects are concatenated to form the output. No spaces or
newlines are inserted between the output strings. No newline is added after the last output string.
Expand All @@ -335,7 +334,7 @@ Accept wildcard characters: False

### -PassThru

Returns an object representing the added content. By default, this cmdlet does not generate any
Returns an object representing the added content. By default, this cmdlet doesn't generate any
output.

```yaml
Expand Down Expand Up @@ -371,14 +370,14 @@ Accept wildcard characters: True

### -Stream

Specifies an alternative data stream for content. If the stream does not exist, this cmdlet creates
it. Wildcard characters are not supported.
Specifies an alternative data stream for content. If the stream doesn't exist, this cmdlet creates
it. Wildcard characters aren't supported.

**Stream** is a dynamic parameter that the FileSystem provider adds to `Add-Content`. This
parameter works only in file system drives.

You can use the `Add-Content` cmdlet to change the content of any alternate data stream, such as
`Zone.Identifier`. However, we do not recommend this as a way to eliminate security checks that
`Zone.Identifier`. However, we don't recommend this as a way to eliminate security checks that
block files that are downloaded from the Internet. If you verify that a downloaded file is safe, use
the `Unblock-File` cmdlet.

Expand Down Expand Up @@ -419,7 +418,7 @@ Specifies the content to be added. Type a quoted string, such as **This data is
only**, or specify an object that contains content, such as the **DateTime** object that `Get-Date`
generates.

You cannot specify the contents of a file by typing its path, because the path is just a string.
You can't specify the contents of a file by typing its path, because the path is just a string.
You can use a `Get-Content` command to get the content and pass it to the **Value** parameter.

```yaml
Expand Down Expand Up @@ -452,7 +451,7 @@ Accept wildcard characters: False

### -WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Shows what would happen if the cmdlet runs. The cmdlet isn't run.

```yaml
Type: System.Management.Automation.SwitchParameter
Expand Down Expand Up @@ -500,7 +499,7 @@ Windows PowerShell includes the following aliases for `Add-Content`:

- `ac`

- When you pipe an object to `Add-Content`, the object is converted to a string before it is added
- When you pipe an object to `Add-Content`, the object is converted to a string before it's added
to the item. The object type determines the string format, but the format might be different than
the default display of the object. To control the string format, use the formatting parameters of
the sending cmdlet.
Expand Down
Loading