usr.sbin/installer/libdfui/README

   1 libdfui v4.0 README
   2 ===================
   3
   4 $Id: README,v 1.3 2005/03/21 03:26:57 cpressey Exp $
   5
   6 What is libdfui?
   7 ----------------
   8
   9 libdfui is a LIBrary for DragonFly User Interfaces.  It provides a highly
  10 abstract user interaction interface with which an application program
  11 (termed the backend) can communicate with a user via a concreate user
  12 interface terminal program (termed the frontend.)  The frontend and the
  13 backend can communicate over several kinds of transport layers (TCP
  14 and Named Pipes.)  The protocol is abstract enough so that the
  15 frontend can occupy nearly any medium (GUI, addressable text console,
  16 teletype, voice synthesis/recognition, etc) with little to no `fudging'
  17 of the semantics (i.e. the structure and nature of the information that
  18 the backend wishes to present and/or acquire.)
  19
  20 What is the current state of the project?
  21 -----------------------------------------
  22
  23 EXPERIMENTAL.  libdfui's application programming interface may change at
  24 any time.  If you use libdfui in a project, be prepared to chase API changes.
  25 libdfui 4.0 is not expected to be backwards-compatible with previous
  26 versions.  While many functions may be the same, some have changed.
  27
  28 How do I build and install libdfui?
  29 -----------------------------------
  30
  31 On a BSD-based system, go into the libdfui source directory and type:
  32
  33         make
  34
  35 Once built, it can be installed by typing (as root):
  36
  37         make install
  38
  39 Directions may differ for other systems.
  40
  41 An alternative method is to build libdfui using the ports system and
  42 install it using the package system.
  43
  44 How do I use libdfui from a program?
  45 ------------------------------------
  46
  47 libdfui requires libaura, but is not statically linked with it, so any
  48 consumers of libdfui will also need to link to libaura.
  49
  50 You can give gcc the following sort of command line flags to tell it to
  51 link your program with libdfui:
  52
  53         gcc foo.c -o foo -L/usr/local/lib -laura -ldfui
  54
  55 See the libdfui source code for the list of available functions and what
  56 they do.