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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
'\" t
.TH "SD_PATH_LOOKUP" "3" "" "systemd 255" "sd_path_lookup"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sd_path_lookup, sd_path_lookup_strv \- Query well\-known file system paths
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-path\&.h>
.fi
.ft
.sp
.ft B
.nf
enum {
\fBSD_PATH_TEMPORARY\fR,
\fBSD_PATH_TEMPORARY_LARGE\fR,
\fBSD_PATH_SYSTEM_BINARIES\fR,
\fBSD_PATH_SYSTEM_INCLUDE\fR,
\fBSD_PATH_SYSTEM_LIBRARY_PRIVATE\fR,
\fBSD_PATH_SYSTEM_LIBRARY_ARCH\fR,
\fBSD_PATH_SYSTEM_SHARED\fR,
\fBSD_PATH_SYSTEM_CONFIGURATION_FACTORY\fR,
\fBSD_PATH_SYSTEM_STATE_FACTORY\fR,
\fBSD_PATH_SYSTEM_CONFIGURATION\fR,
\fBSD_PATH_SYSTEM_RUNTIME\fR,
\fBSD_PATH_SYSTEM_RUNTIME_LOGS\fR,
\fBSD_PATH_SYSTEM_STATE_PRIVATE\fR,
\fBSD_PATH_SYSTEM_STATE_LOGS\fR,
\fBSD_PATH_SYSTEM_STATE_CACHE\fR,
\fBSD_PATH_SYSTEM_STATE_SPOOL\fR,
\fBSD_PATH_USER_BINARIES\fR,
\fBSD_PATH_USER_LIBRARY_PRIVATE\fR,
\fBSD_PATH_USER_LIBRARY_ARCH\fR,
\fBSD_PATH_USER_SHARED\fR,
\fBSD_PATH_USER_CONFIGURATION\fR,
\fBSD_PATH_USER_RUNTIME\fR,
\fBSD_PATH_USER_STATE_PRIVATE\fR,
\fBSD_PATH_USER_STATE_CACHE\fR,
\fBSD_PATH_USER\fR,
\fBSD_PATH_USER_DOCUMENTS\fR,
\fBSD_PATH_USER_MUSIC\fR,
\fBSD_PATH_USER_PICTURES\fR,
\fBSD_PATH_USER_VIDEOS\fR,
\fBSD_PATH_USER_DOWNLOAD\fR,
\fBSD_PATH_USER_PUBLIC\fR,
\fBSD_PATH_USER_TEMPLATES\fR,
\fBSD_PATH_USER_DESKTOP\fR,
\fBSD_PATH_SEARCH_BINARIES\fR,
\fBSD_PATH_SEARCH_BINARIES_DEFAULT\fR,
\fBSD_PATH_SEARCH_LIBRARY_PRIVATE\fR,
\fBSD_PATH_SEARCH_LIBRARY_ARCH\fR,
\fBSD_PATH_SEARCH_SHARED\fR,
\fBSD_PATH_SEARCH_CONFIGURATION_FACTORY\fR,
\fBSD_PATH_SEARCH_STATE_FACTORY\fR,
\fBSD_PATH_SEARCH_CONFIGURATION\fR,
\fBSD_PATH_SYSTEMD_UTIL\fR,
\fBSD_PATH_SYSTEMD_SYSTEM_UNIT\fR,
\fBSD_PATH_SYSTEMD_SYSTEM_PRESET\fR,
\fBSD_PATH_SYSTEMD_USER_UNIT\fR,
\fBSD_PATH_SYSTEMD_USER_PRESET\fR,
\fBSD_PATH_SYSTEMD_SYSTEM_CONF\fR,
\fBSD_PATH_SYSTEMD_USER_CONF\fR,
\fBSD_PATH_SYSTEMD_SEARCH_SYSTEM_UNIT\fR,
\fBSD_PATH_SYSTEMD_SEARCH_USER_UNIT\fR,
\fBSD_PATH_SYSTEMD_SYSTEM_GENERATOR\fR,
\fBSD_PATH_SYSTEMD_USER_GENERATOR\fR,
\fBSD_PATH_SYSTEMD_SEARCH_SYSTEM_GENERATOR\fR,
\fBSD_PATH_SYSTEMD_SEARCH_USER_GENERATOR\fR,
\fBSD_PATH_SYSTEMD_SLEEP\fR,
\fBSD_PATH_SYSTEMD_SHUTDOWN\fR,
\fBSD_PATH_TMPFILES\fR,
\fBSD_PATH_SYSUSERS\fR,
\fBSD_PATH_SYSCTL\fR,
\fBSD_PATH_BINFMT\fR,
\fBSD_PATH_MODULES_LOAD\fR,
\fBSD_PATH_CATALOG\fR,
\fBSD_PATH_SYSTEMD_SEARCH_NETWORK\fR,
\fBSD_PATH_SYSTEMD_SYSTEM_ENVIRONMENT_GENERATOR\fR,
\fBSD_PATH_SYSTEMD_USER_ENVIRONMENT_GENERATOR\fR,
\fBSD_PATH_SYSTEMD_SEARCH_SYSTEM_ENVIRONMENT_GENERATOR\fR,
\fBSD_PATH_SYSTEMD_SEARCH_USER_ENVIRONMENT_GENERATOR\fR,
};
.fi
.ft
.HP \w'int\ sd_path_lookup('u
.BI "int sd_path_lookup(uint64_t\ " "type" ", const\ char\ *" "suffix" ", char\ **" "paths" ");"
.HP \w'int\ sd_path_lookup_strv('u
.BI "int sd_path_lookup_strv(uint64_t\ " "type" ", const\ char\ *" "suffix" ", char\ ***" "paths" ");"
.SH "DESCRIPTION"
.PP
\fBsd_path_lookup()\fR
and
\fBsd_bus_path_lookup_strv()\fR
return a single path or set of file system paths specified by the argument
\fItype\fR\&. In case of
\fBsd_path_lookup()\fR
a single
\fBNUL\fR\-terminated string is returned\&. When
\fItype\fR
specifies a set of paths, they are concatenated using
":"
as a separator (as is traditionally done for e\&.g\&.
\fI$PATH\fR
or
\fI$LD_LIBRARY_PATH\fR)\&. In case of
\fBsd_path_lookup_strv()\fR
a
\fBNULL\fR\-terminated array of strings is returned (strv)\&. If suffix
\fIsuffix\fR
is given, it is concatenated to each of the paths after a slash ("/")\&. All returned paths are absolute\&.
.PP
For paths which refer to user directories, the relevant XDG standard is followed, with support for environment variables like
\fI$XDG_DOCUMENTS_DIR\fR,
\fI$XDG_DESKTOP_DIR\fR, \&.\&.\&., and explicit configuration in
/etc/xdg/user\-dirs\&.conf
or
${XDG_CONFIG_HOME}/user\-dirs\&.dirs\&. See
\m[blue]\fBXDG Base Directory Specification\fR\m[]\&\s-2\u[1]\d\s+2
for details\&.
.PP
\fBsystemd-path\fR(1)
is a wrapper around
\fBsd_path_lookup()\fR
and allows the same set of paths to be queried\&.
.SH "RETURN VALUE"
.PP
On success,
\fBsd_path_lookup()\fR
and
\fBsd_path_lookup_strv()\fR
return a non\-negative integer\&. On failure, a negative errno\-style error number is returned by either function\&.
.PP
The returned string or string array (strv) must be
\fBfree\fR(3)\*(Aqd by the caller\&.
.SS "Errors"
.PP
Returned errors may indicate the following problems:
.PP
\fB\-EOPNOTSUPP\fR
.RS 4
Unknown identifier
\fItype\fR\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-EINVAL\fR
.RS 4
Output argument is
\fBNULL\fR\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-ENXIO\fR
.RS 4
Query failed because of an undefined environment variable (e\&.g\&. for
\fBSD_PATH_USER_RUNTIME\fR
when
\fI$XDG_RUNTIME_DIR\fR
is not defined)\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-ENOMEM\fR
.RS 4
Memory allocation failed\&.
.sp
Added in version 246\&.
.RE
.SH "EXAMPLES"
.SS "Look up the location of ~/Documents"
.sp
.if n \{\
.RS 4
.\}
.nf
/* SPDX\-License\-Identifier: MIT\-0 */
#include <stdio\&.h>
#include <stdlib\&.h>
#include <sd\-path\&.h>
int main(void) {
int r;
char *t;
r = sd_path_lookup(SD_PATH_USER_DOCUMENTS, NULL, &t);
if (r < 0)
return EXIT_FAILURE;
printf("~/Documents: %s\en", t);
free(t);
return EXIT_SUCCESS;
}
.fi
.if n \{\
.RE
.\}
.PP
Note that the default answer of
$HOME/Documents
may be overridden by
user\-dirs\&.conf
or
\fI$XDG_DOCUMENTS_DIR\fR\&.
.SH "NOTES"
.PP
Functions described here are available as a shared library, which can be compiled against and linked to with the
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
file\&.
.PP
The code described here uses
\fBgetenv\fR(3), which is declared to be not multi\-thread\-safe\&. This means that the code calling the functions described here must not call
\fBsetenv\fR(3)
from a parallel thread\&. It is recommended to only do calls to
\fBsetenv()\fR
from an early phase of the program when no other threads have been started\&.
.SH "HISTORY"
.PP
\fBsd_path_lookup()\fR
and
\fBsd_path_lookup_strv()\fR
were added in version 246\&.
.SH "SEE ALSO"
.PP
\fBsystemd-path\fR(1)
.SH "NOTES"
.IP " 1." 4
XDG Base Directory Specification
.RS 4
\%https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
.RE
|
