Skip to content

docs(config): document XDG_DATA_HOME support on Windows and macOS #14

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
CalvinAllen merged 1 commit into from
Jan 27, 2026
Merged

docs(config): document XDG_DATA_HOME support on Windows and macOS #14

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
15 changes: 12 additions & 3 deletions website/src/content/docs/user-guide/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,24 @@ $env:DTVEM_ROOT = "C:\custom\path\dtvem"
- macOS: `~/.dtvem`
- Windows: `%USERPROFILE%\.dtvem`

### XDG_DATA_HOME (Linux only)
### XDG_DATA_HOME

On Linux, dtvem follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html). If `XDG_DATA_HOME` is set, dtvem uses `$XDG_DATA_HOME/dtvem`.
dtvem supports the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) on all platforms. When `XDG_DATA_HOME` is set, dtvem uses `$XDG_DATA_HOME/dtvem` as its root directory.

```bash
export XDG_DATA_HOME=~/.local/share # Default
# Linux/macOS
export XDG_DATA_HOME=~/.local/share
# dtvem will use ~/.local/share/dtvem
```

```powershell
# Windows (PowerShell)
$env:XDG_DATA_HOME = "$env:USERPROFILE\.local\share"
# dtvem will use %USERPROFILE%\.local\share\dtvem
```

When `XDG_DATA_HOME` is not set, dtvem uses the default locations shown above.

**Note:** `DTVEM_ROOT` takes priority over `XDG_DATA_HOME`.

### DTVEM_VERBOSE
Expand Down
2 changes: 1 addition & 1 deletion website/src/content/docs/user-guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ curl -fsSL dtvem.io/install.sh | bash -s -- --user-install
| macOS | `~/.dtvem` | `~/.dtvem/shims` |
| Linux | `~/.local/share/dtvem` | `~/.local/share/dtvem/shims` |

On Linux, dtvem follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/latest/). If `$XDG_DATA_HOME` is set, dtvem uses `$XDG_DATA_HOME/dtvem` instead.
On all platforms, dtvem supports the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/latest/). If `$XDG_DATA_HOME` is set, dtvem uses `$XDG_DATA_HOME/dtvem` instead.

## Custom Installation

Expand Down