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

Add FAQ section to Portable Mode Docs #797

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add FAQ section to Portable Mode Docs #797

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c96176
Add Portable Mode FAQ with ms-appdata FAQ
nguyen-dows Sep 20, 2024
226208c
change title
nguyen-dows Sep 20, 2024
1d7312f
Update TerminalDocs/distributions.md
nguyen-dows Sep 25, 2024
b0dfe83
change heuristic to practice
nguyen-dows Sep 25, 2024
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
13 changes: 12 additions & 1 deletion TerminalDocs/distributions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Distribution Types
description: Learn how to use the different distributions of Windows Terminal.
author: nguyen-dows
ms.author: chrnguyen
ms.date: 04/10/2023
ms.date: 09/20/2024
ms.topic: how-to
---

Expand Down Expand Up @@ -96,6 +96,17 @@ If you wish to reenable portable mode, you can create a new `.portable` marker f
You can upgrade a portable mode installation of Windows Terminal by moving the `.portable` marker file and the
`settings` directory to a newly-extracted unpackaged version of Windows Terminal.

### Portable mode FAQs

#### Why don't ms-appdata URLs work in Portable mode?
Prior to portable mode, a common practice to reference images in `settings.json` would be to use `ms-appdata:///Local`.

Portable mode offers a self-contained Terminal installation, where user data and application data are stored in the same place. As there is no separate user data folder, references to such folder (e.g. with `ms-appdata`) will not work.

To refer to paths relative to the application install directory, use an `ms-appx:` URL.

To refer to paths relative to the settings directory, use the environment variable `%WT_SETTINGS_DIR%`.

["Portable mode"]: https://en.wikipedia.org/wiki/Portable_application
[GitHub releases]: https://github.com/microsoft/terminal/releases
[preinstallation kit]: /windows/msix/desktop/deploy-preinstalled-apps
Expand Down