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.

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

Update transcript file information #10767

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Variables that customize the behavior of PowerShell.
Locale: en-US
ms.date: 12/07/2023
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_preference_variables?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about Preference Variables
Expand Down Expand Up @@ -1242,8 +1242,10 @@ Used by `Start-Transcript` to specify the name and location of the transcript
file. If you don't specify a value for the **Path** parameter,
`Start-Transcript` uses the path in the value of the `$Transcript` global
variable. If you haven't created this variable, `Start-Transcript` stores the
transcripts in the `$HOME\My Documents` directory as
`\PowerShell_transcript.<time-stamp>.txt` files.
transcripts in the following location using the default name.

- Default location: `$HOME\Documents`
- Default filename: `PowerShell_transcript.<computername>.<random>.<timestamp>.txt`

## $VerbosePreference

Expand Down
23 changes: 13 additions & 10 deletions reference/5.1/Microsoft.PowerShell.Host/Start-Transcript.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.ConsoleHost.dll-help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 12/12/2022
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.host/start-transcript?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Start-Transcript
Expand Down Expand Up @@ -41,12 +41,17 @@ The `Start-Transcript` cmdlet creates a record of all or part of a PowerShell se
file. The transcript includes all command that the user types and all output that appears on the
console.

By default, `Start-Transcript` stores the transcript in the following location using the default
name:

- Default location: `$HOME\Documents`
- Default filename: `PowerShell_transcript.<computername>.<random>.<timestamp>.txt`

Starting in Windows PowerShell 5.0, `Start-Transcript` includes the hostname in the generated file
name of all transcripts. This is especially useful when your enterprise's logging is centralized.
Files that are created by the `Start-Transcript` cmdlet include random characters in names to
prevent potential overwrites or duplication when two or more transcripts are started simultaneously.
This also prevents unauthorized discovery of transcripts that are stored in a centralized file
share.
name of all transcripts. The filename also includes random characters in names to prevent potential
overwrites or duplication when two or more transcripts are started simultaneously. Including the
computer name is useful if you store your transcripts in a centralized location. The random
character string prevents guessing of the filename to gain unauthorized access to the file.

When using the **Append** parameter, if the target file doesn't have a Byte Order Mark (BOM)
`Start-Transcript` defaults to `ASCII` encoding in the target file. This behavior can result in
Expand Down Expand Up @@ -203,13 +208,11 @@ Accept wildcard characters: False
### -Path

Specifies a location to the transcript file. Enter a path to a `.txt` file. Wildcards aren't
permitted.
permitted. If any of the directories in the path don't exist, the command fails.

If you don't specify a path, `Start-Transcript` uses the path in the value of the `$Transcript`
global variable. If you haven't created this variable, `Start-Transcript` stores the transcripts in
the `$HOME\My Documents directory as \PowerShell_transcript.<time-stamp>.txt` files.

If any of the directories in the path don't exist, the command fails.
the default location and filename.

```yaml
Type: System.String
Expand Down
4 changes: 2 additions & 2 deletions reference/5.1/Microsoft.PowerShell.Host/Stop-Transcript.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.ConsoleHost.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 12/12/2022
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.host/stop-transcript?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Stop-Transcript
Expand Down Expand Up @@ -57,7 +57,7 @@ This cmdlet returns a string that contains a status message and the path to the

## NOTES

- If a transcript has not been started, the command fails.
If a transcript hasn't been started, the command fails.

## RELATED LINKS

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Variables that customize the behavior of PowerShell.
Locale: en-US
ms.date: 12/07/2023
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_preference_variables?view=powershell-7.2&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about Preference Variables
Expand Down Expand Up @@ -1198,8 +1198,13 @@ Used by `Start-Transcript` to specify the name and location of the transcript
file. If you don't specify a value for the **Path** parameter,
`Start-Transcript` uses the path in the value of the `$Transcript` global
variable. If you haven't created this variable, `Start-Transcript` stores the
transcripts in the `$HOME\My Documents` directory as
`\PowerShell_transcript.<time-stamp>.txt` files.
transcripts in the following location using the default name:

- On Windows: `$HOME\Documents`
- On Linux or macOS: `$HOME`

The default filename is:
`PowerShell_transcript.<computername>.<random>.<timestamp>.txt`.

## $VerbosePreference

Expand Down
25 changes: 15 additions & 10 deletions reference/7.2/Microsoft.PowerShell.Host/Start-Transcript.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.ConsoleHost.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 09/20/2023
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.host/start-transcript?view=powershell-7.2&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Start-Transcript
Expand Down Expand Up @@ -41,12 +41,19 @@ The `Start-Transcript` cmdlet creates a record of all or part of a PowerShell se
file. The transcript includes all command that the user types and all output that appears on the
console.

By default, `Start-Transcript` stores the transcript in the following location using the default
name:

- On Window: `$HOME\Documents`
- On Linux or macOS: `$HOME`

The default filename is `PowerShell_transcript.<computername>.<random>.<timestamp>.txt`.

Starting in Windows PowerShell 5.0, `Start-Transcript` includes the hostname in the generated file
name of all transcripts. This is especially useful when your enterprise's logging is centralized.
Files that are created by the `Start-Transcript` cmdlet include random characters in names to
prevent potential overwrites or duplication when two or more transcripts are started simultaneously.
This also prevents unauthorized discovery of transcripts that are stored in a centralized file
share.
name of all transcripts. The filename also includes random characters in names to prevent potential
overwrites or duplication when two or more transcripts are started simultaneously. Including the
computer name is useful if you store your transcripts in a centralized location. The random
character string prevents guessing of the filename to gain unauthorized access to the file.

If the target file doesn't have a Byte Order Mark (BOM), `Start-Transcript` defaults to `Utf8NoBom`
encoding in the target file.
Expand Down Expand Up @@ -202,13 +209,11 @@ Accept wildcard characters: False
### -Path

Specifies a location to the transcript file. Enter a path to a `.txt` file. Wildcards aren't
permitted.
permitted. If any of the directories in the path don't exist, the command fails.

If you don't specify a path, `Start-Transcript` uses the path in the value of the `$Transcript`
global variable. If you haven't created this variable, `Start-Transcript` stores the transcripts in
the `$HOME\My Documents directory as \PowerShell_transcript.<time-stamp>.txt` files.

If any of the directories in the path don't exist, the command fails.
the default location and filename.

```yaml
Type: System.String
Expand Down
4 changes: 2 additions & 2 deletions reference/7.2/Microsoft.PowerShell.Host/Stop-Transcript.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.ConsoleHost.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 12/12/2022
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.host/stop-transcript?view=powershell-7.2&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Stop-Transcript
Expand Down Expand Up @@ -57,7 +57,7 @@ This cmdlet returns a string that contains a status message and the path to the

## NOTES

- If a transcript has not been started, the command fails.
If a transcript hasn't been started, the command fails.

## RELATED LINKS

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Variables that customize the behavior of PowerShell.
Locale: en-US
ms.date: 12/07/2023
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_preference_variables?view=powershell-7.3&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about Preference Variables
Expand Down Expand Up @@ -1231,8 +1231,13 @@ Used by `Start-Transcript` to specify the name and location of the transcript
file. If you don't specify a value for the **Path** parameter,
`Start-Transcript` uses the path in the value of the `$Transcript` global
variable. If you haven't created this variable, `Start-Transcript` stores the
transcripts in the `$HOME\My Documents` directory as
`\PowerShell_transcript.<time-stamp>.txt` files.
transcripts in the following location using the default name:

- On Windows: `$HOME\Documents`
- On Linux or macOS: `$HOME`

The default filename is:
`PowerShell_transcript.<computername>.<random>.<timestamp>.txt`.

## $VerbosePreference

Expand Down
25 changes: 15 additions & 10 deletions reference/7.3/Microsoft.PowerShell.Host/Start-Transcript.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.ConsoleHost.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 09/20/2023
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.host/start-transcript?view=powershell-7.3&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Start-Transcript
Expand Down Expand Up @@ -41,12 +41,19 @@ The `Start-Transcript` cmdlet creates a record of all or part of a PowerShell se
file. The transcript includes all command that the user types and all output that appears on the
console.

By default, `Start-Transcript` stores the transcript in the following location using the default
name:

- On Window: `$HOME\Documents`
- On Linux or macOS: `$HOME`

The default filename is `PowerShell_transcript.<computername>.<random>.<timestamp>.txt`.

Starting in Windows PowerShell 5.0, `Start-Transcript` includes the hostname in the generated file
name of all transcripts. This is especially useful when your enterprise's logging is centralized.
Files that are created by the `Start-Transcript` cmdlet include random characters in names to
prevent potential overwrites or duplication when two or more transcripts are started simultaneously.
This also prevents unauthorized discovery of transcripts that are stored in a centralized file
share.
name of all transcripts. The filename also includes random characters in names to prevent potential
overwrites or duplication when two or more transcripts are started simultaneously. Including the
computer name is useful if you store your transcripts in a centralized location. The random
character string prevents guessing of the filename to gain unauthorized access to the file.

If the target file doesn't have a Byte Order Mark (BOM), `Start-Transcript` defaults to `Utf8NoBom`
encoding in the target file.
Expand Down Expand Up @@ -202,13 +209,11 @@ Accept wildcard characters: False
### -Path

Specifies a location to the transcript file. Enter a path to a `.txt` file. Wildcards aren't
permitted.
permitted. If any of the directories in the path don't exist, the command fails.

If you don't specify a path, `Start-Transcript` uses the path in the value of the `$Transcript`
global variable. If you haven't created this variable, `Start-Transcript` stores the transcripts in
the `$HOME\My Documents directory as \PowerShell_transcript.<time-stamp>.txt` files.

If any of the directories in the path don't exist, the command fails.
the default location and filename.

```yaml
Type: System.String
Expand Down
4 changes: 2 additions & 2 deletions reference/7.3/Microsoft.PowerShell.Host/Stop-Transcript.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.ConsoleHost.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 12/12/2022
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.host/stop-transcript?view=powershell-7.3&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Stop-Transcript
Expand Down Expand Up @@ -57,7 +57,7 @@ This cmdlet returns a string that contains a status message and the path to the

## NOTES

- If a transcript has not been started, the command fails.
If a transcript hasn't been started, the command fails.

## RELATED LINKS

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Variables that customize the behavior of PowerShell.
Locale: en-US
ms.date: 01/02/2024
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_preference_variables?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about Preference Variables
Expand Down Expand Up @@ -1223,8 +1223,13 @@ Used by `Start-Transcript` to specify the name and location of the transcript
file. If you don't specify a value for the **Path** parameter,
`Start-Transcript` uses the path in the value of the `$Transcript` global
variable. If you haven't created this variable, `Start-Transcript` stores the
transcripts in the `$HOME\My Documents` directory as
`\PowerShell_transcript.<time-stamp>.txt` files.
transcripts in the following location using the default name:

- On Windows: `$HOME\Documents`
- On Linux or macOS: `$HOME`

The default filename is:
`PowerShell_transcript.<computername>.<random>.<timestamp>.txt`.

## $VerbosePreference

Expand Down
25 changes: 15 additions & 10 deletions reference/7.4/Microsoft.PowerShell.Host/Start-Transcript.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.ConsoleHost.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 09/20/2023
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.host/start-transcript?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Start-Transcript
Expand Down Expand Up @@ -41,12 +41,19 @@ The `Start-Transcript` cmdlet creates a record of all or part of a PowerShell se
file. The transcript includes all command that the user types and all output that appears on the
console.

By default, `Start-Transcript` stores the transcript in the following location using the default
name:

- On Window: `$HOME\Documents`
- On Linux or macOS: `$HOME`

The default filename is `PowerShell_transcript.<computername>.<random>.<timestamp>.txt`.

Starting in Windows PowerShell 5.0, `Start-Transcript` includes the hostname in the generated file
name of all transcripts. This is especially useful when your enterprise's logging is centralized.
Files that are created by the `Start-Transcript` cmdlet include random characters in names to
prevent potential overwrites or duplication when two or more transcripts are started simultaneously.
This also prevents unauthorized discovery of transcripts that are stored in a centralized file
share.
name of all transcripts. The filename also includes random characters in names to prevent potential
overwrites or duplication when two or more transcripts are started simultaneously. Including the
computer name is useful if you store your transcripts in a centralized location. The random
character string prevents guessing of the filename to gain unauthorized access to the file.

If the target file doesn't have a Byte Order Mark (BOM), `Start-Transcript` defaults to `Utf8NoBom`
encoding in the target file.
Expand Down Expand Up @@ -202,13 +209,11 @@ Accept wildcard characters: False
### -Path

Specifies a location to the transcript file. Enter a path to a `.txt` file. Wildcards aren't
permitted.
permitted. If any of the directories in the path don't exist, the command fails.

If you don't specify a path, `Start-Transcript` uses the path in the value of the `$Transcript`
global variable. If you haven't created this variable, `Start-Transcript` stores the transcripts in
the `$HOME\My Documents directory as \PowerShell_transcript.<time-stamp>.txt` files.

If any of the directories in the path don't exist, the command fails.
the default location and filename.

```yaml
Type: System.String
Expand Down
4 changes: 2 additions & 2 deletions reference/7.4/Microsoft.PowerShell.Host/Stop-Transcript.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.ConsoleHost.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 01/03/2023
ms.date: 01/04/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.host/stop-transcript?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Stop-Transcript
Expand Down Expand Up @@ -93,7 +93,7 @@ This cmdlet returns a string that contains a status message and the path to the

## NOTES

- If a transcript has not been started, the command fails.
If a transcript hasn't been started, the command fails.

## RELATED LINKS

Expand Down