Imported Upstream version 2.14.2
[platform/upstream/fontconfig.git] / doc / FcConfigSetSysRoot.3
index e1e1183..a562e3c 100644 (file)
@@ -1,5 +1,5 @@
 .\" auto-generated by docbook2man-spec from docbook-utils package
-.TH "FcConfigSetSysRoot" "3" "30 8月 2018" "Fontconfig 2.13.1" ""
+.TH "FcConfigSetSysRoot" "3" "27 1月 2023" "Fontconfig 2.14.2" ""
 .SH NAME
 FcConfigSetSysRoot \- Set the system root directory
 .SH SYNOPSIS
@@ -10,10 +10,13 @@ void FcConfigSetSysRoot (FcConfig *\fIconfig\fB, const FcChar8 *\fIsysroot\fB);
 .fi\fR
 .SH "DESCRIPTION"
 .PP
-Set 'sysroot' as the system root directory. fontconfig prepend 'sysroot'
-to the cache directories in order to allow people to generate caches at
-the build time. Note that this causes changing current config. i.e.
-this function calls FcConfigSetCurrent() internally.
+Set 'sysroot' as the system root directory. All file paths used or created with
+this 'config' (including file properties in patterns) will be considered or
+made relative to this 'sysroot'. This allows a host to generate caches for
+targets at build time. This also allows a cache to be re-targeted to a
+different base directory if 'FcConfigGetSysRoot' is used to resolve file paths.
+When setting this on the current config this causes changing current config
+(calls FcConfigSetCurrent()).
 .SH "SINCE"
 .PP
 version 2.10.92