docs/dfb/install.txt

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