]> git.saurik.com Git - wxWidgets.git/blame - docs/dfb/install.txt
enable autobrief comments
[wxWidgets.git] / docs / dfb / install.txt
CommitLineData
0eae18a7
VS
1wxWidgets for DirectFB installation
2===================================
3
4IMPORTANT NOTE:
5
6 wxDFB is currently incomplete and some parts of the wxWidgets library
7 don't yet compile and must be disabled during configuration. In particular,
8 the coverage of wxDC API is limited.
9
10
11Dependencies
12------------
13
14wxDFB requires the DirectFB library (http://www.directfb.org), which must
15be installed before compiling wxDFB.
16
17
18Compiling
19---------
20
21Compilation is done in the standard Unix fashion, using configure and make.
22Please refer to e.g. wxGTK's install.txt for details if you are unfamiliar
23with configure.
24
25When configuring, use the --with-directfb option instead of e.g. --with-gtk
065761f2
VS
26to specify that the wxDFB port should be built. You may also need to disable
27wxUniv themes that don't work in wxDFB yet (alternatively you can set the
28WXTHEME environment variable to "mono"):
29
30$ ./configure --with-directfb --with-themes=mono
0eae18a7
VS
31$ make
32
33
34Configuring fonts
35-----------------
36
37DirectFB doesn't have native fonts configuration mechanism (such as
38fontconfig used by GTK+) and so wxDFB implements a simple configuration
39mechanism itself.
40
41No fonts are installed and configured by "make install", you have to manually
42configure fonts after you install the library.
43
44wxDFB looks the fonts up in directories specified in the WXDFB_FONTPATH
45environment variable (separated with :, similarly to the PATH variable). If
46the variable is not set, $prefix/share/wx/fonts directory is used. All
47subdirectories of the directories on the path are scanned for FontsIndex
48files. These files are parsed and fonts defined in them are added to the fonts
49list.
50
51The FontsIndex file is standard wxFileConfig file text file. Each toplevel
52group specifies one font bundle, font's name is the name of group. Group's
53entries look like this:
54
55 [Font Name]
56 # font files (at least one of them must be present):
57 Regular=RegularFaceFile.ttf
58 Italic=ItalicFaceFile.ttf
59 Bold=BoldFaceFile.ttf
60 BoldItalic=BoldItalicFaceFile.ttf
61 # optional tag indicating this font is fixed-with (default is false):
62 IsFixed=1
63
64Additionally, there may be DefaultXXX entries at the toplevel for every family
65XXX and a Default entry that is shortcut for setting all families' default,
66their value is name of the default font:
67
68 # optional tags indicating the default font for given family:
69 DefaultDecorative=Font Name
70 DefaultRoman=Font Name
71 DefaultScript=Font Name
72 DefaultSwiss=Font Name
73 DefaultModern=Font Name
74 DefaultTeletype=Font Name
75 # indicate the font that is default for all families (optional):
76 Default=Font Name
77
78Any font formats supported by DirectFB (which typically includes formats
79supported by the FreeType library) can be used.
80
81
82Bug reports
83-----------
84
85Please send bug reports with a description of your environment,
86compiler and the error message(s) to the wxwin-developers mailing list at:
87
88 wx-dev@lists.wxwidgets.org