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
26to specify that the wxDFB port should be built. You'll also need to disable
27wxWidgets features that don't work in wxDFB yet:
28
29$ ./configure --with-directfb \
30              --with-themes=mono \
31              --disable-accel \
32              --disable-popupwin \
33              --disable-help \
34              --disable-combobox \
35              --disable-menus \
36              --disable-mdi \
37              --disable-mdidoc \
38              --disable-docview \
39              --disable-printarch \
40              --disable-calendar \
41              --disable-choice \
42              --disable-choicebook \
43              --disable-dirdlg \
44              --disable-filedlg \
45              --disable-fontdlg \
46              --disable-filepicker \
47              --disable-dirpicker \
48              --disable-fontpicker \
49              --disable-datepick \
50              --disable-hyperlink \
51              --disable-aui \
52              --disable-richtext \
53              --disable-fontmap \
54              --disable-xrc \
55              --disable-html
56$ make
57
58
59Configuring fonts
60-----------------
61
62DirectFB doesn't have native fonts configuration mechanism (such as
63fontconfig used by GTK+) and so wxDFB implements a simple configuration
64mechanism itself.
65
66No fonts are installed and configured by "make install", you have to manually
67configure fonts after you install the library.
68
69wxDFB looks the fonts up in directories specified in the WXDFB_FONTPATH
70environment variable (separated with :, similarly to the PATH variable).  If
71the variable is not set, $prefix/share/wx/fonts directory is used. All
72subdirectories of the directories on the path are scanned for FontsIndex
73files. These files are parsed and fonts defined in them are added to the fonts
74list.
75
76The FontsIndex file is standard wxFileConfig file text file. Each toplevel
77group specifies one font bundle, font's name is the name of group. Group's
78entries look like this:
79
80   [Font Name]
81   # font files (at least one of them must be present):
82   Regular=RegularFaceFile.ttf
83   Italic=ItalicFaceFile.ttf
84   Bold=BoldFaceFile.ttf
85   BoldItalic=BoldItalicFaceFile.ttf
86   # optional tag indicating this font is fixed-with (default is false):
87   IsFixed=1
88
89Additionally, there may be DefaultXXX entries at the toplevel for every family
90XXX and a Default entry that is shortcut for setting all families' default,
91their value is name of the default font:
92
93   # optional tags indicating the default font for given family:
94   DefaultDecorative=Font Name
95   DefaultRoman=Font Name
96   DefaultScript=Font Name
97   DefaultSwiss=Font Name
98   DefaultModern=Font Name
99   DefaultTeletype=Font Name
100   # indicate the font that is default for all families (optional):
101   Default=Font Name
102
103Any font formats supported by DirectFB (which typically includes formats
104supported by the FreeType library) can be used.
105
106
107Bug reports
108-----------
109
110Please send bug reports with a description of your environment,
111compiler and the error message(s) to the wxwin-developers mailing list at:
112
113    wx-dev@lists.wxwidgets.org
114