xref: /dflybsd-src/usr.sbin/installer/libaura/README (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marinolibaura v3.0 README
286d7f5d3SJohn Marino===================
386d7f5d3SJohn Marino
486d7f5d3SJohn Marino$Id: README,v 1.3 2005/03/21 03:26:56 cpressey Exp $
586d7f5d3SJohn Marino
686d7f5d3SJohn MarinoWhat is libaura?
786d7f5d3SJohn Marino----------------
886d7f5d3SJohn Marino
986d7f5d3SJohn Marinolibaura is a LIBrary of Assorted Useful Reusable Abstractions.  Notably,
1086d7f5d3SJohn Marinoit provides dictionary and extensible buffer data types, memory management
1186d7f5d3SJohn Marinofunctions (wrappers to malloc() and free()), and filesystem predicates
1286d7f5d3SJohn Marino(is_file(), is_dir(), etc.)
1386d7f5d3SJohn Marino
1486d7f5d3SJohn MarinoWhat is the current state of the project?
1586d7f5d3SJohn Marino-----------------------------------------
1686d7f5d3SJohn Marino
1786d7f5d3SJohn MarinoEXPERIMENTAL.  libaura's application programming interface may change at
1886d7f5d3SJohn Marinoany time.  libaura 3.0 is not intended to be backwards-compatible with
1986d7f5d3SJohn Marinoany previous versions.  If you use libaura in a project, be prepared to
2086d7f5d3SJohn Marinochase API changes.
2186d7f5d3SJohn Marino
2286d7f5d3SJohn MarinoHow do I build and install libaura?
2386d7f5d3SJohn Marino-----------------------------------
2486d7f5d3SJohn Marino
2586d7f5d3SJohn MarinoOn a BSD-based system, go into the libaura source directory and type:
2686d7f5d3SJohn Marino
2786d7f5d3SJohn Marino	make
2886d7f5d3SJohn Marino
2986d7f5d3SJohn MarinoOnce built, it can be installed by typing (as root):
3086d7f5d3SJohn Marino
3186d7f5d3SJohn Marino	make install
3286d7f5d3SJohn Marino
3386d7f5d3SJohn MarinoDirections may differ for other systems.
3486d7f5d3SJohn Marino
3586d7f5d3SJohn MarinoAn alternative method is to build libaura using the ports system and
3686d7f5d3SJohn Marinoinstall it using the package system.
3786d7f5d3SJohn Marino
3886d7f5d3SJohn MarinoHow do I use libaura from a program?
3986d7f5d3SJohn Marino------------------------------------
4086d7f5d3SJohn Marino
4186d7f5d3SJohn MarinoYou can give gcc the following sort of command line flags to tell it to
4286d7f5d3SJohn Marinolink your program with libaura:
4386d7f5d3SJohn Marino
4486d7f5d3SJohn Marino	gcc foo.c -o foo -L/usr/local/lib -laura
4586d7f5d3SJohn Marino
4686d7f5d3SJohn MarinoSee the libaura source code for the list of available functions and what
4786d7f5d3SJohn Marinothey do.
48