]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/dfb/install.txt
changelog for 2.8.1.1
[wxWidgets.git] / docs / dfb / install.txt
... / ...
CommitLineData
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$ make
54
55
56Configuring fonts
57-----------------
58
59DirectFB doesn't have native fonts configuration mechanism (such as
60fontconfig used by GTK+) and so wxDFB implements a simple configuration
61mechanism itself.
62
63No fonts are installed and configured by "make install", you have to manually
64configure fonts after you install the library.
65
66wxDFB looks the fonts up in directories specified in the WXDFB_FONTPATH
67environment variable (separated with :, similarly to the PATH variable). If
68the variable is not set, $prefix/share/wx/fonts directory is used. All
69subdirectories of the directories on the path are scanned for FontsIndex
70files. These files are parsed and fonts defined in them are added to the fonts
71list.
72
73The FontsIndex file is standard wxFileConfig file text file. Each toplevel
74group specifies one font bundle, font's name is the name of group. Group's
75entries look like this:
76
77 [Font Name]
78 # font files (at least one of them must be present):
79 Regular=RegularFaceFile.ttf
80 Italic=ItalicFaceFile.ttf
81 Bold=BoldFaceFile.ttf
82 BoldItalic=BoldItalicFaceFile.ttf
83 # optional tag indicating this font is fixed-with (default is false):
84 IsFixed=1
85
86Additionally, there may be DefaultXXX entries at the toplevel for every family
87XXX and a Default entry that is shortcut for setting all families' default,
88their value is name of the default font:
89
90 # optional tags indicating the default font for given family:
91 DefaultDecorative=Font Name
92 DefaultRoman=Font Name
93 DefaultScript=Font Name
94 DefaultSwiss=Font Name
95 DefaultModern=Font Name
96 DefaultTeletype=Font Name
97 # indicate the font that is default for all families (optional):
98 Default=Font Name
99
100Any font formats supported by DirectFB (which typically includes formats
101supported by the FreeType library) can be used.
102
103
104Bug reports
105-----------
106
107Please send bug reports with a description of your environment,
108compiler and the error message(s) to the wxwin-developers mailing list at:
109
110 wx-dev@lists.wxwidgets.org