usr.sbin/installer/libinstaller/README

   1 libinstaller v5.0 README
   2 ========================
   3
   4 $Id: README,v 1.5 2005/03/21 03:26:57 cpressey Exp $
   5
   6 What is libinstaller?
   7 ---------------------
   8
   9 libinstaller is a library of support functions for the BSD Installer
  10 application, dfuibe_installer.
  11
  12 What is the current state of the project?
  13 -----------------------------------------
  14
  15 EXPERIMENTAL.  libinstaller's application programming interface may change at
  16 any time.  If you use libinstaller in a project, be prepared to chase API
  17 changes.  Both the API and the ABI of libinstaller 5.0 are not backwards-
  18 compatible with those of of previous versions.
  19
  20 How do I build and install libinstaller?
  21 ----------------------------------------
  22
  23 On a BSD-based system, go into the libinstaller source directory and type:
  24
  25         make
  26
  27 Once built, it can be installed by typing (as root):
  28
  29         make install
  30
  31 Directions may differ for other systems.
  32
  33 An alternative method is to build libinstaller using the ports system and
  34 install it using the package system.
  35
  36 How do I use libinstaller from a program?
  37 -----------------------------------------
  38
  39 libinstaller requires libdfui, which in turn requires libaura, but none
  40 of these are statically linked with it, so any consumers of libinstaller
  41 will also need to link to libaura and libdfui.
  42
  43 You can give gcc the following sort of command line flags to tell it to
  44 link your program with libinstaller:
  45
  46         gcc foo.c -o foo -L/usr/local/lib -laura -ldfui -linstaller
  47
  48 See the libinstaller source code for the list of available functions and
  49 what they do.