f111f8681035424f1479c94537dad8a86b0156f1
[platform/upstream/fontconfig.git] / fc-cache / fc-cache.1
1 .\" auto-generated by docbook2man-spec from docbook-utils package
2 .TH "FC-CACHE" "1" "Aug 13, 2008" "" ""
3 .SH NAME
4 fc-cache \- build font information cache files
5 .SH SYNOPSIS
6 .sp
7 \fBfc-cache\fR [ \fB-frsvVh\fR ]  [ \fB--force\fR ]  [ \fB--really-force\fR ]  [ \fB--system-only\fR ]  [ \fB--verbose\fR ]  [ \fB--version\fR ]  [ \fB--help\fR ]  [ \fB\fIdir\fB\fR\fI...\fR ] 
8 .SH "DESCRIPTION"
9 .PP
10 \fBfc-cache\fR scans the font directories on
11 the system and builds font information cache files for
12 applications using fontconfig for their font handling.
13 .PP
14 If directory arguments are not given,
15 \fBfc-cache\fR uses each directory in the
16 current font configuration. Each directory is scanned for
17 font files readable by FreeType. A cache is created which
18 contains properties of each font and the associated filename.
19 This cache is used to speed up application startup when using
20 the fontconfig library.
21 .PP
22 Note that \fBfc-cache\fR must be executed
23 once per architecture to generate font information customized
24 for that architecture.
25 .SH "OPTIONS"
26 .PP
27 This program follows the usual GNU command line syntax,
28 with long options starting with two dashes (`-'). A summary of
29 options is included below.
30 .TP
31 \fB-f\fR
32 Force re-generation of apparently up-to-date cache files,
33 overriding the timestamp checking.
34 .TP
35 \fB-r\fR
36 Erase all existing cache files and rescan.
37 .TP
38 \fB-s\fR
39 Only scan system-wide directories, omitting the places
40 located in the user's home directory.
41 .TP
42 \fB-v\fR
43 Display status information while busy.
44 .TP
45 \fB-h\fR
46 Show summary of options.
47 .TP
48 \fB-V\fR
49 Show version of the program and exit.
50 .TP
51 \fB\fIdir\fB\fR
52 Directory to scan for fonts.
53 .SH "FILES"
54 .TP
55 \fB\fI%cachdir%/*-%arch%\&.cache-2\fB\fR
56 These files are generated by \fBfc-cache\fR
57 and contain maps from file names to font properties. They are
58 read by the fontconfig library at application startup to locate
59 appropriate fonts.
60 .SH "SEE ALSO"
61 .PP
62 \fBfc-cat\fR(1)
63 \fBfc-list\fR(1)
64 \fBfc-match\fR(1)
65 \fBfc-pattern\fR(1)
66 \fBfc-query\fR(1)
67 \fBfc-scan\fR(1)
68 .PP
69 The fontconfig user's guide, in HTML format:
70 \fI/usr/share/doc/fontconfig/fontconfig-user.html\fR\&.
71 .SH "AUTHOR"
72 .PP
73 This manual page was written by Keith Packard
74 <keithp@keithp.com> and Josselin Mouette <joss@debian.org>\&.