xref: /dragonfly/usr.sbin/installer/libaura/README (revision 0db87cb7)
1libaura v3.0 README
2===================
3
4$Id: README,v 1.3 2005/03/21 03:26:56 cpressey Exp $
5
6What is libaura?
7----------------
8
9libaura is a LIBrary of Assorted Useful Reusable Abstractions.  Notably,
10it provides dictionary and extensible buffer data types, memory management
11functions (wrappers to malloc() and free()), and filesystem predicates
12(is_file(), is_dir(), etc.)
13
14What is the current state of the project?
15-----------------------------------------
16
17EXPERIMENTAL.  libaura's application programming interface may change at
18any time.  libaura 3.0 is not intended to be backwards-compatible with
19any previous versions.  If you use libaura in a project, be prepared to
20chase API changes.
21
22How do I build and install libaura?
23-----------------------------------
24
25On a BSD-based system, go into the libaura source directory and type:
26
27	make
28
29Once built, it can be installed by typing (as root):
30
31	make install
32
33Directions may differ for other systems.
34
35An alternative method is to build libaura using the ports system and
36install it using the package system.
37
38How do I use libaura from a program?
39------------------------------------
40
41You can give gcc the following sort of command line flags to tell it to
42link your program with libaura:
43
44	gcc foo.c -o foo -L/usr/local/lib -laura
45
46See the libaura source code for the list of available functions and what
47they do.
48