summaryrefslogtreecommitdiff
path: root/dist/fontconfig/fc-cache/fc-cache.1
blob: df466703cdf09c5fff87b807b983f4f839956419 (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
90
91
92
93
94
95
.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "FC-CACHE" "1" "Aug 13, 2008" "" ""

.SH NAME
fc-cache \- build font information cache files
.SH SYNOPSIS

\fBfc-cache\fR [ \fB-cEfrsvVh\fR ] [ \fB--chroot root\fR ] [ \fB--error-on-no-fonts\fR ] [ \fB--force\fR ] [ \fB--really-force\fR ] [ \fB-y \fIdir\fB\fR | \fB--sysroot \fIdir\fB\fR ] [ \fB--system-only\fR ] [ \fB--verbose\fR ] [ \fB--version\fR ] [ \fB--help\fR ] [ \fB\fIdir\fB\fR\fI ...\fR ]

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