Imported Upstream version 2.14.2
[platform/upstream/fontconfig.git] / doc / FcConfigGetFilename.3
1 .\" auto-generated by docbook2man-spec from docbook-utils package
2 .TH "FcConfigGetFilename" "3" "27 1月 2023" "Fontconfig 2.14.2" ""
3 .SH NAME
4 FcConfigGetFilename \- Find a config file
5 .SH SYNOPSIS
6 .nf
7 \fB#include <fontconfig/fontconfig.h>
8 .sp
9 FcChar8 * FcConfigGetFilename (FcConfig *\fIconfig\fB, const FcChar8 *\fIname\fB);
10 .fi\fR
11 .SH "DESCRIPTION"
12 .PP
13 Given the specified external entity name, return the associated filename.
14 This provides applications a way to convert various configuration file
15 references into filename form.
16 .PP
17 A null or empty \fIname\fR indicates that the default configuration file should
18 be used; which file this references can be overridden with the
19 FONTCONFIG_FILE environment variable. Next, if the name starts with \fI~\fR, it
20 refers to a file in the current users home directory. Otherwise if the name
21 doesn't start with '/', it refers to a file in the default configuration
22 directory; the built-in default directory can be overridden with the
23 FONTCONFIG_PATH environment variable.
24 .PP
25 The result of this function is affected by the FONTCONFIG_SYSROOT environment variable or equivalent functionality.