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 may also need to disable
  27 wxUniv themes that don't work in wxDFB yet (alternatively you can set the
  28 WXTHEME environment variable to "mono"):
  29
  30 $ ./configure --with-directfb --with-themes=mono
  31 $ make
  32
  33
  34 Configuring fonts
  35 -----------------
  36
  37 DirectFB doesn't have native fonts configuration mechanism (such as
  38 fontconfig used by GTK+) and so wxDFB implements a simple configuration
  39 mechanism itself.
  40
  41 No fonts are installed and configured by "make install", you have to manually
  42 configure fonts after you install the library.
  43
  44 wxDFB looks the fonts up in directories specified in the WXDFB_FONTPATH
  45 environment variable (separated with :, similarly to the PATH variable).  If
  46 the variable is not set, $prefix/share/wx/fonts directory is used. All
  47 subdirectories of the directories on the path are scanned for FontsIndex
  48 files. These files are parsed and fonts defined in them are added to the fonts
  49 list.
  50
  51 The FontsIndex file is standard wxFileConfig file text file. Each toplevel
  52 group specifies one font bundle, font's name is the name of group. Group's
  53 entries 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
  64 Additionally, there may be DefaultXXX entries at the toplevel for every family
  65 XXX and a Default entry that is shortcut for setting all families' default,
  66 their 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
  78 Any font formats supported by DirectFB (which typically includes formats
  79 supported by the FreeType library) can be used.
  80
  81
  82 Bug reports
  83 -----------
  84
  85 Please send bug reports with a description of your environment,
  86 compiler and the error message(s) to the wxwin-developers mailing list at:
  87
  88     wx-dev@lists.wxwidgets.org