Skip to content

Fixes #12485 - Explain use of relative output paths #12488

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

Merged
merged 1 commit into from
Nov 5, 2025
Merged

Fixes #12485 - Explain use of relative output paths #12488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 16 additions & 2 deletions reference/5.1/Microsoft.PowerShell.Host/Start-Transcript.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.ConsoleHost.dll-help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 01/06/2025
ms.date: 11/05/2025
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 @@ -98,6 +98,19 @@ Start-Transcript
The full path to the transcript file is stored in the `$Transcript` preference variable. For more
information about the `$Transcript` preference variable, see
[about_Preference_Variables](../Microsoft.PowerShell.Core/About/about_Preference_Variables.md#transcript).
### Example 4: Start a transcript using a relative path on Windows systems

When you use a relative path with the **OutputDirectory** parameter on Windows, the path is relative
to your `Documents` directory.

```powershell
Start-Transcript -Path .\transcripts
```

```Output
Transcript started, output file is C:\Users\username\Documents\.\transcripts\PowerShell_transcript.HOSTNAME.8S6RpEfN.20251105152247.txt
```


## PARAMETERS

Expand Down Expand Up @@ -191,7 +204,8 @@ Accept wildcard characters: False
### -OutputDirectory

Specifies a specific path and folder in which to save a transcript. PowerShell automatically assigns
the transcript name.
the transcript name. If you use a relative path, the path is relative to your `Documents` directory
on Windows.

```yaml
Type: System.String
Expand Down
31 changes: 29 additions & 2 deletions reference/7.4/Microsoft.PowerShell.Host/Start-Transcript.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.ConsoleHost.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 01/06/2025
ms.date: 11/05/2025
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 @@ -100,6 +100,32 @@ The full path to the transcript file is stored in the `$Transcript` preference v
information about the `$Transcript` preference variable, see
[about_Preference_Variables](../Microsoft.PowerShell.Core/About/about_Preference_Variables.md#transcript).

### Example 4: Start a transcript using a relative path on Windows systems

When you use a relative path with the **OutputDirectory** parameter on Windows, the path is relative
to your `Documents` directory.

```powershell
Start-Transcript -Path .\transcripts
```

```Output
Transcript started, output file is C:\Users\username\Documents\.\transcripts\PowerShell_transcript.HOSTNAME.8S6RpEfN.20251105152247.txt
```

### Example 5: Start a transcript using a relative path on non-Windows systems

When you use a relative path with the **OutputDirectory** parameter on non-Windows systems, the path is relative
to your home directory.

```powershell
Start-Transcript -Path ./transcripts
```

```Output
Transcript started, output file is /home/username/./transcripts/PowerShell_transcript.hostname.ift21QeV.20251105151236.txt
```

## PARAMETERS

### -Append
Expand Down Expand Up @@ -192,7 +218,8 @@ Accept wildcard characters: False
### -OutputDirectory

Specifies a specific path and folder in which to save a transcript. PowerShell automatically assigns
the transcript name.
the transcript name. If you use a relative path, the path is relative to your `Documents` directory
on Windows. On Linux and macOS, the path is relative to your home directory.

```yaml
Type: System.String
Expand Down
31 changes: 29 additions & 2 deletions reference/7.5/Microsoft.PowerShell.Host/Start-Transcript.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.ConsoleHost.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 01/06/2025
ms.date: 11/05/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.host/start-transcript?view=powershell-7.5&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Start-Transcript
Expand Down Expand Up @@ -100,6 +100,32 @@ The full path to the transcript file is stored in the `$Transcript` preference v
information about the `$Transcript` preference variable, see
[about_Preference_Variables](../Microsoft.PowerShell.Core/About/about_Preference_Variables.md#transcript).

### Example 4: Start a transcript using a relative path on Windows systems

When you use a relative path with the **OutputDirectory** parameter on Windows, the path is relative
to your `Documents` directory.

```powershell
Start-Transcript -Path .\transcripts
```

```Output
Transcript started, output file is C:\Users\username\Documents\.\transcripts\PowerShell_transcript.HOSTNAME.8S6RpEfN.20251105152247.txt
```

### Example 5: Start a transcript using a relative path on non-Windows systems

When you use a relative path with the **OutputDirectory** parameter on non-Windows systems, the path is relative
to your home directory.

```powershell
Start-Transcript -Path ./transcripts
```

```Output
Transcript started, output file is /home/username/./transcripts/PowerShell_transcript.hostname.ift21QeV.20251105151236.txt
```

## PARAMETERS

### -Append
Expand Down Expand Up @@ -192,7 +218,8 @@ Accept wildcard characters: False
### -OutputDirectory

Specifies a specific path and folder in which to save a transcript. PowerShell automatically assigns
the transcript name.
the transcript name. If you use a relative path, the path is relative to your `Documents` directory
on Windows. On Linux and macOS, the path is relative to your home directory.

```yaml
Type: System.String
Expand Down
31 changes: 29 additions & 2 deletions reference/7.6/Microsoft.PowerShell.Host/Start-Transcript.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.ConsoleHost.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Host
ms.date: 02/18/2025
ms.date: 11/05/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.host/start-transcript?view=powershell-7.6&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Start-Transcript
Expand Down Expand Up @@ -100,6 +100,32 @@ The full path to the transcript file is stored in the `$Transcript` preference v
information about the `$Transcript` preference variable, see
[about_Preference_Variables](../Microsoft.PowerShell.Core/About/about_Preference_Variables.md#transcript).

### Example 4: Start a transcript using a relative path on Windows systems

When you use a relative path with the **OutputDirectory** parameter on Windows, the path is relative
to your `Documents` directory.

```powershell
Start-Transcript -Path .\transcripts
```

```Output
Transcript started, output file is C:\Users\username\Documents\.\transcripts\PowerShell_transcript.HOSTNAME.8S6RpEfN.20251105152247.txt
```

### Example 5: Start a transcript using a relative path on non-Windows systems

When you use a relative path with the **OutputDirectory** parameter on non-Windows systems, the path is relative
to your home directory.

```powershell
Start-Transcript -Path ./transcripts
```

```Output
Transcript started, output file is /home/username/./transcripts/PowerShell_transcript.hostname.ift21QeV.20251105151236.txt
```

## PARAMETERS

### -Append
Expand Down Expand Up @@ -192,7 +218,8 @@ Accept wildcard characters: False
### -OutputDirectory

Specifies a specific path and folder in which to save a transcript. PowerShell automatically assigns
the transcript name.
the transcript name. If you use a relative path, the path is relative to your `Documents` directory
on Windows. On Linux and macOS, the path is relative to your home directory.

```yaml
Type: System.String
Expand Down