From d78f17345ee9991024bfd16a9ae89f7622cd8d12 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 4 Jan 2024 10:11:43 -0600 Subject: [PATCH] Update transcript file information --- .../About/about_Preference_Variables.md | 8 +++--- .../Start-Transcript.md | 23 +++++++++-------- .../Stop-Transcript.md | 4 +-- .../About/about_Preference_Variables.md | 11 +++++--- .../Start-Transcript.md | 25 +++++++++++-------- .../Stop-Transcript.md | 4 +-- .../About/about_Preference_Variables.md | 11 +++++--- .../Start-Transcript.md | 25 +++++++++++-------- .../Stop-Transcript.md | 4 +-- .../About/about_Preference_Variables.md | 11 +++++--- .../Start-Transcript.md | 25 +++++++++++-------- .../Stop-Transcript.md | 4 +-- 12 files changed, 95 insertions(+), 60 deletions(-) diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/about_Preference_Variables.md b/reference/5.1/Microsoft.PowerShell.Core/About/about_Preference_Variables.md index 339ba7facb0d..a39687f0aca0 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/about_Preference_Variables.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/about_Preference_Variables.md @@ -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 @@ -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..txt` files. +transcripts in the following location using the default name. + +- Default location: `$HOME\Documents` +- Default filename: `PowerShell_transcript....txt` ## $VerbosePreference diff --git a/reference/5.1/Microsoft.PowerShell.Host/Start-Transcript.md b/reference/5.1/Microsoft.PowerShell.Host/Start-Transcript.md index 48a53cd2c989..82de8fc549f5 100644 --- a/reference/5.1/Microsoft.PowerShell.Host/Start-Transcript.md +++ b/reference/5.1/Microsoft.PowerShell.Host/Start-Transcript.md @@ -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 @@ -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....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 @@ -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..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 diff --git a/reference/5.1/Microsoft.PowerShell.Host/Stop-Transcript.md b/reference/5.1/Microsoft.PowerShell.Host/Stop-Transcript.md index cf014b71ad4b..75012074360b 100644 --- a/reference/5.1/Microsoft.PowerShell.Host/Stop-Transcript.md +++ b/reference/5.1/Microsoft.PowerShell.Host/Stop-Transcript.md @@ -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 @@ -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 diff --git a/reference/7.2/Microsoft.PowerShell.Core/About/about_Preference_Variables.md b/reference/7.2/Microsoft.PowerShell.Core/About/about_Preference_Variables.md index b894f1be754d..9b3081868523 100644 --- a/reference/7.2/Microsoft.PowerShell.Core/About/about_Preference_Variables.md +++ b/reference/7.2/Microsoft.PowerShell.Core/About/about_Preference_Variables.md @@ -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 @@ -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..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....txt`. ## $VerbosePreference diff --git a/reference/7.2/Microsoft.PowerShell.Host/Start-Transcript.md b/reference/7.2/Microsoft.PowerShell.Host/Start-Transcript.md index 1319cabbce3c..f4eace45e8f7 100644 --- a/reference/7.2/Microsoft.PowerShell.Host/Start-Transcript.md +++ b/reference/7.2/Microsoft.PowerShell.Host/Start-Transcript.md @@ -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 @@ -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....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. @@ -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..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 diff --git a/reference/7.2/Microsoft.PowerShell.Host/Stop-Transcript.md b/reference/7.2/Microsoft.PowerShell.Host/Stop-Transcript.md index 494aa73c9275..f5925f2e01d1 100644 --- a/reference/7.2/Microsoft.PowerShell.Host/Stop-Transcript.md +++ b/reference/7.2/Microsoft.PowerShell.Host/Stop-Transcript.md @@ -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 @@ -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 diff --git a/reference/7.3/Microsoft.PowerShell.Core/About/about_Preference_Variables.md b/reference/7.3/Microsoft.PowerShell.Core/About/about_Preference_Variables.md index 7065a77500fd..342538fd999d 100644 --- a/reference/7.3/Microsoft.PowerShell.Core/About/about_Preference_Variables.md +++ b/reference/7.3/Microsoft.PowerShell.Core/About/about_Preference_Variables.md @@ -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 @@ -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..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....txt`. ## $VerbosePreference diff --git a/reference/7.3/Microsoft.PowerShell.Host/Start-Transcript.md b/reference/7.3/Microsoft.PowerShell.Host/Start-Transcript.md index 2336d6c45a2f..033cf3cee535 100644 --- a/reference/7.3/Microsoft.PowerShell.Host/Start-Transcript.md +++ b/reference/7.3/Microsoft.PowerShell.Host/Start-Transcript.md @@ -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 @@ -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....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. @@ -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..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 diff --git a/reference/7.3/Microsoft.PowerShell.Host/Stop-Transcript.md b/reference/7.3/Microsoft.PowerShell.Host/Stop-Transcript.md index 1a9902a6e69a..547fd39f1d5b 100644 --- a/reference/7.3/Microsoft.PowerShell.Host/Stop-Transcript.md +++ b/reference/7.3/Microsoft.PowerShell.Host/Stop-Transcript.md @@ -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 @@ -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 diff --git a/reference/7.4/Microsoft.PowerShell.Core/About/about_Preference_Variables.md b/reference/7.4/Microsoft.PowerShell.Core/About/about_Preference_Variables.md index 413f5837d11b..a711c1d2c331 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/About/about_Preference_Variables.md +++ b/reference/7.4/Microsoft.PowerShell.Core/About/about_Preference_Variables.md @@ -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 @@ -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..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....txt`. ## $VerbosePreference diff --git a/reference/7.4/Microsoft.PowerShell.Host/Start-Transcript.md b/reference/7.4/Microsoft.PowerShell.Host/Start-Transcript.md index 4be65785be62..f673d918cd2b 100644 --- a/reference/7.4/Microsoft.PowerShell.Host/Start-Transcript.md +++ b/reference/7.4/Microsoft.PowerShell.Host/Start-Transcript.md @@ -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 @@ -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....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. @@ -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..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 diff --git a/reference/7.4/Microsoft.PowerShell.Host/Stop-Transcript.md b/reference/7.4/Microsoft.PowerShell.Host/Stop-Transcript.md index a9300f66d4ad..0266607bf627 100644 --- a/reference/7.4/Microsoft.PowerShell.Host/Stop-Transcript.md +++ b/reference/7.4/Microsoft.PowerShell.Host/Stop-Transcript.md @@ -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 @@ -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