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