Skip to content

Commit 29814a5

Browse files
authored
docs(config): document XDG_DATA_HOME support on Windows and macOS (#14)
1 parent 1c4558d commit 29814a5

2 files changed

Lines changed: 13 additions & 4 deletions

File tree

website/src/content/docs/user-guide/configuration.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,24 @@ $env:DTVEM_ROOT = "C:\custom\path\dtvem"
2828
- macOS: `~/.dtvem`
2929
- Windows: `%USERPROFILE%\.dtvem`
3030

31-
### XDG_DATA_HOME (Linux only)
31+
### XDG_DATA_HOME
3232

33-
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`.
33+
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.
3434

3535
```bash
36-
export XDG_DATA_HOME=~/.local/share # Default
36+
# Linux/macOS
37+
export XDG_DATA_HOME=~/.local/share
3738
# dtvem will use ~/.local/share/dtvem
3839
```
3940

41+
```powershell
42+
# Windows (PowerShell)
43+
$env:XDG_DATA_HOME = "$env:USERPROFILE\.local\share"
44+
# dtvem will use %USERPROFILE%\.local\share\dtvem
45+
```
46+
47+
When `XDG_DATA_HOME` is not set, dtvem uses the default locations shown above.
48+
4049
**Note:** `DTVEM_ROOT` takes priority over `XDG_DATA_HOME`.
4150

4251
### DTVEM_VERBOSE

website/src/content/docs/user-guide/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ curl -fsSL dtvem.io/install.sh | bash -s -- --user-install
4747
| macOS | `~/.dtvem` | `~/.dtvem/shims` |
4848
| Linux | `~/.local/share/dtvem` | `~/.local/share/dtvem/shims` |
4949

50-
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.
50+
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.
5151

5252
## Custom Installation
5353

0 commit comments

Comments
 (0)