Return to README.md CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / confuse

confuse 3.3

    1: libConfuse
    2: ==========
    3: [![Travis Status][]][Travis] [![Coverity Status][]][Coverity Scan]
    4: 
    5: * [Introduction](#introduction)
    6: * [Documentation](#documentation)
    7: * [Examples](#examples)
    8: * [Build & Install](#build--install)
    9: * [Origin & References](#origin--references)
   10: 
   11: 
   12: Introduction
   13: ------------
   14: 
   15: libConfuse is a configuration file parser library written in C.  It
   16: supports sections and (lists of) values, as well as other features such
   17: as single/double quoted strings, environment variable expansion,
   18: functions and nested include statements.  Values can be strings,
   19: integers, floats, booleans, and sections.
   20: 
   21: The goal is not to be _the_ configuration file parser library with a
   22: gazillion of features.  Instead, it aims to be easy to use and quick to
   23: integrate with your code.
   24: 
   25: > Please ensure you download a <ins>versioned archive</ins> from:
   26: > <https://github.com/martinh/libconfuse/releases/>
   27: 
   28: 
   29: Documentation
   30: -------------
   31: 
   32: * [API reference manual](http://www.nongnu.org/confuse/manual/)
   33: * [Tutorial](http://www.nongnu.org/confuse/tutorial-html/)
   34: 
   35: 
   36: Examples
   37: --------
   38: 
   39: * [simple.c](examples/simple.c) and [simple.conf](examples/simple.conf)
   40:   shows how to use the "simple" versions of options
   41: * [cfgtest.c](examples/cfgtest.c) and [test.conf](examples/test.conf)
   42:   show most of the features of confuse, including lists and functions
   43: 
   44: 
   45: Build & Install
   46: ---------------
   47: 
   48: libConfuse employs the GNU configure and build system.  To list available
   49: build options, start by unpacking the tarball:
   50: 
   51:     tar xf confuse-3.2.2.tar.xz
   52:     cd confuse-3.2.2/
   53:     ./configure --help
   54: 
   55: For most users the following commands configures, builds and installs the
   56: library to `/usr/local/`:
   57: 
   58:     ./configure && make -j9
   59:     sudo make install
   60:     sudo ldconfig
   61: 
   62: See the INSTALL file for the full installation instructions.
   63: 
   64: When checking out the code from GitHub, use <kbd>./autogen.sh</kbd> to
   65: generate a `configure` script.  This means you also need the following
   66: tools:
   67: 
   68: * autoconf
   69: * automake
   70: * libtool
   71: * gettext
   72: * autopoint
   73: * flex
   74: 
   75: To build the documentation you also need the following tools:
   76: 
   77: * doxygen
   78: * xmlto
   79: 
   80: This is an optional step, so you must build it explicitly from
   81: its directory:
   82: 
   83:     cd doc/
   84:     make documentation
   85: 
   86: 
   87: Origin & References
   88: -------------------
   89: 
   90: libConfuse was created by Martin Hedenfalk and released as open source
   91: software under the terms of the [ISC license][1].  It was previously
   92: called libcfg, but the name was changed to not confuse with other
   93: similar libraries.  It is currently developed and maintained at GitHub.
   94: Please use the [issue tracker][2] to report bugs and feature requests.
   95: 
   96: 
   97: [1]:                http://en.wikipedia.org/wiki/ISC_license
   98: [2]:                https://github.com/martinh/libconfuse/issues
   99: [Travis]:           https://travis-ci.org/troglobit/libconfuse
  100: [Travis Status]:    https://travis-ci.org/troglobit/libconfuse.png?branch=master
  101: [Coverity Scan]:    https://scan.coverity.com/projects/6674
  102: [Coverity Status]:  https://scan.coverity.com/projects/6674/badge.svg