Blame fc-cache/fc-cache.1

Packit dcf226
.\" auto-generated by docbook2man-spec from docbook-utils package
Packit dcf226
.TH "FC-CACHE" "1" "Aug 13, 2008" "" ""
Packit dcf226
.SH NAME
Packit dcf226
fc-cache \- build font information cache files
Packit dcf226
.SH SYNOPSIS
Packit dcf226
.sp
Packit dcf226
\fBfc-cache\fR [ \fB-EfrsvVh\fR ]  [ \fB--error-on-no-fonts\fR ]  [ \fB--force\fR ]  [ \fB--really-force\fR ]  [ \fB [ -y \fIdir\fB ]  [ --sysroot \fIdir\fB ] \fR ]  [ \fB--system-only\fR ]  [ \fB--verbose\fR ]  [ \fB--version\fR ]  [ \fB--help\fR ]  [ \fB\fIdir\fB\fR\fI...\fR ] 
Packit dcf226
.SH "DESCRIPTION"
Packit dcf226
.PP
Packit dcf226
\fBfc-cache\fR scans the font directories on
Packit dcf226
the system and builds font information cache files for
Packit dcf226
applications using fontconfig for their font handling.
Packit dcf226
.PP
Packit dcf226
If directory arguments are not given,
Packit dcf226
\fBfc-cache\fR uses each directory in the
Packit dcf226
current font configuration. Each directory is scanned for
Packit dcf226
font files readable by FreeType. A cache is created which
Packit dcf226
contains properties of each font and the associated filename.
Packit dcf226
This cache is used to speed up application startup when using
Packit dcf226
the fontconfig library.
Packit dcf226
.PP
Packit dcf226
Note that \fBfc-cache\fR must be executed
Packit dcf226
once per architecture to generate font information customized
Packit dcf226
for that architecture.
Packit dcf226
.SH "OPTIONS"
Packit dcf226
.PP
Packit dcf226
This program follows the usual GNU command line syntax,
Packit dcf226
with long options starting with two dashes (`-'). A summary of
Packit dcf226
options is included below.
Packit dcf226
.TP
Packit dcf226
\fB-E\fR
Packit dcf226
Raise an error if there are no fonts in
Packit dcf226
\fB\fIdir\fB\fR or directories
Packit dcf226
in the configuration if not given.
Packit dcf226
.TP
Packit dcf226
\fB-f\fR
Packit dcf226
Force re-generation of apparently up-to-date cache files,
Packit dcf226
overriding the timestamp checking.
Packit dcf226
.TP
Packit dcf226
\fB-r\fR
Packit dcf226
Erase all existing cache files and rescan.
Packit dcf226
.TP
Packit dcf226
\fB-s\fR
Packit dcf226
Only scan system-wide directories, omitting the places
Packit dcf226
located in the user's home directory.
Packit dcf226
.TP
Packit dcf226
\fB-v\fR
Packit dcf226
Display status information while busy.
Packit dcf226
.TP
Packit dcf226
\fB-y\fR
Packit dcf226
Prepend \fB\fIdir\fB\fR to all paths for scanning.
Packit dcf226
.TP
Packit dcf226
\fB-h\fR
Packit dcf226
Show summary of options.
Packit dcf226
.TP
Packit dcf226
\fB-V\fR
Packit dcf226
Show version of the program and exit.
Packit dcf226
.TP
Packit dcf226
\fB\fIdir\fB\fR
Packit dcf226
Directory to scan for fonts.
Packit dcf226
.SH "RETURN CODES"
Packit dcf226
.PP
Packit dcf226
\fBfc-cache\fR returns zero if the caches successfully generated. otherwise non-zero.
Packit dcf226
.SH "FILES"
Packit dcf226
.TP
Packit dcf226
\fB\fI%cachedir%/*-%arch%\&.cache-%version%\fB\fR
Packit dcf226
These files are generated by \fBfc-cache\fR
Packit dcf226
and contain maps from file names to font properties. They are
Packit dcf226
read by the fontconfig library at application startup to locate
Packit dcf226
appropriate fonts.
Packit dcf226
.SH "SEE ALSO"
Packit dcf226
.PP
Packit dcf226
\fBfc-cat\fR(1)
Packit dcf226
\fBfc-list\fR(1)
Packit dcf226
\fBfc-match\fR(1)
Packit dcf226
\fBfc-pattern\fR(1)
Packit dcf226
\fBfc-query\fR(1)
Packit dcf226
\fBfc-scan\fR(1)
Packit dcf226
.PP
Packit dcf226
The fontconfig user's guide, in HTML format:
Packit dcf226
\fI/usr/share/doc/fontconfig/fontconfig-user.html\fR\&.
Packit dcf226
.SH "AUTHOR"
Packit dcf226
.PP
Packit dcf226
This manual page was written by Keith Packard
Packit dcf226
<keithp@keithp.com> and Josselin Mouette <joss@debian.org>\&.