xref: /dflybsd-src/usr.sbin/installer/libinstaller/README (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marinolibinstaller v5.0 README
286d7f5d3SJohn Marino========================
386d7f5d3SJohn Marino
486d7f5d3SJohn Marino$Id: README,v 1.5 2005/03/21 03:26:57 cpressey Exp $
586d7f5d3SJohn Marino
686d7f5d3SJohn MarinoWhat is libinstaller?
786d7f5d3SJohn Marino---------------------
886d7f5d3SJohn Marino
986d7f5d3SJohn Marinolibinstaller is a library of support functions for the BSD Installer
1086d7f5d3SJohn Marinoapplication, dfuibe_installer.
1186d7f5d3SJohn Marino
1286d7f5d3SJohn MarinoWhat is the current state of the project?
1386d7f5d3SJohn Marino-----------------------------------------
1486d7f5d3SJohn Marino
1586d7f5d3SJohn MarinoEXPERIMENTAL.  libinstaller's application programming interface may change at
1686d7f5d3SJohn Marinoany time.  If you use libinstaller in a project, be prepared to chase API
1786d7f5d3SJohn Marinochanges.  Both the API and the ABI of libinstaller 5.0 are not backwards-
1886d7f5d3SJohn Marinocompatible with those of of previous versions.
1986d7f5d3SJohn Marino
2086d7f5d3SJohn MarinoHow do I build and install libinstaller?
2186d7f5d3SJohn Marino----------------------------------------
2286d7f5d3SJohn Marino
2386d7f5d3SJohn MarinoOn a BSD-based system, go into the libinstaller source directory and type:
2486d7f5d3SJohn Marino
2586d7f5d3SJohn Marino	make
2686d7f5d3SJohn Marino
2786d7f5d3SJohn MarinoOnce built, it can be installed by typing (as root):
2886d7f5d3SJohn Marino
2986d7f5d3SJohn Marino	make install
3086d7f5d3SJohn Marino
3186d7f5d3SJohn MarinoDirections may differ for other systems.
3286d7f5d3SJohn Marino
3386d7f5d3SJohn MarinoAn alternative method is to build libinstaller using the ports system and
3486d7f5d3SJohn Marinoinstall it using the package system.
3586d7f5d3SJohn Marino
3686d7f5d3SJohn MarinoHow do I use libinstaller from a program?
3786d7f5d3SJohn Marino-----------------------------------------
3886d7f5d3SJohn Marino
3986d7f5d3SJohn Marinolibinstaller requires libdfui, which in turn requires libaura, but none
4086d7f5d3SJohn Marinoof these are statically linked with it, so any consumers of libinstaller
4186d7f5d3SJohn Marinowill also need to link to libaura and libdfui.
4286d7f5d3SJohn Marino
4386d7f5d3SJohn MarinoYou can give gcc the following sort of command line flags to tell it to
4486d7f5d3SJohn Marinolink your program with libinstaller:
4586d7f5d3SJohn Marino
4686d7f5d3SJohn Marino	gcc foo.c -o foo -L/usr/local/lib -laura -ldfui -linstaller
4786d7f5d3SJohn Marino
4886d7f5d3SJohn MarinoSee the libinstaller source code for the list of available functions and
4986d7f5d3SJohn Marinowhat they do.
50