aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 5ca16526ed3a986c8b6ce470800f05b988ccbec8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
### sub xdg-config-dirs

```perl6
sub xdg-config-dirs(
    Bool:D :$home = Bool::True
) returns Iterable
```

Retrieve the value of XDG_CONFIG_DIRS as a sequence of IO::Path objects. If this variable is not set, it will use the default value of /etc/xdg. These directories should be read in order to retrieve configuration files.

class Bool:D :$home = Bool::True
--------------------------------

When set to true, this sequence will start with the XDG_CONFIG_HOME value (or its default).

### sub xdg-config-home

```perl6
sub xdg-config-home() returns IO::Path
```

Returns an IO::Path for $XDG_CONFIG_HOME, if it exists as environment variable. Otherwise, return the default value, $HOME/.config. This directory should contain user-specific configuration files.

### sub xdg-cache-home

```perl6
sub xdg-cache-home() returns IO::Path
```

Returns an IO::Path for $XDG_CACHE_HOME, if it exists as environment variable. Otherwise, return the default value, $HOME/.cache. This directory should contain user-specific, non-essential (cached) data.

### sub xdg-data-dirs

```perl6
sub xdg-data-dirs(
    Bool:D :$home = Bool::True
) returns Iterable
```

Retrieve the value of XDG_DATA_DIRS as a sequence of IO::Path objects. If this variable is not set, it will use the default values of /usr/local/share and /usr/share. These directories should be read in order to retrieve user specific data files.

class Bool:D :$home = Bool::True
--------------------------------

When set to true, this sequence will start with the XDG_DATA_HOME value (or its default).

### sub xdg-data-home

```perl6
sub xdg-data-home() returns IO::Path
```

Returns an IO::Path for $XDG_DATA_HOME, if it exists as environment variable. Otherwise, return the default value, $HOME/.local/share. This directory should contain user-specific data files.

### sub xdg-runtime-dir

```perl6
sub xdg-runtime-dir() returns IO::Path
```

Returns an IO::Path for $XDG_RUNTIME_DIR, if it exists as environment variable. Otherwise, return an IO::Path to a temporary directory. This directory should contain user-specific runtime files and other file objects.

NAME
====

IO::Path::XDG

AUTHOR
======

Patrick Spek <p.spek@tyil.work>

VERSION
=======

0.2.0

Synopsis
========

Description
===========

Examples
========

See also
========